lob.dotnet 0.0.1

lob.dotnet - the C# library for the Lob

The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our previous documentation?

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.3.0
• SDK version: 1.0.0
• Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen For more information, please visit https://support.lob.com/

<a name="frameworks-supported"></a>

Frameworks supported

<a name="dependencies"></a>

Dependencies

• RestSharp - 106.13.0 or later
• Json.NET - 12.0.3 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a name="installation"></a>

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using lob.dotnet.Api;
using lob.dotnet.Client;
using lob.dotnet.Model;

<a name="packaging"></a>

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out lob.dotnet.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

<a name="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a name="getting-started"></a>

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using lob.dotnet.Api;
using lob.dotnet.Client;
using lob.dotnet.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.lob.com/v1";
            // Configure HTTP basic authorization: basicAuth
            config.Username = "<<YOUR_LOB_API_KEY>>";

            var apiInstance = new AddressesApi(config);
            var addressEditable = new AddressEditable(); // AddressEditable | 

            try
            {
                // create
                Address result = apiInstance.create(addressEditable);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AddressesApi.create: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

<a name="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to https://api.lob.com/v1

<a name="documentation-for-models"></a>

Documentation for Models

• Model.Address
• Model.AddressDeletion
• Model.AddressDomesticExpanded
• Model.AddressEditable
• Model.AddressList
• Model.BankAccount
• Model.BankAccountDeletion
• Model.BankAccountList
• Model.verify
• Model.BankAccountWritable
• Model.BankTypeEnum
• Model.BillingGroup
• Model.BillingGroupEditable
• Model.BillingGroupList
• Model.BulkError
• Model.BulkErrorProperties
• Model.Card
• Model.CardDeletion
• Model.CardEditable
• Model.CardList
• Model.CardOrder
• Model.CardOrderEditable
• Model.CardOrderList
• Model.CardUpdatable
• Model.Check
• Model.CheckDeletion
• Model.CheckEditable
• Model.CheckList
• Model.CountryExtended
• Model.CountryExtendedExpanded
• Model.DeliverabilityAnalysis
• Model.DpvFootnote
• Model.EngineHtml
• Model.EventType
• Model.Events
• Model.GeocodeAddresses
• Model.GeocodeComponents
• Model.IntlAutocompletions
• Model.IntlAutocompletionsWritable
• Model.IntlComponents
• Model.IntlSuggestions
• Model.IntlVerification
• Model.IntlVerificationOrError
• Model.IntlVerificationWritable
• Model.IntlVerifications
• Model.IntlVerificationsPayload
• Model.Letter
• Model.LetterCustomEnvelope
• Model.LetterDeletion
• Model.LetterEditable
• Model.LetterList
• Model.LobConfidenceScore
• Model.LobError
• Model.Location
• Model.LocationAnalysis
• Model.MailType
• Model.MultipleComponents
• Model.MultipleComponentsIntl
• Model.MultipleComponentsList
• Model.Postcard
• Model.PostcardDeletion
• Model.PostcardEditable
• Model.PostcardList
• Model.PostcardSize
• Model.ReverseGeocode
• Model.SelfMailer
• Model.SelfMailerDeletion
• Model.SelfMailerEditable
• Model.SelfMailerList
• Model.SelfMailerSize
• Model.SortBy
• Model.SortBy1
• Model.SortBy2
• Model.SortBy3
• Model.SortBy4
• Model.SortBy5
• Model.Suggestions
• Model.Template
• Model.TemplateDeletion
• Model.TemplateList
• Model.update
• Model.TemplateVersion
• Model.TemplateVersionDeletion
• Model.TemplateVersionList
• Model.TemplateVersionUpdatable
• Model.TemplateVersionWritable
• Model.TemplateWritable
• Model.Thumbnail
• Model.TrackingEventCertified
• Model.TrackingEventDetails
• Model.TrackingEventNormal
• Model.UsAutocompletions
• Model.UsAutocompletionsWritable
• Model.UsComponents
• Model.UsVerification
• Model.UsVerificationOrError
• Model.UsVerifications
• Model.UsVerificationsWritable
• Model.Zip
• Model.ZipCodeType
• Model.ZipEditable
• Model.ZipLookupCity

<a name="documentation-for-authorization"></a>

Documentation for Authorization

<a name="basicAuth"></a>

basicAuth

• Type: HTTP basic authentication