From fed5375b4898b356a16a31d5d0194edcfc13f6f6 Mon Sep 17 00:00:00 2001 From: BennyKitchell Date: Thu, 2 Jun 2022 10:44:01 -0500 Subject: [PATCH] feat: Newly generated dotnet repo --- .github/PULL_REQUEST_TEMPLATE.md | 3 - .gitignore | 64 +- .openapi-generator-ignore | 23 + LICENSE | 21 - Lob.sln | 31 - Lob/Api/Address/AddressClient.cs | 87 -- Lob/Api/Address/AddressResource.cs | 24 - Lob/Api/Address/CreateAddressRequest.cs | 20 - Lob/Api/Common/DeletableResource.cs | 9 - Lob/Api/Common/LobCollection.cs | 11 - Lob/Common/Constants.cs | 16 - Lob/Common/Utils/HttpContentFactory.cs | 15 - Lob/Common/Utils/SerializerSettings.cs | 20 - Lob/Exceptions/LobException.cs | 25 - Lob/Lob.csproj | 17 - Lob/LobClient.cs | 24 - Lob/Protocol/LobRequestOptions.cs | 7 - Lob/Protocol/LobResponse.cs | 11 - Lob/Protocol/LobRestClient.cs | 84 - LobTest/AcceptanceTestBase.cs | 17 - .../Address/AddressClientAcceptanceTest.cs | 140 -- LobTest/Exceptions/LobExceptionTest.cs | 31 - LobTest/LobTest.csproj | 83 - LobTest/Properties/AssemblyInfo.cs | 36 - LobTest/packages.config | 15 - README.md | 292 ++++ appveyor.yml | 9 + docs/Address.md | 27 + docs/AddressDeletion.md | 13 + docs/AddressDomesticExpanded.md | 21 + docs/AddressEditable.md | 21 + docs/AddressList.md | 15 + docs/AddressesApi.md | 326 ++++ docs/BankAccount.md | 23 + docs/BankAccountDeletion.md | 13 + docs/BankAccountList.md | 15 + docs/BankAccountVerify.md | 10 + docs/BankAccountWritable.md | 15 + docs/BankAccountsApi.md | 405 +++++ docs/BankTypeEnum.md | 10 + docs/BillingGroup.md | 15 + docs/BillingGroupEditable.md | 11 + docs/BillingGroupList.md | 14 + docs/BillingGroupsApi.md | 328 ++++ docs/BulkError.md | 11 + docs/BulkErrorProperties.md | 12 + docs/Card.md | 28 + docs/CardDeletion.md | 13 + docs/CardEditable.md | 13 + docs/CardList.md | 15 + docs/CardOrder.md | 22 + docs/CardOrderEditable.md | 10 + docs/CardOrderList.md | 14 + docs/CardOrdersApi.md | 168 ++ docs/CardUpdatable.md | 12 + docs/CardsApi.md | 401 +++++ docs/Check.md | 35 + docs/CheckDeletion.md | 13 + docs/CheckEditable.md | 25 + docs/CheckList.md | 15 + docs/ChecksApi.md | 336 ++++ docs/CountryExtended.md | 10 + docs/CountryExtendedExpanded.md | 10 + docs/DeliverabilityAnalysis.md | 19 + docs/DpvFootnote.md | 9 + docs/EngineHtml.md | 10 + docs/EventType.md | 13 + docs/Events.md | 15 + docs/GeocodeAddresses.md | 11 + docs/GeocodeComponents.md | 12 + docs/IntlAutocompletions.md | 11 + docs/IntlAutocompletionsApi.md | 87 ++ docs/IntlAutocompletionsWritable.md | 14 + docs/IntlComponents.md | 15 + docs/IntlSuggestions.md | 16 + docs/IntlVerification.md | 20 + docs/IntlVerificationOrError.md | 22 + docs/IntlVerificationWritable.md | 17 + docs/IntlVerifications.md | 11 + docs/IntlVerificationsApi.md | 164 ++ docs/IntlVerificationsPayload.md | 10 + docs/Letter.md | 36 + docs/LetterCustomEnvelope.md | 13 + docs/LetterDeletion.md | 13 + docs/LetterEditable.md | 26 + docs/LetterList.md | 15 + docs/LettersApi.md | 338 ++++ docs/LobConfidenceScore.md | 12 + docs/LobError.md | 13 + docs/Location.md | 11 + docs/LocationAnalysis.md | 13 + docs/MailType.md | 10 + docs/MultipleComponents.md | 16 + docs/MultipleComponentsIntl.md | 16 + docs/MultipleComponentsList.md | 10 + docs/Postcard.md | 31 + docs/PostcardDeletion.md | 13 + docs/PostcardEditable.md | 20 + docs/PostcardList.md | 15 + docs/PostcardSize.md | 10 + docs/PostcardsApi.md | 338 ++++ docs/ReverseGeocode.md | 12 + docs/ReverseGeocodeLookupsApi.md | 87 ++ docs/SelfMailer.md | 25 + docs/SelfMailerDeletion.md | 13 + docs/SelfMailerEditable.md | 20 + docs/SelfMailerList.md | 15 + docs/SelfMailerSize.md | 10 + docs/SelfMailersApi.md | 338 ++++ docs/SortBy.md | 11 + docs/SortBy1.md | 11 + docs/SortBy2.md | 11 + docs/SortBy3.md | 11 + docs/SortBy4.md | 11 + docs/SortBy5.md | 11 + docs/Suggestions.md | 14 + docs/Template.md | 18 + docs/TemplateDeletion.md | 13 + docs/TemplateList.md | 15 + docs/TemplateUpdate.md | 11 + docs/TemplateVersion.md | 19 + docs/TemplateVersionDeletion.md | 13 + docs/TemplateVersionList.md | 15 + docs/TemplateVersionUpdatable.md | 11 + docs/TemplateVersionWritable.md | 12 + docs/TemplateVersionsApi.md | 413 +++++ docs/TemplateWritable.md | 13 + docs/TemplatesApi.md | 405 +++++ docs/Thumbnail.md | 12 + docs/TrackingEventCertified.md | 18 + docs/TrackingEventDetails.md | 13 + docs/TrackingEventNormal.md | 18 + docs/UsAutocompletions.md | 12 + docs/UsAutocompletionsApi.md | 85 + docs/UsAutocompletionsWritable.md | 14 + docs/UsComponents.md | 36 + docs/UsVerification.md | 20 + docs/UsVerificationOrError.md | 22 + docs/UsVerifications.md | 11 + docs/UsVerificationsApi.md | 166 ++ docs/UsVerificationsWritable.md | 17 + docs/Zip.md | 14 + docs/ZipCodeType.md | 10 + docs/ZipEditable.md | 10 + docs/ZipLookupCity.md | 14 + docs/ZipLookupsApi.md | 85 + git_push.sh | 57 + lob.dotnet.sln | 27 + src/lob.dotnet.Test/Api/AddressesApiTests.cs | 111 ++ .../Api/BankAccountsApiTests.cs | 124 ++ .../Api/BillingGroupsApiTests.cs | 112 ++ src/lob.dotnet.Test/Api/CardOrdersApiTests.cs | 85 + src/lob.dotnet.Test/Api/CardsApiTests.cs | 122 ++ src/lob.dotnet.Test/Api/ChecksApiTests.cs | 116 ++ .../Api/IntlAutocompletionsApiTests.cs | 71 + .../Api/IntlVerificationsApiTests.cs | 83 + src/lob.dotnet.Test/Api/LettersApiTests.cs | 117 ++ src/lob.dotnet.Test/Api/PostcardsApiTests.cs | 117 ++ .../Api/ReverseGeocodeLookupsApiTests.cs | 71 + .../Api/SelfMailersApiTests.cs | 117 ++ .../Api/TemplateVersionsApiTests.cs | 128 ++ src/lob.dotnet.Test/Api/TemplatesApiTests.cs | 124 ++ .../Api/UsAutocompletionsApiTests.cs | 70 + .../Api/UsVerificationsApiTests.cs | 84 + src/lob.dotnet.Test/Api/ZipLookupsApiTests.cs | 70 + .../Model/AddressDeletionTests.cs | 87 ++ .../Model/AddressDomesticExpandedTests.cs | 159 ++ .../Model/AddressEditableTests.cs | 159 ++ src/lob.dotnet.Test/Model/AddressListTests.cs | 111 ++ src/lob.dotnet.Test/Model/AddressTests.cs | 207 +++ .../Model/BankAccountDeletionTests.cs | 87 ++ .../Model/BankAccountListTests.cs | 111 ++ src/lob.dotnet.Test/Model/BankAccountTests.cs | 175 +++ .../Model/BankAccountVerifyTests.cs | 71 + .../Model/BankAccountWritableTests.cs | 111 ++ .../Model/BankTypeEnumTests.cs | 63 + .../Model/BillingGroupEditableTests.cs | 79 + .../Model/BillingGroupListTests.cs | 103 ++ .../Model/BillingGroupTests.cs | 111 ++ .../Model/BulkErrorPropertiesTests.cs | 79 + src/lob.dotnet.Test/Model/BulkErrorTests.cs | 71 + .../Model/CardDeletionTests.cs | 87 ++ .../Model/CardEditableTests.cs | 95 ++ src/lob.dotnet.Test/Model/CardListTests.cs | 111 ++ .../Model/CardOrderEditableTests.cs | 71 + .../Model/CardOrderListTests.cs | 103 ++ src/lob.dotnet.Test/Model/CardOrderTests.cs | 167 ++ src/lob.dotnet.Test/Model/CardTests.cs | 215 +++ .../Model/CardUpdatableTests.cs | 87 ++ .../Model/CheckDeletionTests.cs | 87 ++ .../Model/CheckEditableTests.cs | 191 +++ src/lob.dotnet.Test/Model/CheckListTests.cs | 111 ++ src/lob.dotnet.Test/Model/CheckTests.cs | 271 ++++ .../Model/CountryExtendedExpandedTests.cs | 63 + .../Model/CountryExtendedTests.cs | 63 + .../Model/DeliverabilityAnalysisTests.cs | 135 ++ src/lob.dotnet.Test/Model/DpvFootnoteTests.cs | 63 + src/lob.dotnet.Test/Model/EngineHtmlTests.cs | 63 + src/lob.dotnet.Test/Model/EventTypeTests.cs | 95 ++ src/lob.dotnet.Test/Model/EventsTests.cs | 111 ++ .../Model/GeocodeAddressesTests.cs | 79 + .../Model/GeocodeComponentsTests.cs | 79 + .../Model/IntlAutocompletionsTests.cs | 79 + .../Model/IntlAutocompletionsWritableTests.cs | 103 ++ .../Model/IntlComponentsTests.cs | 103 ++ .../Model/IntlSuggestionsTests.cs | 119 ++ .../Model/IntlVerificationOrErrorTests.cs | 159 ++ .../Model/IntlVerificationTests.cs | 151 ++ .../Model/IntlVerificationWritableTests.cs | 127 ++ .../Model/IntlVerificationsPayloadTests.cs | 71 + .../Model/IntlVerificationsTests.cs | 79 + .../Model/LetterCustomEnvelopeTests.cs | 87 ++ .../Model/LetterDeletionTests.cs | 87 ++ .../Model/LetterEditableTests.cs | 199 +++ src/lob.dotnet.Test/Model/LetterListTests.cs | 111 ++ src/lob.dotnet.Test/Model/LetterTests.cs | 279 ++++ .../Model/LobConfidenceScoreTests.cs | 79 + src/lob.dotnet.Test/Model/LobErrorTests.cs | 87 ++ .../Model/LocationAnalysisTests.cs | 87 ++ src/lob.dotnet.Test/Model/LocationTests.cs | 79 + src/lob.dotnet.Test/Model/MailTypeTests.cs | 63 + .../Model/MultipleComponentsIntlTests.cs | 119 ++ .../Model/MultipleComponentsListTests.cs | 71 + .../Model/MultipleComponentsTests.cs | 119 ++ .../Model/PostcardDeletionTests.cs | 87 ++ .../Model/PostcardEditableTests.cs | 151 ++ .../Model/PostcardListTests.cs | 111 ++ .../Model/PostcardSizeTests.cs | 63 + src/lob.dotnet.Test/Model/PostcardTests.cs | 239 +++ .../Model/ReverseGeocodeTests.cs | 87 ++ .../Model/SelfMailerDeletionTests.cs | 87 ++ .../Model/SelfMailerEditableTests.cs | 151 ++ .../Model/SelfMailerListTests.cs | 111 ++ .../Model/SelfMailerSizeTests.cs | 63 + src/lob.dotnet.Test/Model/SelfMailerTests.cs | 191 +++ src/lob.dotnet.Test/Model/SortBy1Tests.cs | 79 + src/lob.dotnet.Test/Model/SortBy2Tests.cs | 79 + src/lob.dotnet.Test/Model/SortBy3Tests.cs | 79 + src/lob.dotnet.Test/Model/SortBy4Tests.cs | 79 + src/lob.dotnet.Test/Model/SortBy5Tests.cs | 79 + src/lob.dotnet.Test/Model/SortByTests.cs | 79 + src/lob.dotnet.Test/Model/SuggestionsTests.cs | 103 ++ .../Model/TemplateDeletionTests.cs | 87 ++ .../Model/TemplateListTests.cs | 111 ++ src/lob.dotnet.Test/Model/TemplateTests.cs | 135 ++ .../Model/TemplateUpdateTests.cs | 79 + .../Model/TemplateVersionDeletionTests.cs | 87 ++ .../Model/TemplateVersionListTests.cs | 111 ++ .../Model/TemplateVersionTests.cs | 143 ++ .../Model/TemplateVersionUpdatableTests.cs | 79 + .../Model/TemplateVersionWritableTests.cs | 87 ++ .../Model/TemplateWritableTests.cs | 95 ++ src/lob.dotnet.Test/Model/ThumbnailTests.cs | 87 ++ .../Model/TrackingEventCertifiedTests.cs | 135 ++ .../Model/TrackingEventDetailsTests.cs | 95 ++ .../Model/TrackingEventNormalTests.cs | 135 ++ .../Model/UsAutocompletionsTests.cs | 87 ++ .../Model/UsAutocompletionsWritableTests.cs | 103 ++ .../Model/UsComponentsTests.cs | 271 ++++ .../Model/UsVerificationOrErrorTests.cs | 159 ++ .../Model/UsVerificationTests.cs | 151 ++ .../Model/UsVerificationsTests.cs | 79 + .../Model/UsVerificationsWritableTests.cs | 127 ++ src/lob.dotnet.Test/Model/ZipCodeTypeTests.cs | 63 + src/lob.dotnet.Test/Model/ZipEditableTests.cs | 71 + .../Model/ZipLookupCityTests.cs | 103 ++ src/lob.dotnet.Test/Model/ZipTests.cs | 103 ++ src/lob.dotnet.Test/lob.dotnet.Test.csproj | 20 + src/lob.dotnet/Api/AddressesApi.cs | 1052 +++++++++++++ src/lob.dotnet/Api/BankAccountsApi.cs | 1288 +++++++++++++++ src/lob.dotnet/Api/BillingGroupsApi.cs | 1084 +++++++++++++ src/lob.dotnet/Api/CardOrdersApi.cs | 628 ++++++++ src/lob.dotnet/Api/CardsApi.cs | 1256 +++++++++++++++ src/lob.dotnet/Api/ChecksApi.cs | 1136 ++++++++++++++ src/lob.dotnet/Api/IntlAutocompletionsApi.cs | 386 +++++ src/lob.dotnet/Api/IntlVerificationsApi.cs | 594 +++++++ src/lob.dotnet/Api/LettersApi.cs | 1152 ++++++++++++++ src/lob.dotnet/Api/PostcardsApi.cs | 1152 ++++++++++++++ .../Api/ReverseGeocodeLookupsApi.cs | 386 +++++ src/lob.dotnet/Api/SelfMailersApi.cs | 1152 ++++++++++++++ src/lob.dotnet/Api/TemplateVersionsApi.cs | 1382 +++++++++++++++++ src/lob.dotnet/Api/TemplatesApi.cs | 1288 +++++++++++++++ src/lob.dotnet/Api/UsAutocompletionsApi.cs | 370 +++++ src/lob.dotnet/Api/UsVerificationsApi.cs | 612 ++++++++ src/lob.dotnet/Api/ZipLookupsApi.cs | 370 +++++ src/lob.dotnet/Client/ApiClient.cs | 882 +++++++++++ src/lob.dotnet/Client/ApiException.cs | 69 + src/lob.dotnet/Client/ApiResponse.cs | 167 ++ src/lob.dotnet/Client/ClientUtils.cs | 195 +++ src/lob.dotnet/Client/Configuration.cs | 592 +++++++ src/lob.dotnet/Client/ExceptionFactory.cs | 23 + src/lob.dotnet/Client/GlobalConfiguration.cs | 68 + src/lob.dotnet/Client/HttpMethod.cs | 34 + src/lob.dotnet/Client/IApiAccessor.cs | 38 + src/lob.dotnet/Client/IAsynchronousClient.cs | 101 ++ .../Client/IReadableConfiguration.cs | 130 ++ src/lob.dotnet/Client/ISynchronousClient.cs | 94 ++ src/lob.dotnet/Client/Multimap.cs | 296 ++++ src/lob.dotnet/Client/OpenAPIDateConverter.cs | 30 + src/lob.dotnet/Client/RequestOptions.cs | 85 + src/lob.dotnet/Client/RetryConfiguration.cs | 32 + src/lob.dotnet/Model/AbstractOpenAPISchema.cs | 77 + src/lob.dotnet/Model/Address.cs | 524 +++++++ src/lob.dotnet/Model/AddressDeletion.cs | 182 +++ .../Model/AddressDomesticExpanded.cs | 405 +++++ src/lob.dotnet/Model/AddressEditable.cs | 397 +++++ src/lob.dotnet/Model/AddressList.cs | 218 +++ src/lob.dotnet/Model/BankAccount.cs | 439 ++++++ src/lob.dotnet/Model/BankAccountDeletion.cs | 182 +++ src/lob.dotnet/Model/BankAccountList.cs | 218 +++ src/lob.dotnet/Model/BankAccountVerify.cs | 131 ++ src/lob.dotnet/Model/BankAccountWritable.cs | 254 +++ src/lob.dotnet/Model/BankTypeEnum.cs | 50 + src/lob.dotnet/Model/BillingGroup.cs | 255 +++ src/lob.dotnet/Model/BillingGroupEditable.cs | 161 ++ src/lob.dotnet/Model/BillingGroupList.cs | 203 +++ src/lob.dotnet/Model/BulkError.cs | 129 ++ src/lob.dotnet/Model/BulkErrorProperties.cs | 188 +++ src/lob.dotnet/Model/Card.cs | 573 +++++++ src/lob.dotnet/Model/CardDeletion.cs | 182 +++ src/lob.dotnet/Model/CardEditable.cs | 211 +++ src/lob.dotnet/Model/CardList.cs | 218 +++ src/lob.dotnet/Model/CardOrder.cs | 391 +++++ src/lob.dotnet/Model/CardOrderEditable.cs | 137 ++ src/lob.dotnet/Model/CardOrderList.cs | 203 +++ src/lob.dotnet/Model/CardUpdatable.cs | 178 +++ src/lob.dotnet/Model/Check.cs | 700 +++++++++ src/lob.dotnet/Model/CheckDeletion.cs | 182 +++ src/lob.dotnet/Model/CheckEditable.cs | 454 ++++++ src/lob.dotnet/Model/CheckList.cs | 218 +++ src/lob.dotnet/Model/CountryExtended.cs | 1346 ++++++++++++++++ .../Model/CountryExtendedExpanded.cs | 1352 ++++++++++++++++ .../Model/DeliverabilityAnalysis.cs | 429 +++++ src/lob.dotnet/Model/DpvFootnote.cs | 127 ++ src/lob.dotnet/Model/EngineHtml.cs | 50 + src/lob.dotnet/Model/EventType.cs | 232 +++ src/lob.dotnet/Model/Events.cs | 242 +++ src/lob.dotnet/Model/GeocodeAddresses.cs | 147 ++ src/lob.dotnet/Model/GeocodeComponents.cs | 162 ++ src/lob.dotnet/Model/IntlAutocompletions.cs | 157 ++ .../Model/IntlAutocompletionsWritable.cs | 205 +++ src/lob.dotnet/Model/IntlComponents.cs | 223 +++ src/lob.dotnet/Model/IntlSuggestions.cs | 259 +++ src/lob.dotnet/Model/IntlVerification.cs | 496 ++++++ .../Model/IntlVerificationOrError.cs | 503 ++++++ .../Model/IntlVerificationWritable.cs | 297 ++++ src/lob.dotnet/Model/IntlVerifications.cs | 145 ++ .../Model/IntlVerificationsPayload.cs | 130 ++ src/lob.dotnet/Model/Letter.cs | 685 ++++++++ src/lob.dotnet/Model/LetterCustomEnvelope.cs | 183 +++ src/lob.dotnet/Model/LetterDeletion.cs | 182 +++ src/lob.dotnet/Model/LetterEditable.cs | 490 ++++++ src/lob.dotnet/Model/LetterList.cs | 218 +++ src/lob.dotnet/Model/LobConfidenceScore.cs | 190 +++ src/lob.dotnet/Model/LobError.cs | 494 ++++++ src/lob.dotnet/Model/Location.cs | 188 +++ src/lob.dotnet/Model/LocationAnalysis.cs | 188 +++ src/lob.dotnet/Model/MailType.cs | 50 + src/lob.dotnet/Model/MultipleComponents.cs | 286 ++++ .../Model/MultipleComponentsIntl.cs | 272 ++++ .../Model/MultipleComponentsList.cs | 130 ++ src/lob.dotnet/Model/Postcard.cs | 590 +++++++ src/lob.dotnet/Model/PostcardDeletion.cs | 182 +++ src/lob.dotnet/Model/PostcardEditable.cs | 325 ++++ src/lob.dotnet/Model/PostcardList.cs | 218 +++ src/lob.dotnet/Model/PostcardSize.cs | 56 + src/lob.dotnet/Model/ReverseGeocode.cs | 187 +++ src/lob.dotnet/Model/SelfMailer.cs | 474 ++++++ src/lob.dotnet/Model/SelfMailerDeletion.cs | 182 +++ src/lob.dotnet/Model/SelfMailerEditable.cs | 325 ++++ src/lob.dotnet/Model/SelfMailerList.cs | 218 +++ src/lob.dotnet/Model/SelfMailerSize.cs | 56 + src/lob.dotnet/Model/SortBy.cs | 179 +++ src/lob.dotnet/Model/SortBy1.cs | 179 +++ src/lob.dotnet/Model/SortBy2.cs | 179 +++ src/lob.dotnet/Model/SortBy3.cs | 179 +++ src/lob.dotnet/Model/SortBy4.cs | 179 +++ src/lob.dotnet/Model/SortBy5.cs | 179 +++ src/lob.dotnet/Model/Suggestions.cs | 222 +++ src/lob.dotnet/Model/Template.cs | 303 ++++ src/lob.dotnet/Model/TemplateDeletion.cs | 182 +++ src/lob.dotnet/Model/TemplateList.cs | 218 +++ src/lob.dotnet/Model/TemplateUpdate.cs | 162 ++ src/lob.dotnet/Model/TemplateVersion.cs | 322 ++++ .../Model/TemplateVersionDeletion.cs | 182 +++ src/lob.dotnet/Model/TemplateVersionList.cs | 218 +++ .../Model/TemplateVersionUpdatable.cs | 154 ++ .../Model/TemplateVersionWritable.cs | 179 +++ src/lob.dotnet/Model/TemplateWritable.cs | 199 +++ src/lob.dotnet/Model/Thumbnail.cs | 189 +++ .../Model/TrackingEventCertified.cs | 367 +++++ src/lob.dotnet/Model/TrackingEventDetails.cs | 350 +++++ src/lob.dotnet/Model/TrackingEventNormal.cs | 360 +++++ src/lob.dotnet/Model/UsAutocompletions.cs | 187 +++ .../Model/UsAutocompletionsWritable.cs | 202 +++ src/lob.dotnet/Model/UsComponents.cs | 854 ++++++++++ src/lob.dotnet/Model/UsVerification.cs | 392 +++++ src/lob.dotnet/Model/UsVerificationOrError.cs | 407 +++++ src/lob.dotnet/Model/UsVerifications.cs | 145 ++ .../Model/UsVerificationsWritable.cs | 311 ++++ src/lob.dotnet/Model/Zip.cs | 229 +++ src/lob.dotnet/Model/ZipCodeType.cs | 68 + src/lob.dotnet/Model/ZipEditable.cs | 137 ++ src/lob.dotnet/Model/ZipLookupCity.cs | 220 +++ src/lob.dotnet/lob.dotnet.csproj | 30 + 405 files changed, 66031 insertions(+), 763 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .openapi-generator-ignore delete mode 100644 LICENSE delete mode 100644 Lob.sln delete mode 100644 Lob/Api/Address/AddressClient.cs delete mode 100644 Lob/Api/Address/AddressResource.cs delete mode 100644 Lob/Api/Address/CreateAddressRequest.cs delete mode 100644 Lob/Api/Common/DeletableResource.cs delete mode 100644 Lob/Api/Common/LobCollection.cs delete mode 100644 Lob/Common/Constants.cs delete mode 100644 Lob/Common/Utils/HttpContentFactory.cs delete mode 100644 Lob/Common/Utils/SerializerSettings.cs delete mode 100644 Lob/Exceptions/LobException.cs delete mode 100644 Lob/Lob.csproj delete mode 100644 Lob/LobClient.cs delete mode 100644 Lob/Protocol/LobRequestOptions.cs delete mode 100644 Lob/Protocol/LobResponse.cs delete mode 100644 Lob/Protocol/LobRestClient.cs delete mode 100644 LobTest/AcceptanceTestBase.cs delete mode 100644 LobTest/Api/Address/AddressClientAcceptanceTest.cs delete mode 100644 LobTest/Exceptions/LobExceptionTest.cs delete mode 100644 LobTest/LobTest.csproj delete mode 100644 LobTest/Properties/AssemblyInfo.cs delete mode 100644 LobTest/packages.config create mode 100644 README.md create mode 100644 appveyor.yml create mode 100644 docs/Address.md create mode 100644 docs/AddressDeletion.md create mode 100644 docs/AddressDomesticExpanded.md create mode 100644 docs/AddressEditable.md create mode 100644 docs/AddressList.md create mode 100644 docs/AddressesApi.md create mode 100644 docs/BankAccount.md create mode 100644 docs/BankAccountDeletion.md create mode 100644 docs/BankAccountList.md create mode 100644 docs/BankAccountVerify.md create mode 100644 docs/BankAccountWritable.md create mode 100644 docs/BankAccountsApi.md create mode 100644 docs/BankTypeEnum.md create mode 100644 docs/BillingGroup.md create mode 100644 docs/BillingGroupEditable.md create mode 100644 docs/BillingGroupList.md create mode 100644 docs/BillingGroupsApi.md create mode 100644 docs/BulkError.md create mode 100644 docs/BulkErrorProperties.md create mode 100644 docs/Card.md create mode 100644 docs/CardDeletion.md create mode 100644 docs/CardEditable.md create mode 100644 docs/CardList.md create mode 100644 docs/CardOrder.md create mode 100644 docs/CardOrderEditable.md create mode 100644 docs/CardOrderList.md create mode 100644 docs/CardOrdersApi.md create mode 100644 docs/CardUpdatable.md create mode 100644 docs/CardsApi.md create mode 100644 docs/Check.md create mode 100644 docs/CheckDeletion.md create mode 100644 docs/CheckEditable.md create mode 100644 docs/CheckList.md create mode 100644 docs/ChecksApi.md create mode 100644 docs/CountryExtended.md create mode 100644 docs/CountryExtendedExpanded.md create mode 100644 docs/DeliverabilityAnalysis.md create mode 100644 docs/DpvFootnote.md create mode 100644 docs/EngineHtml.md create mode 100644 docs/EventType.md create mode 100644 docs/Events.md create mode 100644 docs/GeocodeAddresses.md create mode 100644 docs/GeocodeComponents.md create mode 100644 docs/IntlAutocompletions.md create mode 100644 docs/IntlAutocompletionsApi.md create mode 100644 docs/IntlAutocompletionsWritable.md create mode 100644 docs/IntlComponents.md create mode 100644 docs/IntlSuggestions.md create mode 100644 docs/IntlVerification.md create mode 100644 docs/IntlVerificationOrError.md create mode 100644 docs/IntlVerificationWritable.md create mode 100644 docs/IntlVerifications.md create mode 100644 docs/IntlVerificationsApi.md create mode 100644 docs/IntlVerificationsPayload.md create mode 100644 docs/Letter.md create mode 100644 docs/LetterCustomEnvelope.md create mode 100644 docs/LetterDeletion.md create mode 100644 docs/LetterEditable.md create mode 100644 docs/LetterList.md create mode 100644 docs/LettersApi.md create mode 100644 docs/LobConfidenceScore.md create mode 100644 docs/LobError.md create mode 100644 docs/Location.md create mode 100644 docs/LocationAnalysis.md create mode 100644 docs/MailType.md create mode 100644 docs/MultipleComponents.md create mode 100644 docs/MultipleComponentsIntl.md create mode 100644 docs/MultipleComponentsList.md create mode 100644 docs/Postcard.md create mode 100644 docs/PostcardDeletion.md create mode 100644 docs/PostcardEditable.md create mode 100644 docs/PostcardList.md create mode 100644 docs/PostcardSize.md create mode 100644 docs/PostcardsApi.md create mode 100644 docs/ReverseGeocode.md create mode 100644 docs/ReverseGeocodeLookupsApi.md create mode 100644 docs/SelfMailer.md create mode 100644 docs/SelfMailerDeletion.md create mode 100644 docs/SelfMailerEditable.md create mode 100644 docs/SelfMailerList.md create mode 100644 docs/SelfMailerSize.md create mode 100644 docs/SelfMailersApi.md create mode 100644 docs/SortBy.md create mode 100644 docs/SortBy1.md create mode 100644 docs/SortBy2.md create mode 100644 docs/SortBy3.md create mode 100644 docs/SortBy4.md create mode 100644 docs/SortBy5.md create mode 100644 docs/Suggestions.md create mode 100644 docs/Template.md create mode 100644 docs/TemplateDeletion.md create mode 100644 docs/TemplateList.md create mode 100644 docs/TemplateUpdate.md create mode 100644 docs/TemplateVersion.md create mode 100644 docs/TemplateVersionDeletion.md create mode 100644 docs/TemplateVersionList.md create mode 100644 docs/TemplateVersionUpdatable.md create mode 100644 docs/TemplateVersionWritable.md create mode 100644 docs/TemplateVersionsApi.md create mode 100644 docs/TemplateWritable.md create mode 100644 docs/TemplatesApi.md create mode 100644 docs/Thumbnail.md create mode 100644 docs/TrackingEventCertified.md create mode 100644 docs/TrackingEventDetails.md create mode 100644 docs/TrackingEventNormal.md create mode 100644 docs/UsAutocompletions.md create mode 100644 docs/UsAutocompletionsApi.md create mode 100644 docs/UsAutocompletionsWritable.md create mode 100644 docs/UsComponents.md create mode 100644 docs/UsVerification.md create mode 100644 docs/UsVerificationOrError.md create mode 100644 docs/UsVerifications.md create mode 100644 docs/UsVerificationsApi.md create mode 100644 docs/UsVerificationsWritable.md create mode 100644 docs/Zip.md create mode 100644 docs/ZipCodeType.md create mode 100644 docs/ZipEditable.md create mode 100644 docs/ZipLookupCity.md create mode 100644 docs/ZipLookupsApi.md create mode 100644 git_push.sh create mode 100644 lob.dotnet.sln create mode 100644 src/lob.dotnet.Test/Api/AddressesApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/BankAccountsApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/BillingGroupsApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/CardOrdersApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/CardsApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/ChecksApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/IntlAutocompletionsApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/IntlVerificationsApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/LettersApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/PostcardsApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/ReverseGeocodeLookupsApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/SelfMailersApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/TemplateVersionsApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/TemplatesApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/UsAutocompletionsApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/UsVerificationsApiTests.cs create mode 100644 src/lob.dotnet.Test/Api/ZipLookupsApiTests.cs create mode 100644 src/lob.dotnet.Test/Model/AddressDeletionTests.cs create mode 100644 src/lob.dotnet.Test/Model/AddressDomesticExpandedTests.cs create mode 100644 src/lob.dotnet.Test/Model/AddressEditableTests.cs create mode 100644 src/lob.dotnet.Test/Model/AddressListTests.cs create mode 100644 src/lob.dotnet.Test/Model/AddressTests.cs create mode 100644 src/lob.dotnet.Test/Model/BankAccountDeletionTests.cs create mode 100644 src/lob.dotnet.Test/Model/BankAccountListTests.cs create mode 100644 src/lob.dotnet.Test/Model/BankAccountTests.cs create mode 100644 src/lob.dotnet.Test/Model/BankAccountVerifyTests.cs create mode 100644 src/lob.dotnet.Test/Model/BankAccountWritableTests.cs create mode 100644 src/lob.dotnet.Test/Model/BankTypeEnumTests.cs create mode 100644 src/lob.dotnet.Test/Model/BillingGroupEditableTests.cs create mode 100644 src/lob.dotnet.Test/Model/BillingGroupListTests.cs create mode 100644 src/lob.dotnet.Test/Model/BillingGroupTests.cs create mode 100644 src/lob.dotnet.Test/Model/BulkErrorPropertiesTests.cs create mode 100644 src/lob.dotnet.Test/Model/BulkErrorTests.cs create mode 100644 src/lob.dotnet.Test/Model/CardDeletionTests.cs create mode 100644 src/lob.dotnet.Test/Model/CardEditableTests.cs create mode 100644 src/lob.dotnet.Test/Model/CardListTests.cs create mode 100644 src/lob.dotnet.Test/Model/CardOrderEditableTests.cs create mode 100644 src/lob.dotnet.Test/Model/CardOrderListTests.cs create mode 100644 src/lob.dotnet.Test/Model/CardOrderTests.cs create mode 100644 src/lob.dotnet.Test/Model/CardTests.cs create mode 100644 src/lob.dotnet.Test/Model/CardUpdatableTests.cs create mode 100644 src/lob.dotnet.Test/Model/CheckDeletionTests.cs create mode 100644 src/lob.dotnet.Test/Model/CheckEditableTests.cs create mode 100644 src/lob.dotnet.Test/Model/CheckListTests.cs create mode 100644 src/lob.dotnet.Test/Model/CheckTests.cs create mode 100644 src/lob.dotnet.Test/Model/CountryExtendedExpandedTests.cs create mode 100644 src/lob.dotnet.Test/Model/CountryExtendedTests.cs create mode 100644 src/lob.dotnet.Test/Model/DeliverabilityAnalysisTests.cs create mode 100644 src/lob.dotnet.Test/Model/DpvFootnoteTests.cs create mode 100644 src/lob.dotnet.Test/Model/EngineHtmlTests.cs create mode 100644 src/lob.dotnet.Test/Model/EventTypeTests.cs create mode 100644 src/lob.dotnet.Test/Model/EventsTests.cs create mode 100644 src/lob.dotnet.Test/Model/GeocodeAddressesTests.cs create mode 100644 src/lob.dotnet.Test/Model/GeocodeComponentsTests.cs create mode 100644 src/lob.dotnet.Test/Model/IntlAutocompletionsTests.cs create mode 100644 src/lob.dotnet.Test/Model/IntlAutocompletionsWritableTests.cs create mode 100644 src/lob.dotnet.Test/Model/IntlComponentsTests.cs create mode 100644 src/lob.dotnet.Test/Model/IntlSuggestionsTests.cs create mode 100644 src/lob.dotnet.Test/Model/IntlVerificationOrErrorTests.cs create mode 100644 src/lob.dotnet.Test/Model/IntlVerificationTests.cs create mode 100644 src/lob.dotnet.Test/Model/IntlVerificationWritableTests.cs create mode 100644 src/lob.dotnet.Test/Model/IntlVerificationsPayloadTests.cs create mode 100644 src/lob.dotnet.Test/Model/IntlVerificationsTests.cs create mode 100644 src/lob.dotnet.Test/Model/LetterCustomEnvelopeTests.cs create mode 100644 src/lob.dotnet.Test/Model/LetterDeletionTests.cs create mode 100644 src/lob.dotnet.Test/Model/LetterEditableTests.cs create mode 100644 src/lob.dotnet.Test/Model/LetterListTests.cs create mode 100644 src/lob.dotnet.Test/Model/LetterTests.cs create mode 100644 src/lob.dotnet.Test/Model/LobConfidenceScoreTests.cs create mode 100644 src/lob.dotnet.Test/Model/LobErrorTests.cs create mode 100644 src/lob.dotnet.Test/Model/LocationAnalysisTests.cs create mode 100644 src/lob.dotnet.Test/Model/LocationTests.cs create mode 100644 src/lob.dotnet.Test/Model/MailTypeTests.cs create mode 100644 src/lob.dotnet.Test/Model/MultipleComponentsIntlTests.cs create mode 100644 src/lob.dotnet.Test/Model/MultipleComponentsListTests.cs create mode 100644 src/lob.dotnet.Test/Model/MultipleComponentsTests.cs create mode 100644 src/lob.dotnet.Test/Model/PostcardDeletionTests.cs create mode 100644 src/lob.dotnet.Test/Model/PostcardEditableTests.cs create mode 100644 src/lob.dotnet.Test/Model/PostcardListTests.cs create mode 100644 src/lob.dotnet.Test/Model/PostcardSizeTests.cs create mode 100644 src/lob.dotnet.Test/Model/PostcardTests.cs create mode 100644 src/lob.dotnet.Test/Model/ReverseGeocodeTests.cs create mode 100644 src/lob.dotnet.Test/Model/SelfMailerDeletionTests.cs create mode 100644 src/lob.dotnet.Test/Model/SelfMailerEditableTests.cs create mode 100644 src/lob.dotnet.Test/Model/SelfMailerListTests.cs create mode 100644 src/lob.dotnet.Test/Model/SelfMailerSizeTests.cs create mode 100644 src/lob.dotnet.Test/Model/SelfMailerTests.cs create mode 100644 src/lob.dotnet.Test/Model/SortBy1Tests.cs create mode 100644 src/lob.dotnet.Test/Model/SortBy2Tests.cs create mode 100644 src/lob.dotnet.Test/Model/SortBy3Tests.cs create mode 100644 src/lob.dotnet.Test/Model/SortBy4Tests.cs create mode 100644 src/lob.dotnet.Test/Model/SortBy5Tests.cs create mode 100644 src/lob.dotnet.Test/Model/SortByTests.cs create mode 100644 src/lob.dotnet.Test/Model/SuggestionsTests.cs create mode 100644 src/lob.dotnet.Test/Model/TemplateDeletionTests.cs create mode 100644 src/lob.dotnet.Test/Model/TemplateListTests.cs create mode 100644 src/lob.dotnet.Test/Model/TemplateTests.cs create mode 100644 src/lob.dotnet.Test/Model/TemplateUpdateTests.cs create mode 100644 src/lob.dotnet.Test/Model/TemplateVersionDeletionTests.cs create mode 100644 src/lob.dotnet.Test/Model/TemplateVersionListTests.cs create mode 100644 src/lob.dotnet.Test/Model/TemplateVersionTests.cs create mode 100644 src/lob.dotnet.Test/Model/TemplateVersionUpdatableTests.cs create mode 100644 src/lob.dotnet.Test/Model/TemplateVersionWritableTests.cs create mode 100644 src/lob.dotnet.Test/Model/TemplateWritableTests.cs create mode 100644 src/lob.dotnet.Test/Model/ThumbnailTests.cs create mode 100644 src/lob.dotnet.Test/Model/TrackingEventCertifiedTests.cs create mode 100644 src/lob.dotnet.Test/Model/TrackingEventDetailsTests.cs create mode 100644 src/lob.dotnet.Test/Model/TrackingEventNormalTests.cs create mode 100644 src/lob.dotnet.Test/Model/UsAutocompletionsTests.cs create mode 100644 src/lob.dotnet.Test/Model/UsAutocompletionsWritableTests.cs create mode 100644 src/lob.dotnet.Test/Model/UsComponentsTests.cs create mode 100644 src/lob.dotnet.Test/Model/UsVerificationOrErrorTests.cs create mode 100644 src/lob.dotnet.Test/Model/UsVerificationTests.cs create mode 100644 src/lob.dotnet.Test/Model/UsVerificationsTests.cs create mode 100644 src/lob.dotnet.Test/Model/UsVerificationsWritableTests.cs create mode 100644 src/lob.dotnet.Test/Model/ZipCodeTypeTests.cs create mode 100644 src/lob.dotnet.Test/Model/ZipEditableTests.cs create mode 100644 src/lob.dotnet.Test/Model/ZipLookupCityTests.cs create mode 100644 src/lob.dotnet.Test/Model/ZipTests.cs create mode 100644 src/lob.dotnet.Test/lob.dotnet.Test.csproj create mode 100644 src/lob.dotnet/Api/AddressesApi.cs create mode 100644 src/lob.dotnet/Api/BankAccountsApi.cs create mode 100644 src/lob.dotnet/Api/BillingGroupsApi.cs create mode 100644 src/lob.dotnet/Api/CardOrdersApi.cs create mode 100644 src/lob.dotnet/Api/CardsApi.cs create mode 100644 src/lob.dotnet/Api/ChecksApi.cs create mode 100644 src/lob.dotnet/Api/IntlAutocompletionsApi.cs create mode 100644 src/lob.dotnet/Api/IntlVerificationsApi.cs create mode 100644 src/lob.dotnet/Api/LettersApi.cs create mode 100644 src/lob.dotnet/Api/PostcardsApi.cs create mode 100644 src/lob.dotnet/Api/ReverseGeocodeLookupsApi.cs create mode 100644 src/lob.dotnet/Api/SelfMailersApi.cs create mode 100644 src/lob.dotnet/Api/TemplateVersionsApi.cs create mode 100644 src/lob.dotnet/Api/TemplatesApi.cs create mode 100644 src/lob.dotnet/Api/UsAutocompletionsApi.cs create mode 100644 src/lob.dotnet/Api/UsVerificationsApi.cs create mode 100644 src/lob.dotnet/Api/ZipLookupsApi.cs create mode 100644 src/lob.dotnet/Client/ApiClient.cs create mode 100644 src/lob.dotnet/Client/ApiException.cs create mode 100644 src/lob.dotnet/Client/ApiResponse.cs create mode 100644 src/lob.dotnet/Client/ClientUtils.cs create mode 100644 src/lob.dotnet/Client/Configuration.cs create mode 100644 src/lob.dotnet/Client/ExceptionFactory.cs create mode 100644 src/lob.dotnet/Client/GlobalConfiguration.cs create mode 100644 src/lob.dotnet/Client/HttpMethod.cs create mode 100644 src/lob.dotnet/Client/IApiAccessor.cs create mode 100644 src/lob.dotnet/Client/IAsynchronousClient.cs create mode 100644 src/lob.dotnet/Client/IReadableConfiguration.cs create mode 100644 src/lob.dotnet/Client/ISynchronousClient.cs create mode 100644 src/lob.dotnet/Client/Multimap.cs create mode 100644 src/lob.dotnet/Client/OpenAPIDateConverter.cs create mode 100644 src/lob.dotnet/Client/RequestOptions.cs create mode 100644 src/lob.dotnet/Client/RetryConfiguration.cs create mode 100644 src/lob.dotnet/Model/AbstractOpenAPISchema.cs create mode 100644 src/lob.dotnet/Model/Address.cs create mode 100644 src/lob.dotnet/Model/AddressDeletion.cs create mode 100644 src/lob.dotnet/Model/AddressDomesticExpanded.cs create mode 100644 src/lob.dotnet/Model/AddressEditable.cs create mode 100644 src/lob.dotnet/Model/AddressList.cs create mode 100644 src/lob.dotnet/Model/BankAccount.cs create mode 100644 src/lob.dotnet/Model/BankAccountDeletion.cs create mode 100644 src/lob.dotnet/Model/BankAccountList.cs create mode 100644 src/lob.dotnet/Model/BankAccountVerify.cs create mode 100644 src/lob.dotnet/Model/BankAccountWritable.cs create mode 100644 src/lob.dotnet/Model/BankTypeEnum.cs create mode 100644 src/lob.dotnet/Model/BillingGroup.cs create mode 100644 src/lob.dotnet/Model/BillingGroupEditable.cs create mode 100644 src/lob.dotnet/Model/BillingGroupList.cs create mode 100644 src/lob.dotnet/Model/BulkError.cs create mode 100644 src/lob.dotnet/Model/BulkErrorProperties.cs create mode 100644 src/lob.dotnet/Model/Card.cs create mode 100644 src/lob.dotnet/Model/CardDeletion.cs create mode 100644 src/lob.dotnet/Model/CardEditable.cs create mode 100644 src/lob.dotnet/Model/CardList.cs create mode 100644 src/lob.dotnet/Model/CardOrder.cs create mode 100644 src/lob.dotnet/Model/CardOrderEditable.cs create mode 100644 src/lob.dotnet/Model/CardOrderList.cs create mode 100644 src/lob.dotnet/Model/CardUpdatable.cs create mode 100644 src/lob.dotnet/Model/Check.cs create mode 100644 src/lob.dotnet/Model/CheckDeletion.cs create mode 100644 src/lob.dotnet/Model/CheckEditable.cs create mode 100644 src/lob.dotnet/Model/CheckList.cs create mode 100644 src/lob.dotnet/Model/CountryExtended.cs create mode 100644 src/lob.dotnet/Model/CountryExtendedExpanded.cs create mode 100644 src/lob.dotnet/Model/DeliverabilityAnalysis.cs create mode 100644 src/lob.dotnet/Model/DpvFootnote.cs create mode 100644 src/lob.dotnet/Model/EngineHtml.cs create mode 100644 src/lob.dotnet/Model/EventType.cs create mode 100644 src/lob.dotnet/Model/Events.cs create mode 100644 src/lob.dotnet/Model/GeocodeAddresses.cs create mode 100644 src/lob.dotnet/Model/GeocodeComponents.cs create mode 100644 src/lob.dotnet/Model/IntlAutocompletions.cs create mode 100644 src/lob.dotnet/Model/IntlAutocompletionsWritable.cs create mode 100644 src/lob.dotnet/Model/IntlComponents.cs create mode 100644 src/lob.dotnet/Model/IntlSuggestions.cs create mode 100644 src/lob.dotnet/Model/IntlVerification.cs create mode 100644 src/lob.dotnet/Model/IntlVerificationOrError.cs create mode 100644 src/lob.dotnet/Model/IntlVerificationWritable.cs create mode 100644 src/lob.dotnet/Model/IntlVerifications.cs create mode 100644 src/lob.dotnet/Model/IntlVerificationsPayload.cs create mode 100644 src/lob.dotnet/Model/Letter.cs create mode 100644 src/lob.dotnet/Model/LetterCustomEnvelope.cs create mode 100644 src/lob.dotnet/Model/LetterDeletion.cs create mode 100644 src/lob.dotnet/Model/LetterEditable.cs create mode 100644 src/lob.dotnet/Model/LetterList.cs create mode 100644 src/lob.dotnet/Model/LobConfidenceScore.cs create mode 100644 src/lob.dotnet/Model/LobError.cs create mode 100644 src/lob.dotnet/Model/Location.cs create mode 100644 src/lob.dotnet/Model/LocationAnalysis.cs create mode 100644 src/lob.dotnet/Model/MailType.cs create mode 100644 src/lob.dotnet/Model/MultipleComponents.cs create mode 100644 src/lob.dotnet/Model/MultipleComponentsIntl.cs create mode 100644 src/lob.dotnet/Model/MultipleComponentsList.cs create mode 100644 src/lob.dotnet/Model/Postcard.cs create mode 100644 src/lob.dotnet/Model/PostcardDeletion.cs create mode 100644 src/lob.dotnet/Model/PostcardEditable.cs create mode 100644 src/lob.dotnet/Model/PostcardList.cs create mode 100644 src/lob.dotnet/Model/PostcardSize.cs create mode 100644 src/lob.dotnet/Model/ReverseGeocode.cs create mode 100644 src/lob.dotnet/Model/SelfMailer.cs create mode 100644 src/lob.dotnet/Model/SelfMailerDeletion.cs create mode 100644 src/lob.dotnet/Model/SelfMailerEditable.cs create mode 100644 src/lob.dotnet/Model/SelfMailerList.cs create mode 100644 src/lob.dotnet/Model/SelfMailerSize.cs create mode 100644 src/lob.dotnet/Model/SortBy.cs create mode 100644 src/lob.dotnet/Model/SortBy1.cs create mode 100644 src/lob.dotnet/Model/SortBy2.cs create mode 100644 src/lob.dotnet/Model/SortBy3.cs create mode 100644 src/lob.dotnet/Model/SortBy4.cs create mode 100644 src/lob.dotnet/Model/SortBy5.cs create mode 100644 src/lob.dotnet/Model/Suggestions.cs create mode 100644 src/lob.dotnet/Model/Template.cs create mode 100644 src/lob.dotnet/Model/TemplateDeletion.cs create mode 100644 src/lob.dotnet/Model/TemplateList.cs create mode 100644 src/lob.dotnet/Model/TemplateUpdate.cs create mode 100644 src/lob.dotnet/Model/TemplateVersion.cs create mode 100644 src/lob.dotnet/Model/TemplateVersionDeletion.cs create mode 100644 src/lob.dotnet/Model/TemplateVersionList.cs create mode 100644 src/lob.dotnet/Model/TemplateVersionUpdatable.cs create mode 100644 src/lob.dotnet/Model/TemplateVersionWritable.cs create mode 100644 src/lob.dotnet/Model/TemplateWritable.cs create mode 100644 src/lob.dotnet/Model/Thumbnail.cs create mode 100644 src/lob.dotnet/Model/TrackingEventCertified.cs create mode 100644 src/lob.dotnet/Model/TrackingEventDetails.cs create mode 100644 src/lob.dotnet/Model/TrackingEventNormal.cs create mode 100644 src/lob.dotnet/Model/UsAutocompletions.cs create mode 100644 src/lob.dotnet/Model/UsAutocompletionsWritable.cs create mode 100644 src/lob.dotnet/Model/UsComponents.cs create mode 100644 src/lob.dotnet/Model/UsVerification.cs create mode 100644 src/lob.dotnet/Model/UsVerificationOrError.cs create mode 100644 src/lob.dotnet/Model/UsVerifications.cs create mode 100644 src/lob.dotnet/Model/UsVerificationsWritable.cs create mode 100644 src/lob.dotnet/Model/Zip.cs create mode 100644 src/lob.dotnet/Model/ZipCodeType.cs create mode 100644 src/lob.dotnet/Model/ZipEditable.cs create mode 100644 src/lob.dotnet/Model/ZipLookupCity.cs create mode 100644 src/lob.dotnet/lob.dotnet.csproj diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index fc85b2a..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,3 +0,0 @@ -**What:** - -**Why:** diff --git a/.gitignore b/.gitignore index 3e759b7..1ee5385 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,7 @@ ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore # User-specific files +*.rsuser *.suo *.user *.userosscache @@ -12,6 +13,9 @@ # User-specific files (MonoDevelop/Xamarin Studio) *.userprefs +# Mono auto generated files +mono_crash.* + # Build results [Dd]ebug/ [Dd]ebugPublic/ @@ -19,10 +23,14 @@ [Rr]eleases/ x64/ x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ bld/ [Bb]in/ [Oo]bj/ [Ll]og/ +[Ll]ogs/ # Visual Studio 2015/2017 cache/options directory .vs/ @@ -36,9 +44,10 @@ Generated\ Files/ [Tt]est[Rr]esult*/ [Bb]uild[Ll]og.* -# NUNIT +# NUnit *.VisualState.xml TestResult.xml +nunit-*.xml # Build Results of an ATL Project [Dd]ebugPS/ @@ -52,7 +61,9 @@ BenchmarkDotNet.Artifacts/ project.lock.json project.fragment.lock.json artifacts/ -**/Properties/launchSettings.json + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt # StyleCop StyleCopReport.xml @@ -60,7 +71,7 @@ StyleCopReport.xml # Files built by Visual Studio *_i.c *_p.c -*_i.h +*_h.h *.ilk *.meta *.obj @@ -77,6 +88,7 @@ StyleCopReport.xml *.tlh *.tmp *.tmp_proj +*_wpftmp.csproj *.log *.vspscc *.vssscc @@ -119,9 +131,6 @@ _ReSharper*/ *.[Rr]e[Ss]harper *.DotSettings.user -# JustCode is a .NET coding add-in -.JustCode - # TeamCity is a build add-in _TeamCity* @@ -132,6 +141,11 @@ _TeamCity* .axoCover/* !.axoCover/settings.json +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + # Visual Studio code coverage results *.coverage *.coveragexml @@ -179,6 +193,8 @@ PublishScripts/ # NuGet Packages *.nupkg +# NuGet Symbol Packages +*.snupkg # The packages folder can be ignored because of Package Restore **/[Pp]ackages/* # except build/, which is used as an MSBuild target. @@ -203,12 +219,14 @@ BundleArtifacts/ Package.StoreAssociation.xml _pkginfo.txt *.appx +*.appxbundle +*.appxupload # Visual Studio cache files # files ending in .cache can be ignored *.[Cc]ache # but keep track of directories ending in .cache -!*.[Cc]ache/ +!?*.[Cc]ache/ # Others ClientBin/ @@ -221,7 +239,7 @@ ClientBin/ *.publishsettings orleans.codegen.cs -# Including strong name files can present a security risk +# Including strong name files can present a security risk # (https://github.com/github/gitignore/pull/2483#issue-259490424) #*.snk @@ -252,6 +270,9 @@ ServiceFabricBackup/ *.bim.layout *.bim_*.settings *.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl # Microsoft Fakes FakesAssemblies/ @@ -287,12 +308,8 @@ paket-files/ # FAKE - F# Make .fake/ -# JetBrains Rider -.idea/ -*.sln.iml - -# CodeRush -.cr/ +# CodeRush personal settings +.cr/personal # Python Tools for Visual Studio (PTVS) __pycache__/ @@ -317,7 +334,7 @@ __pycache__/ # OpenCover UI analysis results OpenCover/ -# Azure Stream Analytics local run output +# Azure Stream Analytics local run output ASALocalRun/ # MSBuild Binary and Structured Log @@ -326,5 +343,20 @@ ASALocalRun/ # NVidia Nsight GPU debugger configuration file *.nvuser -# MFractors (Xamarin productivity tool) working folder +# MFractors (Xamarin productivity tool) working folder .mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd diff --git a/.openapi-generator-ignore b/.openapi-generator-ignore new file mode 100644 index 0000000..7484ee5 --- /dev/null +++ b/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 91cb035..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2018 Lob - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/Lob.sln b/Lob.sln deleted file mode 100644 index dc68fa1..0000000 --- a/Lob.sln +++ /dev/null @@ -1,31 +0,0 @@ - -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 15 -VisualStudioVersion = 15.0.27703.2000 -MinimumVisualStudioVersion = 10.0.40219.1 -Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Lob", "Lob\Lob.csproj", "{290F7BA4-AEEB-4054-9681-5D052DB13A56}" -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "LobTest", "LobTest\LobTest.csproj", "{B95B591D-B9C2-4CD5-943F-05F32374F33B}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {290F7BA4-AEEB-4054-9681-5D052DB13A56}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {290F7BA4-AEEB-4054-9681-5D052DB13A56}.Debug|Any CPU.Build.0 = Debug|Any CPU - {290F7BA4-AEEB-4054-9681-5D052DB13A56}.Release|Any CPU.ActiveCfg = Release|Any CPU - {290F7BA4-AEEB-4054-9681-5D052DB13A56}.Release|Any CPU.Build.0 = Release|Any CPU - {B95B591D-B9C2-4CD5-943F-05F32374F33B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {B95B591D-B9C2-4CD5-943F-05F32374F33B}.Debug|Any CPU.Build.0 = Debug|Any CPU - {B95B591D-B9C2-4CD5-943F-05F32374F33B}.Release|Any CPU.ActiveCfg = Release|Any CPU - {B95B591D-B9C2-4CD5-943F-05F32374F33B}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection - GlobalSection(ExtensibilityGlobals) = postSolution - SolutionGuid = {30FD9581-FEA1-4E8C-AA83-7B5124EF6592} - EndGlobalSection -EndGlobal diff --git a/Lob/Api/Address/AddressClient.cs b/Lob/Api/Address/AddressClient.cs deleted file mode 100644 index a8f099f..0000000 --- a/Lob/Api/Address/AddressClient.cs +++ /dev/null @@ -1,87 +0,0 @@ -using Lob.Api.Common; -using Lob.Common; -using Lob.Common.Utils; -using Lob.Protocol; -using System; -using System.Collections.Generic; -using System.Net.Http; -using System.Threading.Tasks; - -namespace Lob.Api.Address -{ - public class AddressClient - { - public AddressClient(LobRestClient client) - { - Client = client; - } - - private LobRestClient Client { get; set; } - - public Task> DeleteAsync(string id) - { - return Client.ExecuteAsync( - HttpMethod.Delete, - $"{Constants.AddressResourceEndpoint}/{id}" - ); - } - - public Task> GetAsync(string id) - { - return Client.ExecuteAsync( - HttpMethod.Get, - $"{Constants.AddressResourceEndpoint}/{id}" - ); - } - - // TODO: ListOptions - public Task>> ListAsync() - { - return Client.ExecuteAsync>( - HttpMethod.Get, - Constants.AddressResourceEndpoint - ); - } - - public Task> CreateAsync( - string addressLine1, - string addressLine2 = null, - string addressCity = null, - string addressState = null, - string addressZip = null, - string addressCountry = null, - string description = null, - string name = null, - string company = null, - string phone = null, - string email = null, - IDictionary metadata = null) - { - return CreateAsync( - new CreateAddressRequest() - { - Description = description, - Name = name, - Company = company, - AddressLine1 = addressLine1, - AddressLine2 = addressLine2, - AddressCity = addressCity, - AddressState = addressState, - AddressZip = addressZip, - AddressCountry = addressCountry, - Phone = phone, - Email = email, - Metadata = metadata - }); - } - - public Task> CreateAsync(CreateAddressRequest options) - { - return Client.ExecuteAsync( - HttpMethod.Post, - Constants.AddressResourceEndpoint, - HttpContentFactory.CreateJsonContent(options) - ); - } - } -} diff --git a/Lob/Api/Address/AddressResource.cs b/Lob/Api/Address/AddressResource.cs deleted file mode 100644 index 5e85609..0000000 --- a/Lob/Api/Address/AddressResource.cs +++ /dev/null @@ -1,24 +0,0 @@ -using Lob.Api.Common; -using System; -using System.Collections.Generic; - -namespace Lob.Api.Address -{ - public class AddressResource : DeletableResource - { - public string AddressLine1 { get; set; } - public string AddressLine2 { get; set; } - public string AddressCity { get; set; } - public string AddressState { get; set; } - public string AddressZip { get; set; } - public string AddressCountry { get; set; } - public string Company { get; set; } - public DateTime DateCreated { get; set; } - public DateTime DateModified { get; set; } - public string Description { get; set; } - public string Email { get; set; } - public IDictionary Metadata { get; set; } - public string Name { get; set; } - public string Phone { get; set; } - } -} diff --git a/Lob/Api/Address/CreateAddressRequest.cs b/Lob/Api/Address/CreateAddressRequest.cs deleted file mode 100644 index 279530d..0000000 --- a/Lob/Api/Address/CreateAddressRequest.cs +++ /dev/null @@ -1,20 +0,0 @@ -using System.Collections.Generic; - -namespace Lob.Api.Address -{ - public class CreateAddressRequest - { - public string Description { get; set; } - public string Name { get; set; } - public string Company { get; set; } - public string AddressLine1 { get; set; } - public string AddressLine2 { get; set; } - public string AddressCity { get; set; } - public string AddressState { get; set; } - public string AddressZip { get; set; } - public string AddressCountry { get; set; } - public string Phone { get; set; } - public string Email { get; set; } - public IDictionary Metadata { get; set; } - } -} diff --git a/Lob/Api/Common/DeletableResource.cs b/Lob/Api/Common/DeletableResource.cs deleted file mode 100644 index d3b52a0..0000000 --- a/Lob/Api/Common/DeletableResource.cs +++ /dev/null @@ -1,9 +0,0 @@ -namespace Lob.Api.Common -{ - public class DeletableResource - { - public bool Deleted { get; set; } - public string Id { get; set; } - public string Object { get; set; } - } -} diff --git a/Lob/Api/Common/LobCollection.cs b/Lob/Api/Common/LobCollection.cs deleted file mode 100644 index c8c9d78..0000000 --- a/Lob/Api/Common/LobCollection.cs +++ /dev/null @@ -1,11 +0,0 @@ -using System.Collections.Generic; - -namespace Lob.Api.Common -{ - public class LobCollection - { - public int Count { get; set; } - public IList Data { get; set; } - public string Object { get; set; } - } -} diff --git a/Lob/Common/Constants.cs b/Lob/Common/Constants.cs deleted file mode 100644 index 68be63b..0000000 --- a/Lob/Common/Constants.cs +++ /dev/null @@ -1,16 +0,0 @@ -namespace Lob.Common -{ - public static class Constants - { - public const string ContentTypeJson = "application/json"; - - public const string UserAgentProductName = "Lob-DotNet"; - public const string UserAgentProductVersion = "0.0.1"; - - public const string AddressResourceEndpoint = "addresses"; - public const string LobApiBaseAddress = "https://api.lob.com/v1/"; - - public const string RateLimitHeaderPrefix = "rate-limit"; - public static readonly string[] AllowedResponseHeaders = { Constants.RateLimitHeaderPrefix }; - } -} diff --git a/Lob/Common/Utils/HttpContentFactory.cs b/Lob/Common/Utils/HttpContentFactory.cs deleted file mode 100644 index 26bd066..0000000 --- a/Lob/Common/Utils/HttpContentFactory.cs +++ /dev/null @@ -1,15 +0,0 @@ -using Newtonsoft.Json; -using System.Net.Http; -using System.Text; - -namespace Lob.Common.Utils -{ - public static class HttpContentFactory - { - public static HttpContent CreateJsonContent(object obj) - { - string body = JsonConvert.SerializeObject(obj, SerializerSettings.DefaultJsonSerializerSettings); - return new StringContent(body, Encoding.UTF8, Constants.ContentTypeJson); - } - } -} diff --git a/Lob/Common/Utils/SerializerSettings.cs b/Lob/Common/Utils/SerializerSettings.cs deleted file mode 100644 index deac4bf..0000000 --- a/Lob/Common/Utils/SerializerSettings.cs +++ /dev/null @@ -1,20 +0,0 @@ -using Newtonsoft.Json; -using Newtonsoft.Json.Serialization; - -namespace Lob.Common.Utils -{ - public static class SerializerSettings - { - public static JsonSerializerSettings DefaultJsonSerializerSettings - { - get - { - return new JsonSerializerSettings() - { - ContractResolver = new DefaultContractResolver() { NamingStrategy = new SnakeCaseNamingStrategy() }, - Formatting = Formatting.Indented - }; - } - } - } -} diff --git a/Lob/Exceptions/LobException.cs b/Lob/Exceptions/LobException.cs deleted file mode 100644 index 14f5558..0000000 --- a/Lob/Exceptions/LobException.cs +++ /dev/null @@ -1,25 +0,0 @@ -using Newtonsoft.Json.Linq; -using System; - -namespace Lob.Exceptions -{ - public class LobException : Exception - { - public LobException(string message, int httpStatusCode) : base(message) - { - HttpStatusCode = httpStatusCode; - } - - public int HttpStatusCode { get; private set; } - - public static LobException Parse(string json) - { - JObject res = JObject.Parse(json); - return new LobException( - message: res["error"]["message"].ToString(), - httpStatusCode: res["error"]["status_code"].ToObject() - ); - } - } -} - diff --git a/Lob/Lob.csproj b/Lob/Lob.csproj deleted file mode 100644 index 58a8290..0000000 --- a/Lob/Lob.csproj +++ /dev/null @@ -1,17 +0,0 @@ - - - - netstandard2.0 - true - - - - full - true - - - - - - - diff --git a/Lob/LobClient.cs b/Lob/LobClient.cs deleted file mode 100644 index 46e44b0..0000000 --- a/Lob/LobClient.cs +++ /dev/null @@ -1,24 +0,0 @@ -using Lob.Api.Address; -using Lob.Protocol; -using System; - -namespace Lob -{ - public class LobClient - { - public LobClient(string apiKey) - { - if (String.IsNullOrWhiteSpace(apiKey)) - { - throw new ArgumentOutOfRangeException("ApiKey cannot be null or white space"); - } - - ApiKey = apiKey; - } - - public AddressClient Address => new AddressClient(LobRestClient); - - internal string ApiKey { get; private set; } - internal LobRestClient LobRestClient => new LobRestClient(ApiKey); - } -} diff --git a/Lob/Protocol/LobRequestOptions.cs b/Lob/Protocol/LobRequestOptions.cs deleted file mode 100644 index cb5ef88..0000000 --- a/Lob/Protocol/LobRequestOptions.cs +++ /dev/null @@ -1,7 +0,0 @@ -namespace Lob.Protocol -{ - public class LobRequestOptions - { - // TODO: idempotency key, api-version, timeout, retry policy, etc. - } -} diff --git a/Lob/Protocol/LobResponse.cs b/Lob/Protocol/LobResponse.cs deleted file mode 100644 index 2cb4a0f..0000000 --- a/Lob/Protocol/LobResponse.cs +++ /dev/null @@ -1,11 +0,0 @@ -using System.Collections.Generic; - -namespace Lob.Protocol -{ - public class LobResponse - { - public int HttpStatusCode { get; set; } - public IDictionary Headers { get; set; } - public TResult Result { get; set; } - } -} diff --git a/Lob/Protocol/LobRestClient.cs b/Lob/Protocol/LobRestClient.cs deleted file mode 100644 index 430037b..0000000 --- a/Lob/Protocol/LobRestClient.cs +++ /dev/null @@ -1,84 +0,0 @@ -using Lob.Common; -using Lob.Common.Utils; -using Lob.Exceptions; -using Newtonsoft.Json; -using System; -using System.Collections.Generic; -using System.Globalization; -using System.Linq; -using System.Net.Http; -using System.Net.Http.Headers; -using System.Text; -using System.Threading.Tasks; - -namespace Lob.Protocol -{ - public class LobRestClient - { - public LobRestClient(string apiKey, HttpClient client = null) - { - // TODO: HttpClient should be reused across requests - // TODO: HttpClient should be disposed - Client = client ?? new HttpClient(); - Client.BaseAddress = new Uri(Constants.LobApiBaseAddress); - Client.DefaultRequestHeaders.UserAgent.Add(new ProductInfoHeaderValue(Constants.UserAgentProductName, Constants.UserAgentProductVersion)); - Client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(Constants.ContentTypeJson)); - Client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes(apiKey + ":"))); - } - - public HttpClient Client { get; private set; } - - public async Task> ExecuteAsync( - HttpMethod method, - string requestUrl, - HttpContent content = null, - IDictionary queryParams = null, - LobRequestOptions requestOptions = null) - { - HttpRequestMessage request = new HttpRequestMessage(method, requestUrl); - - if (content != null) - { - request.Content = content; - } - - if (queryParams != null) - { - // TODO: - } - - var response = await Client.SendAsync(request).ConfigureAwait(false); - return await ParseLobResponseAsync(response); - } - - private async Task> ParseLobResponseAsync(HttpResponseMessage response) - { - string content = await response.Content.ReadAsStringAsync().ConfigureAwait(false); - - if (!response.IsSuccessStatusCode) - { - LobException exception = null; - - try - { - exception = LobException.Parse(content); - } - catch (JsonException) - { - exception = new LobException(message: content, httpStatusCode: (int)response.StatusCode); - } - - throw exception; - } - - return new LobResponse - { - Result = JsonConvert.DeserializeObject(content, SerializerSettings.DefaultJsonSerializerSettings), - HttpStatusCode = (int)response.StatusCode, - Headers = response.Headers - .Where(h => Constants.AllowedResponseHeaders.Any(pattern => h.Key.StartsWith(pattern, true, CultureInfo.InvariantCulture))) - .ToDictionary(h => h.Key, h => h.Value.FirstOrDefault()) - }; - } - } -} diff --git a/LobTest/AcceptanceTestBase.cs b/LobTest/AcceptanceTestBase.cs deleted file mode 100644 index 6a8357f..0000000 --- a/LobTest/AcceptanceTestBase.cs +++ /dev/null @@ -1,17 +0,0 @@ -using Lob; -using NUnit.Framework; - -namespace LobTest -{ - [TestFixture(Category = "Acceptance")] - public abstract class AcceptanceTestBase - { - [SetUp] - public virtual void Setup() - { - LobClient = new LobClient("test_08423401b0a727b2301faf21570effdf984"); - } - - public LobClient LobClient { get; set; } - } -} diff --git a/LobTest/Api/Address/AddressClientAcceptanceTest.cs b/LobTest/Api/Address/AddressClientAcceptanceTest.cs deleted file mode 100644 index 2361c52..0000000 --- a/LobTest/Api/Address/AddressClientAcceptanceTest.cs +++ /dev/null @@ -1,140 +0,0 @@ -using Lob; -using Lob.Api.Address; -using NUnit.Framework; -using System; -using System.Collections.Generic; -using System.Linq; -using System.Threading.Tasks; - -namespace LobTest.Api.Address -{ - public class AddressClientAcceptanceTest : AcceptanceTestBase - { - public readonly AddressResource ADDRESS = new AddressResource - { - Description = "Harry - Office", - Name = "HARRY", - Company = "COMPANY", - Email = "test@lob.com", - Phone = "some phone", - AddressLine1 = "185 BERRY ST STE 6100", - AddressCity = "SAN FRANCISCO", - AddressState = "CA", - AddressZip = "94107-1741", - AddressCountry = "UNITED STATES", - Metadata = new Dictionary - { - ["foo"] = "bar", - ["fizz"] = "buzz" - }, - Object = "address" - }; - - [Test] - public async Task TestCreateAsync() - { - var response = await LobClient.Address.CreateAsync( - description: ADDRESS.Description, - name: ADDRESS.Name, - company: ADDRESS.Company, - email: ADDRESS.Email, - phone: ADDRESS.Phone, - addressLine1: ADDRESS.AddressLine1, - addressCity: ADDRESS.AddressCity, - addressState: ADDRESS.AddressState, - addressZip: ADDRESS.AddressZip, - addressCountry: "US", - metadata: ADDRESS.Metadata - ); - - var address = response.Result; - - Assert.AreEqual(200, response.HttpStatusCode); - StringAssert.AreEqualIgnoringCase(ADDRESS.Description, address.Description); - StringAssert.AreEqualIgnoringCase(ADDRESS.Name, address.Name); - StringAssert.AreEqualIgnoringCase(ADDRESS.Company, address.Company); - StringAssert.AreEqualIgnoringCase(ADDRESS.Email, address.Email); - StringAssert.AreEqualIgnoringCase(ADDRESS.Phone, address.Phone); - CollectionAssert.AreEquivalent(ADDRESS.Metadata, address.Metadata); - Assert.AreEqual(ADDRESS.AddressLine1, address.AddressLine1); - Assert.AreEqual(ADDRESS.AddressCity, address.AddressCity); - Assert.AreEqual(ADDRESS.AddressState, address.AddressState); - Assert.AreEqual(ADDRESS.AddressZip, address.AddressZip); - Assert.AreEqual(ADDRESS.AddressCountry, address.AddressCountry); - Assert.AreNotEqual(address.DateCreated, default(DateTime)); - Assert.AreNotEqual(address.DateModified, default(DateTime)); - Assert.IsFalse(String.IsNullOrEmpty(address.Id)); - Assert.IsFalse(address.Deleted); - Assert.AreEqual(ADDRESS.Object, address.Object); - } - - [Test] - public async Task TestDeleteAsync() - { - var address = (await LobClient.Address.CreateAsync( - new CreateAddressRequest() - { - Description = ADDRESS.Description, - Name = ADDRESS.Name, - Company = ADDRESS.Company, - Email = ADDRESS.Email, - Phone = ADDRESS.Phone, - AddressLine1 = ADDRESS.AddressLine1, - AddressCity = ADDRESS.AddressCity, - AddressState = ADDRESS.AddressState, - AddressZip = ADDRESS.AddressZip, - AddressCountry = "US", - Metadata = ADDRESS.Metadata - } - )).Result; - - var response = await LobClient.Address.DeleteAsync(address.Id); - - Assert.AreEqual(200, response.HttpStatusCode); - Assert.AreEqual(address.Id, response.Result.Id); - Assert.True(response.Result.Deleted); - } - - [Test] - public async Task TestGetAsync() - { - var address = (await LobClient.Address.ListAsync()).Result.Data.First(); - var response = await LobClient.Address.GetAsync(address.Id); - - Assert.AreEqual(200, response.HttpStatusCode); - AssertAddressEquals(address, response.Result); - } - - [Test] - public async Task TestListAsync() - { - var response = await LobClient.Address.ListAsync(); - - Assert.AreEqual(200, response.HttpStatusCode); - Assert.GreaterOrEqual(response.Result.Data.Count, 1); - Assert.GreaterOrEqual(response.Result.Count, 1); - Assert.AreEqual("list", response.Result.Object); - } - - private static void AssertAddressEquals(AddressResource x, AddressResource y) - { - Assert.AreEqual(x.Id, y.Id); - Assert.AreEqual(x.DateCreated, y.DateCreated); - Assert.AreEqual(x.DateModified, y.DateModified); - Assert.AreEqual(x.Deleted, y.Deleted); - Assert.AreEqual(x.Description, y.Description); - Assert.AreEqual(x.Email, y.Email); - Assert.AreEqual(x.Name, y.Name); - Assert.AreEqual(x.Object, y.Object); - Assert.AreEqual(x.Phone, y.Phone); - Assert.AreEqual(x.AddressCity, y.AddressCity); - Assert.AreEqual(x.AddressCountry, y.AddressCountry); - Assert.AreEqual(x.AddressLine1, y.AddressLine1); - Assert.AreEqual(x.AddressLine2, y.AddressLine2); - Assert.AreEqual(x.AddressState, y.AddressState); - Assert.AreEqual(x.AddressZip, y.AddressZip); - Assert.AreEqual(x.Company, y.Company); - } - } -} - diff --git a/LobTest/Exceptions/LobExceptionTest.cs b/LobTest/Exceptions/LobExceptionTest.cs deleted file mode 100644 index 5a45a81..0000000 --- a/LobTest/Exceptions/LobExceptionTest.cs +++ /dev/null @@ -1,31 +0,0 @@ -using Lob.Exceptions; -using Newtonsoft.Json; -using NUnit.Framework; - -namespace LobTest.Exceptions -{ - [TestFixture] - class LobExceptionTest - { - [Test] - public void TestParseJson() - { - const string EXPECTED_MESSAGE = "expected_message"; - const int EXPECTED_STATUS_CODE = 422; - - var json = JsonConvert.SerializeObject(new - { - error = new - { - message = EXPECTED_MESSAGE, - status_code = EXPECTED_STATUS_CODE - } - }); - - LobException exception = LobException.Parse(json); - - Assert.AreEqual(EXPECTED_MESSAGE, exception.Message); - Assert.AreEqual(EXPECTED_STATUS_CODE, exception.HttpStatusCode); - } - } -} diff --git a/LobTest/LobTest.csproj b/LobTest/LobTest.csproj deleted file mode 100644 index b2a1c53..0000000 --- a/LobTest/LobTest.csproj +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - - - Debug - AnyCPU - {B95B591D-B9C2-4CD5-943F-05F32374F33B} - Library - Properties - LobTest - LobTest - v4.6.1 - 512 - - - - - true - full - false - bin\Debug\ - DEBUG;TRACE - prompt - 4 - - - pdbonly - true - bin\Release\ - TRACE - prompt - 4 - - - - ..\packages\Microsoft.CodeCoverage.1.0.3\lib\netstandard1.0\Microsoft.VisualStudio.CodeCoverage.Shim.dll - - - ..\packages\Newtonsoft.Json.11.0.2\lib\net45\Newtonsoft.Json.dll - - - ..\packages\NUnit.3.10.1\lib\net45\nunit.framework.dll - - - - - - - - - - - - - - - - - - - - - - {290f7ba4-aeeb-4054-9681-5d052db13a56} - Lob - - - - - - - This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}. - - - - - - - - \ No newline at end of file diff --git a/LobTest/Properties/AssemblyInfo.cs b/LobTest/Properties/AssemblyInfo.cs deleted file mode 100644 index dea281b..0000000 --- a/LobTest/Properties/AssemblyInfo.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System.Reflection; -using System.Runtime.CompilerServices; -using System.Runtime.InteropServices; - -// General Information about an assembly is controlled through the following -// set of attributes. Change these attribute values to modify the information -// associated with an assembly. -[assembly: AssemblyTitle("LobTest")] -[assembly: AssemblyDescription("")] -[assembly: AssemblyConfiguration("")] -[assembly: AssemblyCompany("")] -[assembly: AssemblyProduct("LobTest")] -[assembly: AssemblyCopyright("Copyright © 2018")] -[assembly: AssemblyTrademark("")] -[assembly: AssemblyCulture("")] - -// Setting ComVisible to false makes the types in this assembly not visible -// to COM components. If you need to access a type in this assembly from -// COM, set the ComVisible attribute to true on that type. -[assembly: ComVisible(false)] - -// The following GUID is for the ID of the typelib if this project is exposed to COM -[assembly: Guid("b95b591d-b9c2-4cd5-943f-05f32374f33b")] - -// Version information for an assembly consists of the following four values: -// -// Major Version -// Minor Version -// Build Number -// Revision -// -// You can specify all the values or you can default the Build and Revision Numbers -// by using the '*' as shown below: -// [assembly: AssemblyVersion("1.0.*")] -[assembly: AssemblyVersion("1.0.0.0")] -[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/LobTest/packages.config b/LobTest/packages.config deleted file mode 100644 index b07b55e..0000000 --- a/LobTest/packages.config +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/README.md b/README.md new file mode 100644 index 0000000..5625516 --- /dev/null +++ b/README.md @@ -0,0 +1,292 @@ +# 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + + +This C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) 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/](https://support.lob.com/) + + +## Frameworks supported + + +## Dependencies + +- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.13.0 or later +- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 12.0.3 or later +- [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.8.0 or later +- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 5.0.0 or later + +The DLLs included in the package may not be the latest version. We recommend using [NuGet](https://docs.nuget.org/consume/installing-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](https://github.com/restsharp/RestSharp/issues/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](https://github.com/restsharp/RestSharp/issues/1406). + + +## 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: +```csharp +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; +``` + +## Packaging + +A `.nuspec` is included with the project. You can follow the Nuget quickstart to [create](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#create-the-package) and [publish](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#publish-the-package) 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](https://docs.microsoft.com/en-us/nuget/hosting-packages/local-feeds) or [other host](https://docs.microsoft.com/en-us/nuget/hosting-packages/overview) and consume the new package via Nuget as usual. + + +## Usage + +To use the API client with a HTTP proxy, setup a `System.Net.WebProxy` +```csharp +Configuration c = new Configuration(); +System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/"); +webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials; +c.Proxy = webProxy; +``` + + +## Getting Started + +```csharp +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_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new AddressesApi(config); + var addressEditable = new AddressEditable(); // AddressEditable | + + try + { + // create + Address result = apiInstance.AddressCreate(addressEditable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling AddressesApi.AddressCreate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + + } + } +} +``` + + +## Documentation for API Endpoints + +All URIs are relative to *https://api.lob.com/v1* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*AddressesApi* | [**AddressCreate**](docs/AddressesApi.md#addresscreate) | **POST** /addresses | create +*AddressesApi* | [**AddressDelete**](docs/AddressesApi.md#addressdelete) | **DELETE** /addresses/{adr_id} | delete +*AddressesApi* | [**AddressRetrieve**](docs/AddressesApi.md#addressretrieve) | **GET** /addresses/{adr_id} | get +*AddressesApi* | [**AddressesList**](docs/AddressesApi.md#addresseslist) | **GET** /addresses | list +*BankAccountsApi* | [**BankAccountCreate**](docs/BankAccountsApi.md#bankaccountcreate) | **POST** /bank_accounts | create +*BankAccountsApi* | [**BankAccountDelete**](docs/BankAccountsApi.md#bankaccountdelete) | **DELETE** /bank_accounts/{bank_id} | delete +*BankAccountsApi* | [**BankAccountRetrieve**](docs/BankAccountsApi.md#bankaccountretrieve) | **GET** /bank_accounts/{bank_id} | get +*BankAccountsApi* | [**BankAccountVerify**](docs/BankAccountsApi.md#bankaccountverify) | **POST** /bank_accounts/{bank_id}/verify | verify +*BankAccountsApi* | [**BankAccountsList**](docs/BankAccountsApi.md#bankaccountslist) | **GET** /bank_accounts | list +*BillingGroupsApi* | [**BillingGroupCreate**](docs/BillingGroupsApi.md#billinggroupcreate) | **POST** /billing_groups | create +*BillingGroupsApi* | [**BillingGroupRetrieve**](docs/BillingGroupsApi.md#billinggroupretrieve) | **GET** /billing_groups/{bg_id} | get +*BillingGroupsApi* | [**BillingGroupUpdate**](docs/BillingGroupsApi.md#billinggroupupdate) | **POST** /billing_groups/{bg_id} | update +*BillingGroupsApi* | [**BillingGroupsList**](docs/BillingGroupsApi.md#billinggroupslist) | **GET** /billing_groups | list +*CardOrdersApi* | [**CardOrderCreate**](docs/CardOrdersApi.md#cardordercreate) | **POST** /cards/{card_id}/orders | create +*CardOrdersApi* | [**CardOrdersRetrieve**](docs/CardOrdersApi.md#cardordersretrieve) | **GET** /cards/{card_id}/orders | get +*CardsApi* | [**CardCreate**](docs/CardsApi.md#cardcreate) | **POST** /cards | create +*CardsApi* | [**CardDelete**](docs/CardsApi.md#carddelete) | **DELETE** /cards/{card_id} | delete +*CardsApi* | [**CardRetrieve**](docs/CardsApi.md#cardretrieve) | **GET** /cards/{card_id} | get +*CardsApi* | [**CardUpdate**](docs/CardsApi.md#cardupdate) | **POST** /cards/{card_id} | update +*CardsApi* | [**CardsList**](docs/CardsApi.md#cardslist) | **GET** /cards | list +*ChecksApi* | [**CheckCancel**](docs/ChecksApi.md#checkcancel) | **DELETE** /checks/{chk_id} | cancel +*ChecksApi* | [**CheckCreate**](docs/ChecksApi.md#checkcreate) | **POST** /checks | create +*ChecksApi* | [**CheckRetrieve**](docs/ChecksApi.md#checkretrieve) | **GET** /checks/{chk_id} | get +*ChecksApi* | [**ChecksList**](docs/ChecksApi.md#checkslist) | **GET** /checks | list +*IntlAutocompletionsApi* | [**IntlAutocompletion**](docs/IntlAutocompletionsApi.md#intlautocompletion) | **POST** /intl_autocompletions | autocomplete +*IntlVerificationsApi* | [**BulkIntlVerifications**](docs/IntlVerificationsApi.md#bulkintlverifications) | **POST** /bulk/intl_verifications | verifyBulk +*IntlVerificationsApi* | [**IntlVerification**](docs/IntlVerificationsApi.md#intlverification) | **POST** /intl_verifications | verifySingle +*LettersApi* | [**LetterCancel**](docs/LettersApi.md#lettercancel) | **DELETE** /letters/{ltr_id} | cancel +*LettersApi* | [**LetterCreate**](docs/LettersApi.md#lettercreate) | **POST** /letters | create +*LettersApi* | [**LetterRetrieve**](docs/LettersApi.md#letterretrieve) | **GET** /letters/{ltr_id} | get +*LettersApi* | [**LettersList**](docs/LettersApi.md#letterslist) | **GET** /letters | list +*PostcardsApi* | [**PostcardCreate**](docs/PostcardsApi.md#postcardcreate) | **POST** /postcards | create +*PostcardsApi* | [**PostcardDelete**](docs/PostcardsApi.md#postcarddelete) | **DELETE** /postcards/{psc_id} | cancel +*PostcardsApi* | [**PostcardRetrieve**](docs/PostcardsApi.md#postcardretrieve) | **GET** /postcards/{psc_id} | get +*PostcardsApi* | [**PostcardsList**](docs/PostcardsApi.md#postcardslist) | **GET** /postcards | list +*ReverseGeocodeLookupsApi* | [**ReverseGeocodeLookup**](docs/ReverseGeocodeLookupsApi.md#reversegeocodelookup) | **POST** /us_reverse_geocode_lookups | lookup +*SelfMailersApi* | [**SelfMailerCreate**](docs/SelfMailersApi.md#selfmailercreate) | **POST** /self_mailers | create +*SelfMailersApi* | [**SelfMailerDelete**](docs/SelfMailersApi.md#selfmailerdelete) | **DELETE** /self_mailers/{sfm_id} | delete +*SelfMailersApi* | [**SelfMailerRetrieve**](docs/SelfMailersApi.md#selfmailerretrieve) | **GET** /self_mailers/{sfm_id} | get +*SelfMailersApi* | [**SelfMailersList**](docs/SelfMailersApi.md#selfmailerslist) | **GET** /self_mailers | list +*TemplateVersionsApi* | [**CreateTemplateVersion**](docs/TemplateVersionsApi.md#createtemplateversion) | **POST** /templates/{tmpl_id}/versions | create +*TemplateVersionsApi* | [**TemplateVersionDelete**](docs/TemplateVersionsApi.md#templateversiondelete) | **DELETE** /templates/{tmpl_id}/versions/{vrsn_id} | delete +*TemplateVersionsApi* | [**TemplateVersionRetrieve**](docs/TemplateVersionsApi.md#templateversionretrieve) | **GET** /templates/{tmpl_id}/versions/{vrsn_id} | get +*TemplateVersionsApi* | [**TemplateVersionUpdate**](docs/TemplateVersionsApi.md#templateversionupdate) | **POST** /templates/{tmpl_id}/versions/{vrsn_id} | update +*TemplateVersionsApi* | [**TemplateVersionsList**](docs/TemplateVersionsApi.md#templateversionslist) | **GET** /templates/{tmpl_id}/versions | list +*TemplatesApi* | [**CreateTemplate**](docs/TemplatesApi.md#createtemplate) | **POST** /templates | create +*TemplatesApi* | [**TemplateDelete**](docs/TemplatesApi.md#templatedelete) | **DELETE** /templates/{tmpl_id} | delete +*TemplatesApi* | [**TemplateRetrieve**](docs/TemplatesApi.md#templateretrieve) | **GET** /templates/{tmpl_id} | get +*TemplatesApi* | [**TemplateUpdate**](docs/TemplatesApi.md#templateupdate) | **POST** /templates/{tmpl_id} | update +*TemplatesApi* | [**TemplatesList**](docs/TemplatesApi.md#templateslist) | **GET** /templates | list +*UsAutocompletionsApi* | [**UsAutocompletion**](docs/UsAutocompletionsApi.md#usautocompletion) | **POST** /us_autocompletions | autocomplete +*UsVerificationsApi* | [**BulkUsVerifications**](docs/UsVerificationsApi.md#bulkusverifications) | **POST** /bulk/us_verifications | verifyBulk +*UsVerificationsApi* | [**UsVerification**](docs/UsVerificationsApi.md#usverification) | **POST** /us_verifications | verifySingle +*ZipLookupsApi* | [**ZipLookup**](docs/ZipLookupsApi.md#ziplookup) | **POST** /us_zip_lookups | lookup + + + +## Documentation for Models + + - [Model.Address](docs/Address.md) + - [Model.AddressDeletion](docs/AddressDeletion.md) + - [Model.AddressDomesticExpanded](docs/AddressDomesticExpanded.md) + - [Model.AddressEditable](docs/AddressEditable.md) + - [Model.AddressList](docs/AddressList.md) + - [Model.BankAccount](docs/BankAccount.md) + - [Model.BankAccountDeletion](docs/BankAccountDeletion.md) + - [Model.BankAccountList](docs/BankAccountList.md) + - [Model.BankAccountVerify](docs/BankAccountVerify.md) + - [Model.BankAccountWritable](docs/BankAccountWritable.md) + - [Model.BankTypeEnum](docs/BankTypeEnum.md) + - [Model.BillingGroup](docs/BillingGroup.md) + - [Model.BillingGroupEditable](docs/BillingGroupEditable.md) + - [Model.BillingGroupList](docs/BillingGroupList.md) + - [Model.BulkError](docs/BulkError.md) + - [Model.BulkErrorProperties](docs/BulkErrorProperties.md) + - [Model.Card](docs/Card.md) + - [Model.CardDeletion](docs/CardDeletion.md) + - [Model.CardEditable](docs/CardEditable.md) + - [Model.CardList](docs/CardList.md) + - [Model.CardOrder](docs/CardOrder.md) + - [Model.CardOrderEditable](docs/CardOrderEditable.md) + - [Model.CardOrderList](docs/CardOrderList.md) + - [Model.CardUpdatable](docs/CardUpdatable.md) + - [Model.Check](docs/Check.md) + - [Model.CheckDeletion](docs/CheckDeletion.md) + - [Model.CheckEditable](docs/CheckEditable.md) + - [Model.CheckList](docs/CheckList.md) + - [Model.CountryExtended](docs/CountryExtended.md) + - [Model.CountryExtendedExpanded](docs/CountryExtendedExpanded.md) + - [Model.DeliverabilityAnalysis](docs/DeliverabilityAnalysis.md) + - [Model.DpvFootnote](docs/DpvFootnote.md) + - [Model.EngineHtml](docs/EngineHtml.md) + - [Model.EventType](docs/EventType.md) + - [Model.Events](docs/Events.md) + - [Model.GeocodeAddresses](docs/GeocodeAddresses.md) + - [Model.GeocodeComponents](docs/GeocodeComponents.md) + - [Model.IntlAutocompletions](docs/IntlAutocompletions.md) + - [Model.IntlAutocompletionsWritable](docs/IntlAutocompletionsWritable.md) + - [Model.IntlComponents](docs/IntlComponents.md) + - [Model.IntlSuggestions](docs/IntlSuggestions.md) + - [Model.IntlVerification](docs/IntlVerification.md) + - [Model.IntlVerificationOrError](docs/IntlVerificationOrError.md) + - [Model.IntlVerificationWritable](docs/IntlVerificationWritable.md) + - [Model.IntlVerifications](docs/IntlVerifications.md) + - [Model.IntlVerificationsPayload](docs/IntlVerificationsPayload.md) + - [Model.Letter](docs/Letter.md) + - [Model.LetterCustomEnvelope](docs/LetterCustomEnvelope.md) + - [Model.LetterDeletion](docs/LetterDeletion.md) + - [Model.LetterEditable](docs/LetterEditable.md) + - [Model.LetterList](docs/LetterList.md) + - [Model.LobConfidenceScore](docs/LobConfidenceScore.md) + - [Model.LobError](docs/LobError.md) + - [Model.Location](docs/Location.md) + - [Model.LocationAnalysis](docs/LocationAnalysis.md) + - [Model.MailType](docs/MailType.md) + - [Model.MultipleComponents](docs/MultipleComponents.md) + - [Model.MultipleComponentsIntl](docs/MultipleComponentsIntl.md) + - [Model.MultipleComponentsList](docs/MultipleComponentsList.md) + - [Model.Postcard](docs/Postcard.md) + - [Model.PostcardDeletion](docs/PostcardDeletion.md) + - [Model.PostcardEditable](docs/PostcardEditable.md) + - [Model.PostcardList](docs/PostcardList.md) + - [Model.PostcardSize](docs/PostcardSize.md) + - [Model.ReverseGeocode](docs/ReverseGeocode.md) + - [Model.SelfMailer](docs/SelfMailer.md) + - [Model.SelfMailerDeletion](docs/SelfMailerDeletion.md) + - [Model.SelfMailerEditable](docs/SelfMailerEditable.md) + - [Model.SelfMailerList](docs/SelfMailerList.md) + - [Model.SelfMailerSize](docs/SelfMailerSize.md) + - [Model.SortBy](docs/SortBy.md) + - [Model.SortBy1](docs/SortBy1.md) + - [Model.SortBy2](docs/SortBy2.md) + - [Model.SortBy3](docs/SortBy3.md) + - [Model.SortBy4](docs/SortBy4.md) + - [Model.SortBy5](docs/SortBy5.md) + - [Model.Suggestions](docs/Suggestions.md) + - [Model.Template](docs/Template.md) + - [Model.TemplateDeletion](docs/TemplateDeletion.md) + - [Model.TemplateList](docs/TemplateList.md) + - [Model.TemplateUpdate](docs/TemplateUpdate.md) + - [Model.TemplateVersion](docs/TemplateVersion.md) + - [Model.TemplateVersionDeletion](docs/TemplateVersionDeletion.md) + - [Model.TemplateVersionList](docs/TemplateVersionList.md) + - [Model.TemplateVersionUpdatable](docs/TemplateVersionUpdatable.md) + - [Model.TemplateVersionWritable](docs/TemplateVersionWritable.md) + - [Model.TemplateWritable](docs/TemplateWritable.md) + - [Model.Thumbnail](docs/Thumbnail.md) + - [Model.TrackingEventCertified](docs/TrackingEventCertified.md) + - [Model.TrackingEventDetails](docs/TrackingEventDetails.md) + - [Model.TrackingEventNormal](docs/TrackingEventNormal.md) + - [Model.UsAutocompletions](docs/UsAutocompletions.md) + - [Model.UsAutocompletionsWritable](docs/UsAutocompletionsWritable.md) + - [Model.UsComponents](docs/UsComponents.md) + - [Model.UsVerification](docs/UsVerification.md) + - [Model.UsVerificationOrError](docs/UsVerificationOrError.md) + - [Model.UsVerifications](docs/UsVerifications.md) + - [Model.UsVerificationsWritable](docs/UsVerificationsWritable.md) + - [Model.Zip](docs/Zip.md) + - [Model.ZipCodeType](docs/ZipCodeType.md) + - [Model.ZipEditable](docs/ZipEditable.md) + - [Model.ZipLookupCity](docs/ZipLookupCity.md) + + + +## Documentation for Authorization + + +### basicAuth + +- **Type**: HTTP basic authentication + diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 0000000..a423d13 --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,9 @@ +# auto-generated by OpenAPI Generator (https://github.com/OpenAPITools/openapi-generator) +# +image: Visual Studio 2019 +clone_depth: 1 +build_script: +- dotnet build -c Release +- dotnet test -c Release +after_build: +- dotnet pack .\src\lob.dotnet\lob.dotnet.csproj -o ../../output -c Release --no-build diff --git a/docs/Address.md b/docs/Address.md new file mode 100644 index 0000000..8e489bd --- /dev/null +++ b/docs/Address.md @@ -0,0 +1,27 @@ +# lob.dotnet.Model.Address + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `adr_`. | [optional] +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Name** | **string** | name associated with address | [optional] +**Company** | **string** | Either `name` or `company` is required, you may also add both. | [optional] +**Phone** | **string** | Must be no longer than 40 characters. | [optional] +**Email** | **string** | Must be no longer than 100 characters. | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**AddressLine1** | **string** | | [optional] +**AddressLine2** | **string** | | [optional] +**AddressCity** | **string** | | [optional] +**AddressState** | **string** | 2 letter state short-name code | [optional] +**AddressZip** | **string** | Must follow the ZIP format of `12345` or ZIP+4 format of `12345-1234`. | [optional] +**AddressCountry** | [**CountryExtendedExpanded**](CountryExtendedExpanded.md) | | [optional] +**Object** | **string** | | [optional] [default to ObjectEnum.Address] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**DateModified** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**RecipientMoved** | **bool?** | Only returned for accounts on certain <a href=\"https://dashboard.lob.com/#/settings/editions\">Print &amp; Mail Editions</a>. Value is `true` if the address was altered because the recipient filed for a <a href=\"#ncoa\">National Change of Address (NCOA)</a>, `false` if the NCOA check was run but no altered address was found, and `null` if the NCOA check was not run. The NCOA check does not happen for non-US addresses, for non-deliverable US addresses, or for addresses created before the NCOA feature was added to your account. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AddressDeletion.md b/docs/AddressDeletion.md new file mode 100644 index 0000000..f200b93 --- /dev/null +++ b/docs/AddressDeletion.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.AddressDeletion +Object returned upon deleting an address + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `adr_`. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | Value is type of resource. | [optional] [default to ObjectEnum.AddressDeleted] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AddressDomesticExpanded.md b/docs/AddressDomesticExpanded.md new file mode 100644 index 0000000..bbcb0da --- /dev/null +++ b/docs/AddressDomesticExpanded.md @@ -0,0 +1,21 @@ +# lob.dotnet.Model.AddressDomesticExpanded + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressLine1** | **string** | The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. | [optional] +**AddressLine2** | **string** | The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. | [optional] +**AddressCity** | **string** | | [optional] +**AddressState** | **string** | | [optional] +**AddressZip** | **string** | Optional postal code. For US addresses, must be either 5 or 9 digits. | [optional] +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Name** | **string** | Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address. | [optional] +**Company** | **string** | Either `name` or `company` is required, you may also add both. | [optional] +**Phone** | **string** | Must be no longer than 40 characters. | [optional] +**Email** | **string** | Must be no longer than 100 characters. | [optional] +**AddressCountry** | **string** | The country associated with this address. | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AddressEditable.md b/docs/AddressEditable.md new file mode 100644 index 0000000..f207aab --- /dev/null +++ b/docs/AddressEditable.md @@ -0,0 +1,21 @@ +# lob.dotnet.Model.AddressEditable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressLine1** | **string** | The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. | [optional] +**AddressLine2** | **string** | The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. | [optional] +**AddressCity** | **string** | | [optional] +**AddressState** | **string** | | [optional] +**AddressZip** | **string** | Optional postal code. For US addresses, must be either 5 or 9 digits. | [optional] +**AddressCountry** | [**CountryExtended**](CountryExtended.md) | | [optional] +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Name** | **string** | name associated with address. | [optional] +**Company** | **string** | Either `name` or `company` is required, you may also add both. | [optional] +**Phone** | **string** | Must be no longer than 40 characters. | [optional] +**Email** | **string** | Must be no longer than 100 characters. | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AddressList.md b/docs/AddressList.md new file mode 100644 index 0000000..f2289b3 --- /dev/null +++ b/docs/AddressList.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.AddressList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**List<Address>**](Address.md) | list of addresses | [optional] +**Object** | **string** | Value is type of resource. | [optional] +**NextUrl** | **string** | url of next page of items in list. | [optional] +**PreviousUrl** | **string** | url of previous page of items in list. | [optional] +**Count** | **int** | number of resources in a set | [optional] +**TotalCount** | **int** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/AddressesApi.md b/docs/AddressesApi.md new file mode 100644 index 0000000..16ecf12 --- /dev/null +++ b/docs/AddressesApi.md @@ -0,0 +1,326 @@ +# lob.dotnet.Api.AddressesApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**AddressCreate**](AddressesApi.md#addresscreate) | **POST** /addresses | create +[**AddressDelete**](AddressesApi.md#addressdelete) | **DELETE** /addresses/{adr_id} | delete +[**AddressRetrieve**](AddressesApi.md#addressretrieve) | **GET** /addresses/{adr_id} | get +[**AddressesList**](AddressesApi.md#addresseslist) | **GET** /addresses | list + + + +# **AddressCreate** +> Address AddressCreate (AddressEditable addressEditable) + +create + +Creates a new address given information + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class AddressCreateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new AddressesApi(config); + var addressEditable = new AddressEditable(); // AddressEditable | + + try + { + // create + Address result = apiInstance.AddressCreate(addressEditable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling AddressesApi.AddressCreate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **addressEditable** | [**AddressEditable**](AddressEditable.md)| | + +### Return type + +[**Address**](Address.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Echos the writable fields of a newly created address object. | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **AddressDelete** +> AddressDeletion AddressDelete (string adrId) + +delete + +Deletes the details of an existing address. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class AddressDeleteExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new AddressesApi(config); + var adrId = adrId_example; // string | id of the address + + try + { + // delete + AddressDeletion result = apiInstance.AddressDelete(adrId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling AddressesApi.AddressDelete: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **adrId** | **string**| id of the address | + +### Return type + +[**AddressDeletion**](AddressDeletion.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Deleted | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **AddressRetrieve** +> Address AddressRetrieve (string adrId) + +get + +Retrieves the details of an existing address. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class AddressRetrieveExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new AddressesApi(config); + var adrId = adrId_example; // string | id of the address + + try + { + // get + Address result = apiInstance.AddressRetrieve(adrId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling AddressesApi.AddressRetrieve: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **adrId** | **string**| id of the address | + +### Return type + +[**Address**](Address.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns an address object if a valid identifier was provided. | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **AddressesList** +> AddressList AddressesList (int? limit = null, string before = null, string after = null, List include = null, Dictionary dateCreated = null, Dictionary metadata = null) + +list + +Returns a list of your addresses. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class AddressesListExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new AddressesApi(config); + var limit = 56; // int? | How many results to return. (optional) (default to 10) + var before = before_example; // string | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + var after = after_example; // string | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + var include = new List(); // List | Request that the response include the total count by specifying `include[]=total_count`. (optional) + var dateCreated = new Dictionary(); // Dictionary | Filter by date created. (optional) + var metadata = new Dictionary(); // Dictionary | Filter by metadata key-value pair`. (optional) + + try + { + // list + AddressList result = apiInstance.AddressesList(limit, before, after, include, dateCreated, metadata); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling AddressesApi.AddressesList: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int?**| How many results to return. | [optional] [default to 10] + **before** | **string**| A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. | [optional] + **after** | **string**| A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. | [optional] + **include** | [**List<string>**](string.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] + **dateCreated** | [**Dictionary<string, string>**](string.md)| Filter by date created. | [optional] + **metadata** | [**Dictionary<string, string>**](string.md)| Filter by metadata key-value pair`. | [optional] + +### Return type + +[**AddressList**](AddressList.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A dictionary with a data property that contains an array of up to `limit` addresses. | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/BankAccount.md b/docs/BankAccount.md new file mode 100644 index 0000000..81b963a --- /dev/null +++ b/docs/BankAccount.md @@ -0,0 +1,23 @@ +# lob.dotnet.Model.BankAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**RoutingNumber** | **string** | Must be a [valid US routing number](https://www.frbservices.org/index.html). | [optional] +**AccountNumber** | **string** | | [optional] +**AccountType** | **string** | The type of entity that holds the account. | [optional] +**Signatory** | **string** | The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the [Dashboard](https://dashboard.lob.com/#/login). | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**Id** | **string** | Unique identifier prefixed with `bank_`. | [optional] +**SignatureUrl** | **string** | A signed link to the signature image. will be generated. | [optional] +**BankName** | **string** | The name of the bank based on the provided routing number, e.g. `JPMORGAN CHASE BANK`. | [optional] +**Verified** | **bool** | A bank account must be verified before a check can be created. | [optional] [default to false] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**DateModified** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | | [optional] [default to ObjectEnum.BankAccount] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BankAccountDeletion.md b/docs/BankAccountDeletion.md new file mode 100644 index 0000000..8ab9c18 --- /dev/null +++ b/docs/BankAccountDeletion.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.BankAccountDeletion +Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `bank_`. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | Value is type of resource. | [optional] [default to ObjectEnum.BankAccountDeleted] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BankAccountList.md b/docs/BankAccountList.md new file mode 100644 index 0000000..7eaa4f4 --- /dev/null +++ b/docs/BankAccountList.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.BankAccountList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**List<BankAccount>**](BankAccount.md) | list of addresses | [optional] +**Object** | **string** | Value is type of resource. | [optional] +**NextUrl** | **string** | url of next page of items in list. | [optional] +**PreviousUrl** | **string** | url of previous page of items in list. | [optional] +**Count** | **int** | number of resources in a set | [optional] +**TotalCount** | **int** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BankAccountVerify.md b/docs/BankAccountVerify.md new file mode 100644 index 0000000..0b93375 --- /dev/null +++ b/docs/BankAccountVerify.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.BankAccountVerify + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Amounts** | **List<int>** | In live mode, an array containing the two micro deposits (in cents) placed in the bank account. In test mode, no micro deposits will be placed, so any two integers between `1` and `100` will work. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BankAccountWritable.md b/docs/BankAccountWritable.md new file mode 100644 index 0000000..4da4ab1 --- /dev/null +++ b/docs/BankAccountWritable.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.BankAccountWritable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**RoutingNumber** | **string** | Must be a [valid US routing number](https://www.frbservices.org/index.html). | [optional] +**AccountNumber** | **string** | | [optional] +**AccountType** | [**BankTypeEnum**](BankTypeEnum.md) | | [optional] +**Signatory** | **string** | The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the [Dashboard](https://dashboard.lob.com/#/login). | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BankAccountsApi.md b/docs/BankAccountsApi.md new file mode 100644 index 0000000..fd0ce17 --- /dev/null +++ b/docs/BankAccountsApi.md @@ -0,0 +1,405 @@ +# lob.dotnet.Api.BankAccountsApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**BankAccountCreate**](BankAccountsApi.md#bankaccountcreate) | **POST** /bank_accounts | create +[**BankAccountDelete**](BankAccountsApi.md#bankaccountdelete) | **DELETE** /bank_accounts/{bank_id} | delete +[**BankAccountRetrieve**](BankAccountsApi.md#bankaccountretrieve) | **GET** /bank_accounts/{bank_id} | get +[**BankAccountVerify**](BankAccountsApi.md#bankaccountverify) | **POST** /bank_accounts/{bank_id}/verify | verify +[**BankAccountsList**](BankAccountsApi.md#bankaccountslist) | **GET** /bank_accounts | list + + + +# **BankAccountCreate** +> BankAccount BankAccountCreate (BankAccountWritable bankAccountWritable) + +create + +Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description \"VERIFICATION\". + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class BankAccountCreateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new BankAccountsApi(config); + var bankAccountWritable = new BankAccountWritable(); // BankAccountWritable | + + try + { + // create + BankAccount result = apiInstance.BankAccountCreate(bankAccountWritable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling BankAccountsApi.BankAccountCreate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bankAccountWritable** | [**BankAccountWritable**](BankAccountWritable.md)| | + +### Return type + +[**BankAccount**](BankAccount.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a bank_account object | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **BankAccountDelete** +> BankAccountDeletion BankAccountDelete (string bankId) + +delete + +Permanently deletes a bank account. It cannot be undone. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class BankAccountDeleteExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new BankAccountsApi(config); + var bankId = bankId_example; // string | id of the bank account + + try + { + // delete + BankAccountDeletion result = apiInstance.BankAccountDelete(bankId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling BankAccountsApi.BankAccountDelete: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bankId** | **string**| id of the bank account | + +### Return type + +[**BankAccountDeletion**](BankAccountDeletion.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Deleted | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **BankAccountRetrieve** +> BankAccount BankAccountRetrieve (string bankId) + +get + +Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class BankAccountRetrieveExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new BankAccountsApi(config); + var bankId = bankId_example; // string | id of the bank account + + try + { + // get + BankAccount result = apiInstance.BankAccountRetrieve(bankId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling BankAccountsApi.BankAccountRetrieve: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bankId** | **string**| id of the bank account | + +### Return type + +[**BankAccount**](BankAccount.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a bank account object | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **BankAccountVerify** +> BankAccount BankAccountVerify (string bankId, BankAccountVerify bankAccountVerify) + +verify + +Verify a bank account in order to create a check. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class BankAccountVerifyExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new BankAccountsApi(config); + var bankId = bankId_example; // string | id of the bank account to be verified + var bankAccountVerify = new BankAccountVerify(); // BankAccountVerify | + + try + { + // verify + BankAccount result = apiInstance.BankAccountVerify(bankId, bankAccountVerify); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling BankAccountsApi.BankAccountVerify: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bankId** | **string**| id of the bank account to be verified | + **bankAccountVerify** | [**BankAccountVerify**](BankAccountVerify.md)| | + +### Return type + +[**BankAccount**](BankAccount.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a bank_account object | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **BankAccountsList** +> BankAccountList BankAccountsList (int? limit = null, string before = null, string after = null, List include = null, Dictionary dateCreated = null, Dictionary metadata = null) + +list + +Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class BankAccountsListExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new BankAccountsApi(config); + var limit = 56; // int? | How many results to return. (optional) (default to 10) + var before = before_example; // string | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + var after = after_example; // string | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + var include = new List(); // List | Request that the response include the total count by specifying `include[]=total_count`. (optional) + var dateCreated = new Dictionary(); // Dictionary | Filter by date created. (optional) + var metadata = new Dictionary(); // Dictionary | Filter by metadata key-value pair`. (optional) + + try + { + // list + BankAccountList result = apiInstance.BankAccountsList(limit, before, after, include, dateCreated, metadata); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling BankAccountsApi.BankAccountsList: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int?**| How many results to return. | [optional] [default to 10] + **before** | **string**| A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. | [optional] + **after** | **string**| A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. | [optional] + **include** | [**List<string>**](string.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] + **dateCreated** | [**Dictionary<string, string>**](string.md)| Filter by date created. | [optional] + **metadata** | [**Dictionary<string, string>**](string.md)| Filter by metadata key-value pair`. | [optional] + +### Return type + +[**BankAccountList**](BankAccountList.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A dictionary with a data property that contains an array of up to `limit` bank_accounts. | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/BankTypeEnum.md b/docs/BankTypeEnum.md new file mode 100644 index 0000000..543e837 --- /dev/null +++ b/docs/BankTypeEnum.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.BankTypeEnum +The type of entity that holds the account. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BillingGroup.md b/docs/BillingGroup.md new file mode 100644 index 0000000..1cb0e8e --- /dev/null +++ b/docs/BillingGroup.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.BillingGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **string** | Description of the billing group. | [optional] +**Name** | **string** | Name of the billing group. | [optional] +**Id** | **string** | Unique identifier prefixed with `bg_`. | [optional] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**DateModified** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] +**Object** | **string** | Value is resource type. | [optional] [default to ObjectEnum.BillingGroup] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BillingGroupEditable.md b/docs/BillingGroupEditable.md new file mode 100644 index 0000000..792f8e3 --- /dev/null +++ b/docs/BillingGroupEditable.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.BillingGroupEditable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **string** | Description of the billing group. | [optional] +**Name** | **string** | Name of the billing group. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BillingGroupList.md b/docs/BillingGroupList.md new file mode 100644 index 0000000..72f7d69 --- /dev/null +++ b/docs/BillingGroupList.md @@ -0,0 +1,14 @@ +# lob.dotnet.Model.BillingGroupList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**List<BillingGroup>**](BillingGroup.md) | list of billing groups | [optional] +**Object** | **string** | Value is type of resource. | [optional] +**NextUrl** | **string** | url of next page of items in list. | [optional] +**PreviousUrl** | **string** | url of previous page of items in list. | [optional] +**Count** | **int** | number of resources in a set | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BillingGroupsApi.md b/docs/BillingGroupsApi.md new file mode 100644 index 0000000..d1307d7 --- /dev/null +++ b/docs/BillingGroupsApi.md @@ -0,0 +1,328 @@ +# lob.dotnet.Api.BillingGroupsApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**BillingGroupCreate**](BillingGroupsApi.md#billinggroupcreate) | **POST** /billing_groups | create +[**BillingGroupRetrieve**](BillingGroupsApi.md#billinggroupretrieve) | **GET** /billing_groups/{bg_id} | get +[**BillingGroupUpdate**](BillingGroupsApi.md#billinggroupupdate) | **POST** /billing_groups/{bg_id} | update +[**BillingGroupsList**](BillingGroupsApi.md#billinggroupslist) | **GET** /billing_groups | list + + + +# **BillingGroupCreate** +> BillingGroup BillingGroupCreate (BillingGroupEditable billingGroupEditable) + +create + +Creates a new billing_group with the provided properties. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class BillingGroupCreateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new BillingGroupsApi(config); + var billingGroupEditable = new BillingGroupEditable(); // BillingGroupEditable | + + try + { + // create + BillingGroup result = apiInstance.BillingGroupCreate(billingGroupEditable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling BillingGroupsApi.BillingGroupCreate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **billingGroupEditable** | [**BillingGroupEditable**](BillingGroupEditable.md)| | + +### Return type + +[**BillingGroup**](BillingGroup.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a billing group object | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **BillingGroupRetrieve** +> BillingGroup BillingGroupRetrieve (string bgId) + +get + +Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group creation. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class BillingGroupRetrieveExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new BillingGroupsApi(config); + var bgId = bgId_example; // string | id of the billing_group + + try + { + // get + BillingGroup result = apiInstance.BillingGroupRetrieve(bgId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling BillingGroupsApi.BillingGroupRetrieve: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bgId** | **string**| id of the billing_group | + +### Return type + +[**BillingGroup**](BillingGroup.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a billing_group object. | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **BillingGroupUpdate** +> BillingGroup BillingGroupUpdate (string bgId, BillingGroupEditable billingGroupEditable) + +update + +Updates all editable attributes of the billing_group with the given id. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class BillingGroupUpdateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new BillingGroupsApi(config); + var bgId = bgId_example; // string | id of the billing_group + var billingGroupEditable = new BillingGroupEditable(); // BillingGroupEditable | + + try + { + // update + BillingGroup result = apiInstance.BillingGroupUpdate(bgId, billingGroupEditable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling BillingGroupsApi.BillingGroupUpdate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **bgId** | **string**| id of the billing_group | + **billingGroupEditable** | [**BillingGroupEditable**](BillingGroupEditable.md)| | + +### Return type + +[**BillingGroup**](BillingGroup.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a billing group object | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **BillingGroupsList** +> BillingGroupList BillingGroupsList (int? limit = null, int? offset = null, List include = null, Dictionary dateCreated = null, Dictionary dateModified = null, SortBy5 sortBy = null) + +list + +Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups appearing first. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class BillingGroupsListExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new BillingGroupsApi(config); + var limit = 56; // int? | How many results to return. (optional) (default to 10) + var offset = 56; // int? | An integer that designates the offset at which to begin returning results. Defaults to 0. (optional) (default to 0) + var include = new List(); // List | Request that the response include the total count by specifying `include[]=total_count`. (optional) + var dateCreated = new Dictionary(); // Dictionary | Filter by date created. (optional) + var dateModified = new Dictionary(); // Dictionary | Filter by date modified. (optional) + var sortBy = new SortBy5(); // SortBy5 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + + try + { + // list + BillingGroupList result = apiInstance.BillingGroupsList(limit, offset, include, dateCreated, dateModified, sortBy); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling BillingGroupsApi.BillingGroupsList: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int?**| How many results to return. | [optional] [default to 10] + **offset** | **int?**| An integer that designates the offset at which to begin returning results. Defaults to 0. | [optional] [default to 0] + **include** | [**List<string>**](string.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] + **dateCreated** | [**Dictionary<string, string>**](string.md)| Filter by date created. | [optional] + **dateModified** | [**Dictionary<string, string>**](string.md)| Filter by date modified. | [optional] + **sortBy** | [**SortBy5**](SortBy5.md)| Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. | [optional] + +### Return type + +[**BillingGroupList**](BillingGroupList.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a list of billing_groups. | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/BulkError.md b/docs/BulkError.md new file mode 100644 index 0000000..58c0bbe --- /dev/null +++ b/docs/BulkError.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.BulkError +Lob uses RESTful HTTP response codes to indicate success or failure of an API request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Error** | [**BulkErrorProperties**](BulkErrorProperties.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/BulkErrorProperties.md b/docs/BulkErrorProperties.md new file mode 100644 index 0000000..1cb4203 --- /dev/null +++ b/docs/BulkErrorProperties.md @@ -0,0 +1,12 @@ +# lob.dotnet.Model.BulkErrorProperties +Bulk error properties + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **string** | A human-readable message with more details about the error | [optional] +**StatusCode** | **int** | A conventional HTTP status code. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Card.md b/docs/Card.md new file mode 100644 index 0000000..28af1ee --- /dev/null +++ b/docs/Card.md @@ -0,0 +1,28 @@ +# lob.dotnet.Model.Card + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `card_`. | [optional] +**Url** | **string** | The signed link for the card. | [optional] +**AutoReorder** | **bool** | True if the cards should be auto-reordered. | [optional] [default to false] +**ReorderQuantity** | **int?** | The number of cards to be reordered. | [optional] +**RawUrl** | **string** | The raw URL of the card. | [optional] +**FrontOriginalUrl** | **string** | The original URL of the front template. | [optional] +**BackOriginalUrl** | **string** | The original URL of the back template. | [optional] +**Thumbnails** | [**List<Thumbnail>**](Thumbnail.md) | | [optional] +**AvailableQuantity** | **int** | The available quantity of cards. | [optional] [default to 0] +**PendingQuantity** | **int** | The pending quantity of cards. | [optional] [default to 0] +**Status** | **string** | | [optional] +**Orientation** | **string** | The orientation of the card. | [optional] [default to OrientationEnum.Horizontal] +**ThresholdAmount** | **int** | The threshold amount of the card | [optional] [default to 0] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**DateModified** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | object | [optional] [default to ObjectEnum.Card] +**Description** | **string** | Description of the card. | [optional] +**Size** | **string** | The size of the card | [optional] [default to SizeEnum._2125x3375] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CardDeletion.md b/docs/CardDeletion.md new file mode 100644 index 0000000..09633b1 --- /dev/null +++ b/docs/CardDeletion.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.CardDeletion +Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `card_`. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | Value is type of resource. | [optional] [default to ObjectEnum.CardDeleted] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CardEditable.md b/docs/CardEditable.md new file mode 100644 index 0000000..82b0890 --- /dev/null +++ b/docs/CardEditable.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.CardEditable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Front** | **string** | A PDF template for the front of the card | [optional] +**Back** | **string** | A PDF template for the back of the card | [optional] [default to "https://s3.us-west-2.amazonaws.com/public.lob.com/assets/card_blank_horizontal.pdf"] +**Size** | **string** | The size of the card | [optional] [default to SizeEnum._2125x3375] +**Description** | **string** | Description of the card. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CardList.md b/docs/CardList.md new file mode 100644 index 0000000..94a5334 --- /dev/null +++ b/docs/CardList.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.CardList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**List<Card>**](Card.md) | list of cards | [optional] +**Object** | **string** | Value is type of resource. | [optional] +**NextUrl** | **string** | url of next page of items in list. | [optional] +**PreviousUrl** | **string** | url of previous page of items in list. | [optional] +**Count** | **int** | number of resources in a set | [optional] +**TotalCount** | **int** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CardOrder.md b/docs/CardOrder.md new file mode 100644 index 0000000..2dd7cbf --- /dev/null +++ b/docs/CardOrder.md @@ -0,0 +1,22 @@ +# lob.dotnet.Model.CardOrder + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `co_`. | [optional] +**CardId** | **string** | Unique identifier prefixed with `card_`. | [optional] +**Status** | **string** | The status of the card order. | [optional] +**Inventory** | **decimal** | The inventory of the card order. | [optional] [default to 0M] +**QuantityOrdered** | **decimal** | The quantity of cards ordered | [optional] [default to 0M] +**UnitPrice** | **decimal** | The unit price for the card order. | [optional] [default to 0M] +**CancelledReason** | **string** | The reason for cancellation. | [optional] +**AvailabilityDate** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**ExpectedAvailabilityDate** | **DateTime** | The fixed deadline for the cards to be printed. | [optional] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**DateModified** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | Value is type of resource. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CardOrderEditable.md b/docs/CardOrderEditable.md new file mode 100644 index 0000000..85e697d --- /dev/null +++ b/docs/CardOrderEditable.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.CardOrderEditable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Quantity** | **int** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CardOrderList.md b/docs/CardOrderList.md new file mode 100644 index 0000000..7eed923 --- /dev/null +++ b/docs/CardOrderList.md @@ -0,0 +1,14 @@ +# lob.dotnet.Model.CardOrderList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**List<CardOrder>**](CardOrder.md) | list of card orders | [optional] +**Object** | **string** | Value is type of resource. | [optional] +**NextUrl** | **string** | url of next page of items in list. | [optional] +**PreviousUrl** | **string** | url of previous page of items in list. | [optional] +**Count** | **int** | number of resources in a set | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CardOrdersApi.md b/docs/CardOrdersApi.md new file mode 100644 index 0000000..fdf22fd --- /dev/null +++ b/docs/CardOrdersApi.md @@ -0,0 +1,168 @@ +# lob.dotnet.Api.CardOrdersApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CardOrderCreate**](CardOrdersApi.md#cardordercreate) | **POST** /cards/{card_id}/orders | create +[**CardOrdersRetrieve**](CardOrdersApi.md#cardordersretrieve) | **GET** /cards/{card_id}/orders | get + + + +# **CardOrderCreate** +> CardOrder CardOrderCreate (string cardId, CardOrderEditable cardOrderEditable) + +create + +Creates a new card order given information + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class CardOrderCreateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new CardOrdersApi(config); + var cardId = cardId_example; // string | The ID of the card to which the card orders belong. + var cardOrderEditable = new CardOrderEditable(); // CardOrderEditable | + + try + { + // create + CardOrder result = apiInstance.CardOrderCreate(cardId, cardOrderEditable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling CardOrdersApi.CardOrderCreate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cardId** | **string**| The ID of the card to which the card orders belong. | + **cardOrderEditable** | [**CardOrderEditable**](CardOrderEditable.md)| | + +### Return type + +[**CardOrder**](CardOrder.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Card order created successfully | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **CardOrdersRetrieve** +> CardOrderList CardOrdersRetrieve (string cardId, int? limit = null, int? offset = null) + +get + +Retrieves the card orders associated with the given card id. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class CardOrdersRetrieveExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new CardOrdersApi(config); + var cardId = cardId_example; // string | The ID of the card to which the card orders belong. + var limit = 56; // int? | How many results to return. (optional) (default to 10) + var offset = 56; // int? | An integer that designates the offset at which to begin returning results. Defaults to 0. (optional) (default to 0) + + try + { + // get + CardOrderList result = apiInstance.CardOrdersRetrieve(cardId, limit, offset); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling CardOrdersApi.CardOrdersRetrieve: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cardId** | **string**| The ID of the card to which the card orders belong. | + **limit** | **int?**| How many results to return. | [optional] [default to 10] + **offset** | **int?**| An integer that designates the offset at which to begin returning results. Defaults to 0. | [optional] [default to 0] + +### Return type + +[**CardOrderList**](CardOrderList.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns the card orders associated with the given card id | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/CardUpdatable.md b/docs/CardUpdatable.md new file mode 100644 index 0000000..adfd982 --- /dev/null +++ b/docs/CardUpdatable.md @@ -0,0 +1,12 @@ +# lob.dotnet.Model.CardUpdatable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **string** | Description of the card. | [optional] +**AutoReorder** | **bool** | Allows for auto reordering | [optional] +**ReorderQuantity** | **decimal** | The quantity of items to be reordered (only required when auto_reorder is true). | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CardsApi.md b/docs/CardsApi.md new file mode 100644 index 0000000..935e33f --- /dev/null +++ b/docs/CardsApi.md @@ -0,0 +1,401 @@ +# lob.dotnet.Api.CardsApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CardCreate**](CardsApi.md#cardcreate) | **POST** /cards | create +[**CardDelete**](CardsApi.md#carddelete) | **DELETE** /cards/{card_id} | delete +[**CardRetrieve**](CardsApi.md#cardretrieve) | **GET** /cards/{card_id} | get +[**CardUpdate**](CardsApi.md#cardupdate) | **POST** /cards/{card_id} | update +[**CardsList**](CardsApi.md#cardslist) | **GET** /cards | list + + + +# **CardCreate** +> Card CardCreate (CardEditable cardEditable) + +create + +Creates a new card given information + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class CardCreateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new CardsApi(config); + var cardEditable = new CardEditable(); // CardEditable | + + try + { + // create + Card result = apiInstance.CardCreate(cardEditable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling CardsApi.CardCreate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cardEditable** | [**CardEditable**](CardEditable.md)| | + +### Return type + +[**Card**](Card.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Card created successfully | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **CardDelete** +> CardDeletion CardDelete (string cardId) + +delete + +Delete an existing card. You need only supply the unique identifier that was returned upon card creation. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class CardDeleteExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new CardsApi(config); + var cardId = cardId_example; // string | id of the card + + try + { + // delete + CardDeletion result = apiInstance.CardDelete(cardId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling CardsApi.CardDelete: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cardId** | **string**| id of the card | + +### Return type + +[**CardDeletion**](CardDeletion.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Deleted the card | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **CardRetrieve** +> Card CardRetrieve (string cardId) + +get + +Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card creation. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class CardRetrieveExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new CardsApi(config); + var cardId = cardId_example; // string | id of the card + + try + { + // get + Card result = apiInstance.CardRetrieve(cardId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling CardsApi.CardRetrieve: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cardId** | **string**| id of the card | + +### Return type + +[**Card**](Card.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a card object | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **CardUpdate** +> Card CardUpdate (string cardId, CardUpdatable cardUpdatable) + +update + +Update the details of an existing card. You need only supply the unique identifier that was returned upon card creation. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class CardUpdateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new CardsApi(config); + var cardId = cardId_example; // string | id of the card + var cardUpdatable = new CardUpdatable(); // CardUpdatable | + + try + { + // update + Card result = apiInstance.CardUpdate(cardId, cardUpdatable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling CardsApi.CardUpdate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **cardId** | **string**| id of the card | + **cardUpdatable** | [**CardUpdatable**](CardUpdatable.md)| | + +### Return type + +[**Card**](Card.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a card object | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **CardsList** +> CardList CardsList (int? limit = null, string before = null, string after = null, SortBy5 sortBy = null) + +list + +Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class CardsListExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new CardsApi(config); + var limit = 56; // int? | How many results to return. (optional) (default to 10) + var before = before_example; // string | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + var after = after_example; // string | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + var sortBy = new SortBy5(); // SortBy5 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + + try + { + // list + CardList result = apiInstance.CardsList(limit, before, after, sortBy); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling CardsApi.CardsList: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int?**| How many results to return. | [optional] [default to 10] + **before** | **string**| A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. | [optional] + **after** | **string**| A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. | [optional] + **sortBy** | [**SortBy5**](SortBy5.md)| Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. | [optional] + +### Return type + +[**CardList**](CardList.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a list of card objects | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Check.md b/docs/Check.md new file mode 100644 index 0000000..2f08d82 --- /dev/null +++ b/docs/Check.md @@ -0,0 +1,35 @@ +# lob.dotnet.Model.Check + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `chk_`. | [optional] +**To** | [**Address**](Address.md) | | [optional] +**From** | [**Address**](Address.md) | | [optional] +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**MergeVariables** | **Object** | You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. | [optional] +**SendDate** | **DateTime** | A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. | [optional] +**MailType** | **string** | Checks must be sent `usps_first_class` | [optional] [default to MailTypeEnum.UspsFirstClass] +**Memo** | **string** | Text to include on the memo line of the check. | [optional] +**CheckNumber** | **int** | An integer that designates the check number. If `check_number` is not provided, checks created from a new `bank_account` will start at `10000` and increment with each check created with the `bank_account`. A provided `check_number` overrides the defaults. Subsequent checks created with the same `bank_account` will increment from the provided check number. | [optional] +**Message** | **string** | Max of 400 characters to be included at the bottom of the check page. | [optional] +**Amount** | **float** | The payment amount to be sent in US dollars. | [optional] +**BankAccount** | [**BankAccount**](BankAccount.md) | | [optional] +**CheckBottomTemplateId** | **string** | Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). | [optional] +**AttachmentTemplateId** | **string** | Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). | [optional] +**CheckBottomTemplateVersionId** | **string** | Unique identifier prefixed with `vrsn_`. | [optional] +**AttachmentTemplateVersionId** | **string** | Unique identifier prefixed with `vrsn_`. | [optional] +**Url** | **string** | A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. | [optional] +**Carrier** | **string** | | [optional] [default to CarrierEnum.USPS] +**Thumbnails** | [**List<Thumbnail>**](Thumbnail.md) | | [optional] +**ExpectedDeliveryDate** | **DateTime** | A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`. | [optional] +**TrackingEvents** | [**List<TrackingEventNormal>**](TrackingEventNormal.md) | An array of tracking_event objects ordered by ascending `time`. Will not be populated for checks created in test mode. | [optional] +**Object** | **string** | | [optional] [default to ObjectEnum.Check] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**DateModified** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CheckDeletion.md b/docs/CheckDeletion.md new file mode 100644 index 0000000..d20ac61 --- /dev/null +++ b/docs/CheckDeletion.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.CheckDeletion +Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `chk_`. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | Value is type of resource. | [optional] [default to ObjectEnum.CheckDeleted] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CheckEditable.md b/docs/CheckEditable.md new file mode 100644 index 0000000..2653faa --- /dev/null +++ b/docs/CheckEditable.md @@ -0,0 +1,25 @@ +# lob.dotnet.Model.CheckEditable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**From** | **string** | Required if `to` address is international. Must either be an address ID or an inline object with correct address parameters. | [optional] +**To** | **string** | Required if `to` address is international. Must either be an address ID or an inline object with correct address parameters. | [optional] +**BankAccount** | **string** | | [optional] +**Amount** | **float** | The payment amount to be sent in US dollars. | [optional] +**Logo** | **Object** | Accepts a remote URL or local file upload to an image to print (in grayscale) in the upper-left corner of your check. | [optional] +**CheckBottom** | **string** | The artwork to use on the bottom of the check page. Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs must be sized at 8.5\"x11\" at 300 DPI, while supplied HTML will be rendered and trimmed to fit on a 8.5\"x11\" page. - The check bottom will always be printed in black & white. - Must conform to [this template](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/check_bottom_template.pdf). Need more help? Consult our [HTML examples](#section/HTML-Examples). | [optional] +**Attachment** | **string** | A document to include with the check. | [optional] +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**MergeVariables** | **Object** | You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. | [optional] +**SendDate** | **DateTime** | A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. | [optional] +**MailType** | **string** | Checks must be sent `usps_first_class` | [optional] [default to MailTypeEnum.UspsFirstClass] +**Memo** | **string** | Text to include on the memo line of the check. | [optional] +**CheckNumber** | **int** | An integer that designates the check number. | [optional] +**Message** | **string** | Max of 400 characters to be included at the bottom of the check page. | [optional] +**BillingGroupId** | **string** | An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CheckList.md b/docs/CheckList.md new file mode 100644 index 0000000..eef1696 --- /dev/null +++ b/docs/CheckList.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.CheckList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**List<Check>**](Check.md) | list of checks | [optional] +**Object** | **string** | Value is type of resource. | [optional] +**NextUrl** | **string** | url of next page of items in list. | [optional] +**PreviousUrl** | **string** | url of previous page of items in list. | [optional] +**Count** | **int** | number of resources in a set | [optional] +**TotalCount** | **int** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ChecksApi.md b/docs/ChecksApi.md new file mode 100644 index 0000000..8d72ad4 --- /dev/null +++ b/docs/ChecksApi.md @@ -0,0 +1,336 @@ +# lob.dotnet.Api.ChecksApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CheckCancel**](ChecksApi.md#checkcancel) | **DELETE** /checks/{chk_id} | cancel +[**CheckCreate**](ChecksApi.md#checkcreate) | **POST** /checks | create +[**CheckRetrieve**](ChecksApi.md#checkretrieve) | **GET** /checks/{chk_id} | get +[**ChecksList**](ChecksApi.md#checkslist) | **GET** /checks | list + + + +# **CheckCancel** +> CheckDeletion CheckCancel (string chkId) + +cancel + +Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class CheckCancelExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new ChecksApi(config); + var chkId = chkId_example; // string | id of the check + + try + { + // cancel + CheckDeletion result = apiInstance.CheckCancel(chkId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling ChecksApi.CheckCancel: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **chkId** | **string**| id of the check | + +### Return type + +[**CheckDeletion**](CheckDeletion.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Deleted | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **CheckCreate** +> Check CheckCreate (CheckEditable checkEditable, string idempotencyKey = null) + +create + +Creates a new check with the provided properties. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class CheckCreateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new ChecksApi(config); + var checkEditable = new CheckEditable(); // CheckEditable | + var idempotencyKey = idempotencyKey_example; // string | A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + + try + { + // create + Check result = apiInstance.CheckCreate(checkEditable, idempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling ChecksApi.CheckCreate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **checkEditable** | [**CheckEditable**](CheckEditable.md)| | + **idempotencyKey** | **string**| A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). | [optional] + +### Return type + +[**Check**](Check.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a check object | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **CheckRetrieve** +> Check CheckRetrieve (string chkId) + +get + +Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class CheckRetrieveExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new ChecksApi(config); + var chkId = chkId_example; // string | id of the check + + try + { + // get + Check result = apiInstance.CheckRetrieve(chkId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling ChecksApi.CheckRetrieve: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **chkId** | **string**| id of the check | + +### Return type + +[**Check**](Check.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a check object | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **ChecksList** +> CheckList ChecksList (int? limit = null, string before = null, string after = null, List include = null, Dictionary dateCreated = null, Dictionary metadata = null, bool? scheduled = null, Dictionary sendDate = null, MailType? mailType = null, SortBy5 sortBy = null) + +list + +Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class ChecksListExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new ChecksApi(config); + var limit = 56; // int? | How many results to return. (optional) (default to 10) + var before = before_example; // string | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + var after = after_example; // string | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + var include = new List(); // List | Request that the response include the total count by specifying `include[]=total_count`. (optional) + var dateCreated = new Dictionary(); // Dictionary | Filter by date created. (optional) + var metadata = new Dictionary(); // Dictionary | Filter by metadata key-value pair`. (optional) + var scheduled = true; // bool? | * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + var sendDate = new Dictionary(); // Dictionary | Filter by date sent. (optional) + var mailType = ; // MailType? | A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + var sortBy = new SortBy5(); // SortBy5 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + + try + { + // list + CheckList result = apiInstance.ChecksList(limit, before, after, include, dateCreated, metadata, scheduled, sendDate, mailType, sortBy); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling ChecksApi.ChecksList: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int?**| How many results to return. | [optional] [default to 10] + **before** | **string**| A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. | [optional] + **after** | **string**| A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. | [optional] + **include** | [**List<string>**](string.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] + **dateCreated** | [**Dictionary<string, string>**](string.md)| Filter by date created. | [optional] + **metadata** | [**Dictionary<string, string>**](string.md)| Filter by metadata key-value pair`. | [optional] + **scheduled** | **bool?**| * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` | [optional] + **sendDate** | [**Dictionary<string, string>**](string.md)| Filter by date sent. | [optional] + **mailType** | **MailType?**| A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. | [optional] + **sortBy** | [**SortBy5**](SortBy5.md)| Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. | [optional] + +### Return type + +[**CheckList**](CheckList.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A dictionary with a data property that contains an array of up to `limit` checks. | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/CountryExtended.md b/docs/CountryExtended.md new file mode 100644 index 0000000..267e86f --- /dev/null +++ b/docs/CountryExtended.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.CountryExtended +Must be a 2 letter country short-name code (ISO 3166). + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/CountryExtendedExpanded.md b/docs/CountryExtendedExpanded.md new file mode 100644 index 0000000..01874b5 --- /dev/null +++ b/docs/CountryExtendedExpanded.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.CountryExtendedExpanded +Full name of country + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/DeliverabilityAnalysis.md b/docs/DeliverabilityAnalysis.md new file mode 100644 index 0000000..e9b89c6 --- /dev/null +++ b/docs/DeliverabilityAnalysis.md @@ -0,0 +1,19 @@ +# lob.dotnet.Model.DeliverabilityAnalysis +A nested object containing a breakdown of the deliverability of an address. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DpvConfirmation** | **string** | Result of Delivery Point Validation (DPV), which determines whether or not the address is deliverable by the USPS. Possible values are: * `Y` –– The address is deliverable by the USPS. * `S` –– The address is deliverable by removing the provided secondary unit designator. This information may be incorrect or unnecessary. * `D` –– The address is deliverable to the building's default address but is missing a secondary unit designator and/or number. There is a chance the mail will not reach the intended recipient. * `N` –– The address is not deliverable according to the USPS, but parts of the address are valid (such as the street and ZIP code). * `''` –– This address is not deliverable. No matching street could be found within the city or ZIP code. | [optional] +**DpvCmra** | **string** | indicates whether or not the address is [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency). Possible values are: * `Y` –– Address is CMRA-authorized. * `N` –– Address is not CMRA-authorized. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). | [optional] +**DpvVacant** | **string** | indicates that an address was once deliverable, but has become vacant and is no longer receiving deliveries. Possible values are: * `Y` –– Address is vacant. * `N` –– Address is not vacant. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). | [optional] +**DpvActive** | **string** | Corresponds to the USPS field `dpv_no_stat`. Indicates that an address has been vacated in the recent past, and is no longer receiving deliveries. If it's been unoccupied for 90+ days, or temporarily vacant, this will be flagged. Possible values are: * `Y` –– Address is active. * `N` –– Address is not active. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). | [optional] +**DpvFootnotes** | [**List<DpvFootnote>**](DpvFootnote.md) | An array of 2-character strings that gives more insight into how `deliverability_analysis[dpv_confirmation]` was determined. Will always include at least 1 string, and can include up to 3. For details, see [US Verification Details](#tag/US-Verification-Types). | [optional] +**EwsMatch** | **bool** | indicates whether or not an address has been flagged in the [Early Warning System](https://docs.informatica.com/data-engineering/data-engineering-quality/10-4-0/address-validator-port-reference/postal-carrier-certification-data-ports/early-warning-system-return-code.html), meaning the address is under development and not yet ready to receive mail. However, it should become available in a few months. | [optional] +**LacsIndicator** | **string** | indicates whether this address has been converted by [LACS<sup>Link</sup>](https://postalpro.usps.com/address-quality/lacslink). LACS<sup>Link</sup> corrects outdated addresses into their modern counterparts. Possible values are: * `Y` –– New address produced with a matching record in LACS<sup>Link</sup>. * `N` –– New address could not be produced with a matching record in LACS<sup>Link</sup>. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). | [optional] +**LacsReturnCode** | **string** | A code indicating how `deliverability_analysis[lacs_indicator]` was determined. Possible values are: * `A` — A new address was produced because a match was found in LACS<sup>Link</sup>. * `92` — A LACS<sup>Link</sup> record was matched after dropping secondary information. * `14` — A match was found in LACS<sup>Link</sup>, but could not be converted to a deliverable address. * `00` — A match was not found in LACS<sup>Link</sup>, and no new address was produced. * `''` — LACS<sup>Link</sup> was not attempted. | [optional] +**SuiteReturnCode** | **string** | A return code that indicates whether the address was matched and corrected by [Suite<sup>Link</sup>](https://postalpro.usps.com/address-quality-solutions/suitelink). Suite<sup>Link</sup> attempts to provide secondary information to business addresses. Possible values are: * `A` –– A Suite<sup>Link</sup> match was found and secondary information was added. * `00` –– A Suite<sup>Link</sup> match could not be found and no secondary information was added. * `''` –– Suite<sup>Link</sup> lookup was not attempted. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/DpvFootnote.md b/docs/DpvFootnote.md new file mode 100644 index 0000000..c2d9f13 --- /dev/null +++ b/docs/DpvFootnote.md @@ -0,0 +1,9 @@ +# lob.dotnet.Model.DpvFootnote + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EngineHtml.md b/docs/EngineHtml.md new file mode 100644 index 0000000..ca4645d --- /dev/null +++ b/docs/EngineHtml.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.EngineHtml +The engine used to combine HTML template with merge variables. * `legacy` - Lob's original engine * `handlebars` + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/EventType.md b/docs/EventType.md new file mode 100644 index 0000000..61ede9c --- /dev/null +++ b/docs/EventType.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.EventType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | | [optional] +**EnabledForTest** | **bool** | Value is `true` if the event type is enabled in both the test and live environments. | [optional] +**Resource** | **string** | | [optional] +**Object** | **string** | Value is resource type. | [optional] [default to ObjectEnum.EventType] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Events.md b/docs/Events.md new file mode 100644 index 0000000..e557ffe --- /dev/null +++ b/docs/Events.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.Events + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `evt_`. | [optional] +**Body** | **Object** | The body of the associated resource as they were at the time of the event, i.e. the [postcard object](#operation/postcard_retrieve), [the letter object](#operation/letter_retrieve), [the check object](#operation/check_retrieve), [the address object](#operation/address_retrieve), or [the bank account object](#operation/bank_account_retrieve). For `.deleted` events, the body matches the response for the corresponding delete endpoint for that resource (e.g. the [postcard delete response](#operation/postcard_delete)). | [optional] +**ReferenceId** | **string** | Unique identifier of the related resource for the event. | [optional] +**EventType** | [**EventType**](EventType.md) | | [optional] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**Object** | **string** | Value is resource type. | [optional] [default to ObjectEnum.Event] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/GeocodeAddresses.md b/docs/GeocodeAddresses.md new file mode 100644 index 0000000..1609174 --- /dev/null +++ b/docs/GeocodeAddresses.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.GeocodeAddresses + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Components** | [**GeocodeComponents**](GeocodeComponents.md) | | [optional] +**LocationAnalysis** | [**LocationAnalysis**](LocationAnalysis.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/GeocodeComponents.md b/docs/GeocodeComponents.md new file mode 100644 index 0000000..9958f18 --- /dev/null +++ b/docs/GeocodeComponents.md @@ -0,0 +1,12 @@ +# lob.dotnet.Model.GeocodeComponents +A nested object containing a breakdown of each component of a reverse geocoded response. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ZipCode** | **string** | The 5-digit ZIP code | [optional] +**ZipCodePlus4** | **string** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/IntlAutocompletions.md b/docs/IntlAutocompletions.md new file mode 100644 index 0000000..417b89c --- /dev/null +++ b/docs/IntlAutocompletions.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.IntlAutocompletions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `intl_auto_`. | [optional] +**Suggestions** | [**List<IntlSuggestions>**](IntlSuggestions.md) | An array of objects representing suggested addresses. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/IntlAutocompletionsApi.md b/docs/IntlAutocompletionsApi.md new file mode 100644 index 0000000..7da457a --- /dev/null +++ b/docs/IntlAutocompletionsApi.md @@ -0,0 +1,87 @@ +# lob.dotnet.Api.IntlAutocompletionsApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**IntlAutocompletion**](IntlAutocompletionsApi.md#intlautocompletion) | **POST** /intl_autocompletions | autocomplete + + + +# **IntlAutocompletion** +> IntlAutocompletions IntlAutocompletion (IntlAutocompletionsWritable intlAutocompletionsWritable, string xLangOutput = null) + +autocomplete + +Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/intl_verification). + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class IntlAutocompletionExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new IntlAutocompletionsApi(config); + var intlAutocompletionsWritable = new IntlAutocompletionsWritable(); // IntlAutocompletionsWritable | + var xLangOutput = xLangOutput_example; // string | * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + + try + { + // autocomplete + IntlAutocompletions result = apiInstance.IntlAutocompletion(intlAutocompletionsWritable, xLangOutput); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling IntlAutocompletionsApi.IntlAutocompletion: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **intlAutocompletionsWritable** | [**IntlAutocompletionsWritable**](IntlAutocompletionsWritable.md)| | + **xLangOutput** | **string**| * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. | [optional] + +### Return type + +[**IntlAutocompletions**](IntlAutocompletions.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns an international autocompletions object. | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/IntlAutocompletionsWritable.md b/docs/IntlAutocompletionsWritable.md new file mode 100644 index 0000000..c1f2e8e --- /dev/null +++ b/docs/IntlAutocompletionsWritable.md @@ -0,0 +1,14 @@ +# lob.dotnet.Model.IntlAutocompletionsWritable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressPrefix** | **string** | Only accepts numbers and street names in an alphanumeric format. | [optional] +**City** | **string** | An optional city input used to filter suggestions. Case insensitive and does not match partial abbreviations. | [optional] +**State** | **string** | An optional state input used to filter suggestions. Case insensitive and does not match partial abbreviations. | [optional] +**ZipCode** | **string** | An optional Zip Code input used to filter suggestions. Matches partial entries. | [optional] +**Country** | [**CountryExtended**](CountryExtended.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/IntlComponents.md b/docs/IntlComponents.md new file mode 100644 index 0000000..9295639 --- /dev/null +++ b/docs/IntlComponents.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.IntlComponents +A nested object containing a breakdown of each component of an address. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PrimaryNumber** | **string** | The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number. | [optional] +**StreetName** | **string** | The name of the street. | [optional] +**City** | **string** | | [optional] +**State** | **string** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. | [optional] +**PostalCode** | **string** | The postal code. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/IntlSuggestions.md b/docs/IntlSuggestions.md new file mode 100644 index 0000000..ca619a0 --- /dev/null +++ b/docs/IntlSuggestions.md @@ -0,0 +1,16 @@ +# lob.dotnet.Model.IntlSuggestions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PrimaryNumberRange** | **string** | The primary number range of the address that identifies a building at street level. | [optional] +**PrimaryLine** | **string** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` | [optional] +**City** | **string** | | [optional] +**State** | **string** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. | [optional] +**Country** | [**CountryExtended**](CountryExtended.md) | | [optional] +**ZipCode** | **string** | A 5-digit zip code. Left empty if a test key is used. | [optional] +**Object** | **string** | Value is resource type. | [optional] [default to ObjectEnum.IntlAutocompletion] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/IntlVerification.md b/docs/IntlVerification.md new file mode 100644 index 0000000..101588b --- /dev/null +++ b/docs/IntlVerification.md @@ -0,0 +1,20 @@ +# lob.dotnet.Model.IntlVerification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `intl_ver_`. | [optional] +**Recipient** | **string** | The intended recipient, typically a person's or firm's name. | [optional] +**PrimaryLine** | **string** | The primary delivery line (usually the street address) of the address. | [optional] +**SecondaryLine** | **string** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. | [optional] +**LastLine** | **string** | Combination of the following applicable `components`: * `city` * `state` * `zip_code` * `zip_code_plus_4` | [optional] +**Country** | **string** | The country of the address. Will be returned as a 2 letter country short-name code (ISO 3166). | [optional] +**Coverage** | **string** | The coverage level for the country. This represents the maximum level of accuracy an input address can be verified to. * `SUBBUILDING` - Coverage down to unit numbers. For example, in an apartment or a large building * `HOUSENUMBER/BUILDING` - Coverage down to house number. For example, the address where a house or building may be located * `STREET` - Coverage down to street. This means that we can verify that an street exists in a city, state, country * `LOCALITY` - Coverage down to city, state, or village or province. This means that we can verify that a city, village, province, or state exists in a country. Countries differ in how they define what is a province, state, city, village, etc. This attempts to group eveyrthing together. * `SPARSE` - Some addresses for this country exist in our databases | [optional] +**Deliverability** | **string** | Summarizes the deliverability of the `intl_verification` object. Possible values are: * `deliverable` — The address is deliverable. * `deliverable_missing_info` — The address is missing some information, but is most likely deliverable. * `undeliverable` — The address is most likely not deliverable. Some components of the address (such as city or postal code) may have been found. * `no_match` — This address is not deliverable. No matching street could be found within the city or postal code. | [optional] +**Status** | **string** | The status level for the country. This represents the maximum level of accuracy an input address can be verified to. * `LV4` - Verified. The input data is correct. All input data was able to match in databases. * `LV3` - Verified. The input data is correct. All input data was able to match in databases <em>after</em> some or all elements were standarized. The input data may also be using outdated city, state, or country names. * `LV2` - Verified. The input data is correct although some input data is unverifiable due to incomplete data. * `LV1` - Verified. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LF4` - Fixed. The input data is matched and fixed. (Example: Brighon, UK -> Brighton, UK) * `LF3` - Fixed. The input data is matched and fixed but some elements such as Subbuilding number and house number cannot be checked. * `LF2` - Fixed. The input data is matched but some elements such as Street cannot be checked. * `LF1` - Fixed. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LM4` - Missing Info. The input data cannot be corrected completely. * `LM3` - Missing Info. The input data cannot be corrected completely and there were multiple matches found in databases. * `LM2` - Missing Info. The input data cannot be corrected completely and only some elements were found. * `LU1` - Unverified. The input data cannot be corrected or matched. | [optional] +**Components** | [**IntlComponents**](IntlComponents.md) | | [optional] +**Object** | **string** | Value is resource type. | [optional] [default to ObjectEnum.IntlVerification] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/IntlVerificationOrError.md b/docs/IntlVerificationOrError.md new file mode 100644 index 0000000..4542317 --- /dev/null +++ b/docs/IntlVerificationOrError.md @@ -0,0 +1,22 @@ +# lob.dotnet.Model.IntlVerificationOrError +A model used to represent an entry in a result list where the entry can either be a intl_verification or an Error. The SDK will perform necessary casting into the correct corresponding type. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `intl_ver_`. | [optional] +**Recipient** | **string** | The intended recipient, typically a person's or firm's name. | [optional] +**PrimaryLine** | **string** | | [optional] +**SecondaryLine** | **string** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. | [optional] +**LastLine** | **string** | | [optional] +**Country** | **string** | | [optional] +**Coverage** | **string** | | [optional] +**Deliverability** | **string** | | [optional] +**Status** | **string** | | [optional] +**Components** | [**IntlComponents**](IntlComponents.md) | | [optional] +**Object** | **string** | | [optional] [default to ObjectEnum.IntlVerification] +**Error** | [**BulkError**](BulkError.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/IntlVerificationWritable.md b/docs/IntlVerificationWritable.md new file mode 100644 index 0000000..2c341e2 --- /dev/null +++ b/docs/IntlVerificationWritable.md @@ -0,0 +1,17 @@ +# lob.dotnet.Model.IntlVerificationWritable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Recipient** | **string** | The intended recipient, typically a person's or firm's name. | [optional] +**PrimaryLine** | **string** | The primary delivery line (usually the street address) of the address. | [optional] +**SecondaryLine** | **string** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. | [optional] +**City** | **string** | | [optional] +**State** | **string** | The name of the state. | [optional] +**PostalCode** | **string** | The postal code. | [optional] +**Country** | [**CountryExtended**](CountryExtended.md) | | [optional] +**Address** | **string** | The entire address in one string (e.g., \"370 Water St C1N 1C4\"). | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/IntlVerifications.md b/docs/IntlVerifications.md new file mode 100644 index 0000000..6cf6246 --- /dev/null +++ b/docs/IntlVerifications.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.IntlVerifications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Addresses** | [**List<IntlVerificationOrError>**](IntlVerificationOrError.md) | | [optional] +**Errors** | **bool** | Indicates whether any errors occurred during the verification process. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/IntlVerificationsApi.md b/docs/IntlVerificationsApi.md new file mode 100644 index 0000000..042627d --- /dev/null +++ b/docs/IntlVerificationsApi.md @@ -0,0 +1,164 @@ +# lob.dotnet.Api.IntlVerificationsApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**BulkIntlVerifications**](IntlVerificationsApi.md#bulkintlverifications) | **POST** /bulk/intl_verifications | verifyBulk +[**IntlVerification**](IntlVerificationsApi.md#intlverification) | **POST** /intl_verifications | verifySingle + + + +# **BulkIntlVerifications** +> IntlVerifications BulkIntlVerifications (IntlVerificationsPayload intlVerificationsPayload) + +verifyBulk + +Verify a list of international (except US or US territories) address with a live API key. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class BulkIntlVerificationsExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new IntlVerificationsApi(config); + var intlVerificationsPayload = new IntlVerificationsPayload(); // IntlVerificationsPayload | + + try + { + // verifyBulk + IntlVerifications result = apiInstance.BulkIntlVerifications(intlVerificationsPayload); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling IntlVerificationsApi.BulkIntlVerifications: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **intlVerificationsPayload** | [**IntlVerificationsPayload**](IntlVerificationsPayload.md)| | + +### Return type + +[**IntlVerifications**](IntlVerifications.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns an array of international verification objects. | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **IntlVerification** +> IntlVerification IntlVerification (IntlVerificationWritable intlVerificationWritable, string xLangOutput = null) + +verifySingle + +Verify an international (except US or US territories) address with a live API key. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class IntlVerificationExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new IntlVerificationsApi(config); + var intlVerificationWritable = new IntlVerificationWritable(); // IntlVerificationWritable | + var xLangOutput = xLangOutput_example; // string | * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + + try + { + // verifySingle + IntlVerification result = apiInstance.IntlVerification(intlVerificationWritable, xLangOutput); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling IntlVerificationsApi.IntlVerification: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **intlVerificationWritable** | [**IntlVerificationWritable**](IntlVerificationWritable.md)| | + **xLangOutput** | **string**| * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. | [optional] + +### Return type + +[**IntlVerification**](IntlVerification.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns an international verification object. | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/IntlVerificationsPayload.md b/docs/IntlVerificationsPayload.md new file mode 100644 index 0000000..5cccfd7 --- /dev/null +++ b/docs/IntlVerificationsPayload.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.IntlVerificationsPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Addresses** | [**List<MultipleComponentsIntl>**](MultipleComponentsIntl.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Letter.md b/docs/Letter.md new file mode 100644 index 0000000..29f8c9e --- /dev/null +++ b/docs/Letter.md @@ -0,0 +1,36 @@ +# lob.dotnet.Model.Letter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**To** | [**Address**](Address.md) | | [optional] +**From** | [**Address**](Address.md) | | [optional] +**Carrier** | **string** | | [optional] [default to CarrierEnum.USPS] +**Thumbnails** | [**List<Thumbnail>**](Thumbnail.md) | | [optional] +**ExpectedDeliveryDate** | **DateTime** | A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`. | [optional] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**DateModified** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Id** | **string** | Unique identifier prefixed with `ltr_`. | [optional] +**TemplateId** | **string** | Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). | [optional] +**TemplateVersionId** | **string** | Unique identifier prefixed with `vrsn_`. | [optional] +**Object** | **string** | | [optional] [default to ObjectEnum.Letter] +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**MergeVariables** | **Object** | You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. | [optional] +**SendDate** | **DateTime** | A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. | [optional] +**ExtraService** | **string** | Add an extra service to your letter. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred. * registered - provides tracking and confirmation for international addresses * `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: [#10 envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf) and [flat envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf) (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet. * `certified_return_receipt` - request an electronic copy of the recipient's signature to prove delivery of your certified letter | [optional] +**TrackingNumber** | **string** | The tracking number, if applicable, will appear here when it becomes available. Dummy tracking numbers are not created in test mode. | [optional] +**TrackingEvents** | [**List<TrackingEventNormal>**](TrackingEventNormal.md) | Tracking events are not populated for registered or regular (no extra service) letters. | [optional] +**ReturnAddress** | **string** | Specifies the address the return envelope will be sent back to. This is an optional argument that is available if an account is signed up for the return envelope tracking beta, and has `return_envelope`, and `perforated_page` fields populated in the API request. | [optional] +**MailType** | [**MailType**](MailType.md) | | [optional] +**Color** | **bool** | Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. | [optional] +**DoubleSided** | **bool** | Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. | [optional] [default to true] +**AddressPlacement** | **string** | Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our letter template. * `top_first_page` - (default) print address information at the top of your provided first page * `insert_blank_page` - insert a blank address page at the beginning of your file (you will be charged for the extra page) * `bottom_first_page_center` - **(deprecation planned within a few months)** print address information at the bottom center of your provided first page * `bottom_first_page` - print address information at the bottom of your provided first page | [optional] [default to AddressPlacementEnum.TopFirstPage] +**ReturnEnvelope** | **Object** | indicates if a return envelope is requested for the letter. The value corresponding to this field is by default a boolean. But if the account is signed up for custom return envelopes, the value is of type string and is `no_9_single_window` for a standard return envelope and a custom `return_envelope_id` for non-standard return envelopes. To include a return envelope with your letter, set to `true` and specify the `perforated_page`. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred. | [optional] +**PerforatedPage** | **int?** | Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf). | [optional] +**CustomEnvelope** | [**LetterCustomEnvelope**](LetterCustomEnvelope.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/LetterCustomEnvelope.md b/docs/LetterCustomEnvelope.md new file mode 100644 index 0000000..2bf4f7c --- /dev/null +++ b/docs/LetterCustomEnvelope.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.LetterCustomEnvelope +A nested custom envelope object containing more information about the custom envelope used or `null` if a custom envelope was not used. Accepts an envelope ID for any customized envelope with available inventory. If no inventory is available for the specified ID, the letter will not be sent, and an error will be returned. If the letter has more than 6 sheets, it will be sent in a blank flat envelope. Custom envelopes may be created and ordered from the dashboard. This feature is exclusive to certain customers. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | The unique identifier of the custom envelope used. | [optional] +**Url** | **string** | The url of the envelope asset used. | [optional] +**Object** | **string** | | [optional] [default to ObjectEnum.Envelope] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/LetterDeletion.md b/docs/LetterDeletion.md new file mode 100644 index 0000000..b2d044a --- /dev/null +++ b/docs/LetterDeletion.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.LetterDeletion +Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `ltr_`. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | Value is type of resource. | [optional] [default to ObjectEnum.LetterDeleted] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/LetterEditable.md b/docs/LetterEditable.md new file mode 100644 index 0000000..5eeaadb --- /dev/null +++ b/docs/LetterEditable.md @@ -0,0 +1,26 @@ +# lob.dotnet.Model.LetterEditable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**MailType** | [**MailType**](MailType.md) | | [optional] +**MergeVariables** | **Object** | You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. | [optional] +**SendDate** | **DateTime** | A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. | [optional] +**Color** | **bool** | Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. | [optional] +**DoubleSided** | **bool** | Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. | [optional] [default to true] +**AddressPlacement** | **string** | Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our letter template. * `top_first_page` - (default) print address information at the top of your provided first page * `insert_blank_page` - insert a blank address page at the beginning of your file (you will be charged for the extra page) * `bottom_first_page_center` - **(deprecation planned within a few months)** print address information at the bottom center of your provided first page * `bottom_first_page` - print address information at the bottom of your provided first page | [optional] [default to AddressPlacementEnum.TopFirstPage] +**ReturnEnvelope** | **Object** | indicates if a return envelope is requested for the letter. The value corresponding to this field is by default a boolean. But if the account is signed up for custom return envelopes, the value is of type string and is `no_9_single_window` for a standard return envelope and a custom `return_envelope_id` for non-standard return envelopes. To include a return envelope with your letter, set to `true` and specify the `perforated_page`. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred. | [optional] +**PerforatedPage** | **int?** | Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf). | [optional] +**CustomEnvelope** | [**LetterCustomEnvelope**](LetterCustomEnvelope.md) | | [optional] +**To** | **string** | Must either be an address ID or an inline object with correct address parameters. | [optional] +**From** | **string** | Must either be an address ID or an inline object with correct address parameters. | [optional] +**File** | **string** | PDF file containing the letter's formatting. | [optional] +**ExtraService** | **string** | Add an extra service to your letter: * `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: [#10 envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf) and [flat envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf) (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet. * `certified_return_receipt` - request an electronic copy of the recipient's signature to prove delivery of your certified letter * `registered` - provides tracking and confirmation for international addresses | [optional] +**Cards** | **List<string>** | A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. | [optional] +**BillingGroupId** | **string** | An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/LetterList.md b/docs/LetterList.md new file mode 100644 index 0000000..bd2c45d --- /dev/null +++ b/docs/LetterList.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.LetterList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**List<Letter>**](Letter.md) | list of letters | [optional] +**Object** | **string** | Value is type of resource. | [optional] +**NextUrl** | **string** | url of next page of items in list. | [optional] +**PreviousUrl** | **string** | url of previous page of items in list. | [optional] +**Count** | **int** | number of resources in a set | [optional] +**TotalCount** | **int** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/LettersApi.md b/docs/LettersApi.md new file mode 100644 index 0000000..cc92f6a --- /dev/null +++ b/docs/LettersApi.md @@ -0,0 +1,338 @@ +# lob.dotnet.Api.LettersApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**LetterCancel**](LettersApi.md#lettercancel) | **DELETE** /letters/{ltr_id} | cancel +[**LetterCreate**](LettersApi.md#lettercreate) | **POST** /letters | create +[**LetterRetrieve**](LettersApi.md#letterretrieve) | **GET** /letters/{ltr_id} | get +[**LettersList**](LettersApi.md#letterslist) | **GET** /letters | list + + + +# **LetterCancel** +> LetterDeletion LetterCancel (string ltrId) + +cancel + +Completely removes a letter from production. This can only be done if the letter has a `send_date` and the `send_date` has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class LetterCancelExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new LettersApi(config); + var ltrId = ltrId_example; // string | id of the letter + + try + { + // cancel + LetterDeletion result = apiInstance.LetterCancel(ltrId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling LettersApi.LetterCancel: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ltrId** | **string**| id of the letter | + +### Return type + +[**LetterDeletion**](LetterDeletion.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Deleted | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **LetterCreate** +> Letter LetterCreate (LetterEditable letterEditable, string idempotencyKey = null) + +create + +Creates a new letter given information + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class LetterCreateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new LettersApi(config); + var letterEditable = new LetterEditable(); // LetterEditable | + var idempotencyKey = idempotencyKey_example; // string | A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + + try + { + // create + Letter result = apiInstance.LetterCreate(letterEditable, idempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling LettersApi.LetterCreate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **letterEditable** | [**LetterEditable**](LetterEditable.md)| | + **idempotencyKey** | **string**| A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). | [optional] + +### Return type + +[**Letter**](Letter.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a letter object | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **LetterRetrieve** +> Letter LetterRetrieve (string ltrId) + +get + +Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter creation. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class LetterRetrieveExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new LettersApi(config); + var ltrId = ltrId_example; // string | id of the letter + + try + { + // get + Letter result = apiInstance.LetterRetrieve(ltrId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling LettersApi.LetterRetrieve: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ltrId** | **string**| id of the letter | + +### Return type + +[**Letter**](Letter.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a letter object | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **LettersList** +> LetterList LettersList (int? limit = null, string before = null, string after = null, List include = null, Dictionary dateCreated = null, Dictionary metadata = null, bool? color = null, bool? scheduled = null, Dictionary sendDate = null, MailType? mailType = null, SortBy5 sortBy = null) + +list + +Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class LettersListExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new LettersApi(config); + var limit = 56; // int? | How many results to return. (optional) (default to 10) + var before = before_example; // string | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + var after = after_example; // string | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + var include = new List(); // List | Request that the response include the total count by specifying `include[]=total_count`. (optional) + var dateCreated = new Dictionary(); // Dictionary | Filter by date created. (optional) + var metadata = new Dictionary(); // Dictionary | Filter by metadata key-value pair`. (optional) + var color = true; // bool? | Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) + var scheduled = true; // bool? | * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + var sendDate = new Dictionary(); // Dictionary | Filter by date sent. (optional) + var mailType = ; // MailType? | A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + var sortBy = new SortBy5(); // SortBy5 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + + try + { + // list + LetterList result = apiInstance.LettersList(limit, before, after, include, dateCreated, metadata, color, scheduled, sendDate, mailType, sortBy); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling LettersApi.LettersList: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int?**| How many results to return. | [optional] [default to 10] + **before** | **string**| A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. | [optional] + **after** | **string**| A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. | [optional] + **include** | [**List<string>**](string.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] + **dateCreated** | [**Dictionary<string, string>**](string.md)| Filter by date created. | [optional] + **metadata** | [**Dictionary<string, string>**](string.md)| Filter by metadata key-value pair`. | [optional] + **color** | **bool?**| Set to `true` to return only color letters. Set to `false` to return only black & white letters. | [optional] + **scheduled** | **bool?**| * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` | [optional] + **sendDate** | [**Dictionary<string, string>**](string.md)| Filter by date sent. | [optional] + **mailType** | **MailType?**| A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. | [optional] + **sortBy** | [**SortBy5**](SortBy5.md)| Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. | [optional] + +### Return type + +[**LetterList**](LetterList.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A dictionary with a data property that contains an array of up to `limit` letters. Each entry in the array is a separate letter. The previous and next page of letters can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively. If no more letters are available beyond the current set of returned results, the `next_url` field will be empty. | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/LobConfidenceScore.md b/docs/LobConfidenceScore.md new file mode 100644 index 0000000..0bb2021 --- /dev/null +++ b/docs/LobConfidenceScore.md @@ -0,0 +1,12 @@ +# lob.dotnet.Model.LobConfidenceScore +Lob Confidence Score is a nested object that provides a numerical value between 0-100 of the likelihood that an address is deliverable based on Lob’s mail delivery data to over half of US households. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Score** | **float?** | A numerical score between 0 and 100 that represents the percentage of mailpieces Lob has sent to this addresses that have been delivered successfully over the past 2 years. Will be `null` if no tracking data exists for this address. | [optional] +**Level** | **string** | indicates the likelihood that the address is a valid, mail-receiving address. Possible values are: - `high` — Over 70% of mailpieces Lob has sent to this address were delivered successfully and recent mailings were also successful. - `medium` — Between 40% and 70% of mailpieces Lob has sent to this address were delivered successfully. - `low` — Less than 40% of mailpieces Lob has sent to this address were delivered successfully and recent mailings weren't successful. - `\"\"` — No tracking data exists for this address or lob deliverability was unable to find a corresponding level of mail success. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/LobError.md b/docs/LobError.md new file mode 100644 index 0000000..6887b5e --- /dev/null +++ b/docs/LobError.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.LobError +Lob uses RESTful HTTP response codes to indicate success or failure of an API request. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **string** | A human-readable message with more details about the error | [optional] +**StatusCode** | **int** | A conventional HTTP status code. | [optional] +**Code** | **string** | A pre-defined string identifying an error. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Location.md b/docs/Location.md new file mode 100644 index 0000000..7438a31 --- /dev/null +++ b/docs/Location.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.Location + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Latitude** | **float?** | A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be input with `longitude` to pinpoint locations on a map. | +**Longitude** | **float?** | A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be input with `latitude` to pinpoint locations on a map. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/LocationAnalysis.md b/docs/LocationAnalysis.md new file mode 100644 index 0000000..42bbdf9 --- /dev/null +++ b/docs/LocationAnalysis.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.LocationAnalysis +A nested object containing a breakdown of the analysis of a reverse geocoded location. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Latitude** | **float?** | A positive or negative decimal indicating the geographic latitude of the address. | [optional] +**Longitude** | **float?** | A positive or negative decimal indicating the geographic longitude of the address. | [optional] +**Distance** | **float** | The distance from the input location to this exact zip code in miles. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/MailType.md b/docs/MailType.md new file mode 100644 index 0000000..8dc3320 --- /dev/null +++ b/docs/MailType.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.MailType +A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/MultipleComponents.md b/docs/MultipleComponents.md new file mode 100644 index 0000000..fd3864c --- /dev/null +++ b/docs/MultipleComponents.md @@ -0,0 +1,16 @@ +# lob.dotnet.Model.MultipleComponents + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Recipient** | **string** | The intended recipient, typically a person's or firm's name. | [optional] +**PrimaryLine** | **string** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` | [optional] +**SecondaryLine** | **string** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. | [optional] +**Urbanization** | **string** | Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification. | [optional] +**City** | **string** | | [optional] +**State** | **string** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed. | [optional] +**ZipCode** | **string** | Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`). | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/MultipleComponentsIntl.md b/docs/MultipleComponentsIntl.md new file mode 100644 index 0000000..35b544e --- /dev/null +++ b/docs/MultipleComponentsIntl.md @@ -0,0 +1,16 @@ +# lob.dotnet.Model.MultipleComponentsIntl + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Recipient** | **string** | The intended recipient, typically a person's or firm's name. | [optional] +**PrimaryLine** | **string** | The primary delivery line (usually the street address) of the address. | [optional] +**SecondaryLine** | **string** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. | [optional] +**City** | **string** | | [optional] +**State** | **string** | The name of the state. | [optional] +**PostalCode** | **string** | The postal code. | [optional] +**Country** | [**CountryExtended**](CountryExtended.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/MultipleComponentsList.md b/docs/MultipleComponentsList.md new file mode 100644 index 0000000..1358659 --- /dev/null +++ b/docs/MultipleComponentsList.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.MultipleComponentsList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Addresses** | [**List<MultipleComponents>**](MultipleComponents.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Postcard.md b/docs/Postcard.md new file mode 100644 index 0000000..ecc1a63 --- /dev/null +++ b/docs/Postcard.md @@ -0,0 +1,31 @@ +# lob.dotnet.Model.Postcard + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `psc_`. | [optional] +**To** | [**Address**](Address.md) | | [optional] +**From** | [**AddressDomesticExpanded**](AddressDomesticExpanded.md) | | [optional] +**Carrier** | **string** | | [optional] [default to CarrierEnum.USPS] +**Thumbnails** | [**List<Thumbnail>**](Thumbnail.md) | | [optional] +**Size** | [**PostcardSize**](PostcardSize.md) | | [optional] +**ExpectedDeliveryDate** | **DateTime** | A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`. | [optional] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**DateModified** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**FrontTemplateId** | **string** | The unique ID of the HTML template used for the front of the postcard. | [optional] +**BackTemplateId** | **string** | The unique ID of the HTML template used for the back of the postcard. | [optional] +**FrontTemplateVersionId** | **string** | The unique ID of the specific version of the HTML template used for the front of the postcard. | [optional] +**BackTemplateVersionId** | **string** | The unique ID of the specific version of the HTML template used for the back of the postcard. | [optional] +**TrackingEvents** | [**List<TrackingEventNormal>**](TrackingEventNormal.md) | An array of tracking_event objects ordered by ascending `time`. Will not be populated for postcards created in test mode. | [optional] +**Object** | **string** | | [optional] [default to ObjectEnum.Postcard] +**Url** | **string** | A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. | [optional] +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**MailType** | [**MailType**](MailType.md) | | [optional] +**MergeVariables** | **Object** | You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. | [optional] +**SendDate** | **DateTime** | A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PostcardDeletion.md b/docs/PostcardDeletion.md new file mode 100644 index 0000000..13db26e --- /dev/null +++ b/docs/PostcardDeletion.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.PostcardDeletion +Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `psc_`. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | Value is type of resource. | [optional] [default to ObjectEnum.PostcardDeleted] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PostcardEditable.md b/docs/PostcardEditable.md new file mode 100644 index 0000000..bbac97f --- /dev/null +++ b/docs/PostcardEditable.md @@ -0,0 +1,20 @@ +# lob.dotnet.Model.PostcardEditable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**To** | **string** | Must either be an address ID or an inline object with correct address parameters. | [optional] +**From** | **string** | Required if `to` address is international. Must either be an address ID or an inline object with correct address parameters. | [optional] +**Size** | [**PostcardSize**](PostcardSize.md) | | [optional] +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**MailType** | [**MailType**](MailType.md) | | [optional] +**MergeVariables** | **Object** | You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. | [optional] +**SendDate** | **DateTime** | A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. | [optional] +**Front** | **string** | The artwork to use as the front of your postcard. | [optional] +**Back** | **string** | The artwork to use as the back of your postcard. | [optional] +**BillingGroupId** | **string** | An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PostcardList.md b/docs/PostcardList.md new file mode 100644 index 0000000..6eaa564 --- /dev/null +++ b/docs/PostcardList.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.PostcardList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**List<Postcard>**](Postcard.md) | list of postcards | [optional] +**Object** | **string** | Value is type of resource. | [optional] +**NextUrl** | **string** | url of next page of items in list. | [optional] +**PreviousUrl** | **string** | url of previous page of items in list. | [optional] +**Count** | **int** | number of resources in a set | [optional] +**TotalCount** | **int** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PostcardSize.md b/docs/PostcardSize.md new file mode 100644 index 0000000..23a2a06 --- /dev/null +++ b/docs/PostcardSize.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.PostcardSize +Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/PostcardsApi.md b/docs/PostcardsApi.md new file mode 100644 index 0000000..245deae --- /dev/null +++ b/docs/PostcardsApi.md @@ -0,0 +1,338 @@ +# lob.dotnet.Api.PostcardsApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**PostcardCreate**](PostcardsApi.md#postcardcreate) | **POST** /postcards | create +[**PostcardDelete**](PostcardsApi.md#postcarddelete) | **DELETE** /postcards/{psc_id} | cancel +[**PostcardRetrieve**](PostcardsApi.md#postcardretrieve) | **GET** /postcards/{psc_id} | get +[**PostcardsList**](PostcardsApi.md#postcardslist) | **GET** /postcards | list + + + +# **PostcardCreate** +> Postcard PostcardCreate (PostcardEditable postcardEditable, string idempotencyKey = null) + +create + +Creates a new postcard given information + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class PostcardCreateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new PostcardsApi(config); + var postcardEditable = new PostcardEditable(); // PostcardEditable | + var idempotencyKey = idempotencyKey_example; // string | A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + + try + { + // create + Postcard result = apiInstance.PostcardCreate(postcardEditable, idempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PostcardsApi.PostcardCreate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **postcardEditable** | [**PostcardEditable**](PostcardEditable.md)| | + **idempotencyKey** | **string**| A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). | [optional] + +### Return type + +[**Postcard**](Postcard.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a postcard object | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **PostcardDelete** +> PostcardDeletion PostcardDelete (string pscId) + +cancel + +Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class PostcardDeleteExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new PostcardsApi(config); + var pscId = pscId_example; // string | id of the postcard + + try + { + // cancel + PostcardDeletion result = apiInstance.PostcardDelete(pscId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PostcardsApi.PostcardDelete: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pscId** | **string**| id of the postcard | + +### Return type + +[**PostcardDeletion**](PostcardDeletion.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Deleted | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **PostcardRetrieve** +> Postcard PostcardRetrieve (string pscId) + +get + +Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class PostcardRetrieveExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new PostcardsApi(config); + var pscId = pscId_example; // string | id of the postcard + + try + { + // get + Postcard result = apiInstance.PostcardRetrieve(pscId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PostcardsApi.PostcardRetrieve: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pscId** | **string**| id of the postcard | + +### Return type + +[**Postcard**](Postcard.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a postcard object | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **PostcardsList** +> PostcardList PostcardsList (int? limit = null, string before = null, string after = null, List include = null, Dictionary dateCreated = null, Dictionary metadata = null, PostcardSize? size = null, bool? scheduled = null, Dictionary sendDate = null, MailType? mailType = null, SortBy5 sortBy = null) + +list + +Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class PostcardsListExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new PostcardsApi(config); + var limit = 56; // int? | How many results to return. (optional) (default to 10) + var before = before_example; // string | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + var after = after_example; // string | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + var include = new List(); // List | Request that the response include the total count by specifying `include[]=total_count`. (optional) + var dateCreated = new Dictionary(); // Dictionary | Filter by date created. (optional) + var metadata = new Dictionary(); // Dictionary | Filter by metadata key-value pair`. (optional) + var size = ; // PostcardSize? | Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. (optional) + var scheduled = true; // bool? | * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + var sendDate = new Dictionary(); // Dictionary | Filter by date sent. (optional) + var mailType = ; // MailType? | A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + var sortBy = new SortBy5(); // SortBy5 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + + try + { + // list + PostcardList result = apiInstance.PostcardsList(limit, before, after, include, dateCreated, metadata, size, scheduled, sendDate, mailType, sortBy); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling PostcardsApi.PostcardsList: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int?**| How many results to return. | [optional] [default to 10] + **before** | **string**| A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. | [optional] + **after** | **string**| A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. | [optional] + **include** | [**List<string>**](string.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] + **dateCreated** | [**Dictionary<string, string>**](string.md)| Filter by date created. | [optional] + **metadata** | [**Dictionary<string, string>**](string.md)| Filter by metadata key-value pair`. | [optional] + **size** | **PostcardSize?**| Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. | [optional] + **scheduled** | **bool?**| * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` | [optional] + **sendDate** | [**Dictionary<string, string>**](string.md)| Filter by date sent. | [optional] + **mailType** | **MailType?**| A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. | [optional] + **sortBy** | [**SortBy5**](SortBy5.md)| Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. | [optional] + +### Return type + +[**PostcardList**](PostcardList.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A dictionary with a data property that contains an array of up to `limit` postcards. | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/ReverseGeocode.md b/docs/ReverseGeocode.md new file mode 100644 index 0000000..2a21d53 --- /dev/null +++ b/docs/ReverseGeocode.md @@ -0,0 +1,12 @@ +# lob.dotnet.Model.ReverseGeocode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `us_reverse_geocode_`. | [optional] +**Addresses** | [**List<GeocodeAddresses>**](GeocodeAddresses.md) | list of addresses | [optional] +**Object** | **string** | Value is resource type. | [optional] [default to ObjectEnum.UsReverseGeocodeLookup] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ReverseGeocodeLookupsApi.md b/docs/ReverseGeocodeLookupsApi.md new file mode 100644 index 0000000..0683310 --- /dev/null +++ b/docs/ReverseGeocodeLookupsApi.md @@ -0,0 +1,87 @@ +# lob.dotnet.Api.ReverseGeocodeLookupsApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**ReverseGeocodeLookup**](ReverseGeocodeLookupsApi.md#reversegeocodelookup) | **POST** /us_reverse_geocode_lookups | lookup + + + +# **ReverseGeocodeLookup** +> ReverseGeocode ReverseGeocodeLookup (Location location, int? size = null) + +lookup + +Reverse geocode a valid US location with a live API key. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class ReverseGeocodeLookupExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new ReverseGeocodeLookupsApi(config); + var location = new Location(); // Location | + var size = 56; // int? | Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations. (optional) (default to 5) + + try + { + // lookup + ReverseGeocode result = apiInstance.ReverseGeocodeLookup(location, size); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling ReverseGeocodeLookupsApi.ReverseGeocodeLookup: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **location** | [**Location**](Location.md)| | + **size** | **int?**| Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations. | [optional] [default to 5] + +### Return type + +[**ReverseGeocode**](ReverseGeocode.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a zip lookup object if a valid zip was provided. | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SelfMailer.md b/docs/SelfMailer.md new file mode 100644 index 0000000..5454233 --- /dev/null +++ b/docs/SelfMailer.md @@ -0,0 +1,25 @@ +# lob.dotnet.Model.SelfMailer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `sfm_`. | [optional] +**To** | **string** | Must either be an address ID or an inline object with correct address parameters. | [optional] +**From** | **string** | Must either be an address ID or an inline object with correct address parameters. | [optional] +**Size** | [**SelfMailerSize**](SelfMailerSize.md) | | [optional] +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**MailType** | [**MailType**](MailType.md) | | [optional] +**MergeVariables** | **Object** | You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. | [optional] +**SendDate** | **DateTime** | A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. | [optional] +**OutsideTemplateId** | **string** | The unique ID of the HTML template used for the outside of the self mailer. | [optional] +**InsideTemplateId** | **string** | The unique ID of the HTML template used for the inside of the self mailer. | [optional] +**OutsideTemplateVersionId** | **string** | The unique ID of the specific version of the HTML template used for the outside of the self mailer. | [optional] +**InsideTemplateVersionId** | **string** | The unique ID of the specific version of the HTML template used for the inside of the self mailer. | [optional] +**Object** | **string** | Value is resource type. | [optional] [default to ObjectEnum.SelfMailer] +**TrackingEvents** | [**List<TrackingEventCertified>**](TrackingEventCertified.md) | An array of certified tracking events ordered by ascending `time`. Not populated in test mode. | [optional] +**Url** | **string** | A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SelfMailerDeletion.md b/docs/SelfMailerDeletion.md new file mode 100644 index 0000000..66ee5a3 --- /dev/null +++ b/docs/SelfMailerDeletion.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.SelfMailerDeletion +Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `sfm_`. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | Value is type of resource. | [optional] [default to ObjectEnum.SelfMailerDeleted] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SelfMailerEditable.md b/docs/SelfMailerEditable.md new file mode 100644 index 0000000..10307f9 --- /dev/null +++ b/docs/SelfMailerEditable.md @@ -0,0 +1,20 @@ +# lob.dotnet.Model.SelfMailerEditable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**To** | **string** | Must either be an address ID or an inline object with correct address parameters. | [optional] +**From** | **string** | Must either be an address ID or an inline object with correct address parameters. | [optional] +**Size** | [**SelfMailerSize**](SelfMailerSize.md) | | [optional] +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**MailType** | [**MailType**](MailType.md) | | [optional] +**MergeVariables** | **Object** | You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. | [optional] +**SendDate** | **DateTime** | A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. | [optional] +**Inside** | **string** | The artwork to use as the inside of your self mailer. | [optional] +**Outside** | **string** | The artwork to use as the outside of your self mailer. | [optional] +**BillingGroupId** | **string** | An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SelfMailerList.md b/docs/SelfMailerList.md new file mode 100644 index 0000000..1884bee --- /dev/null +++ b/docs/SelfMailerList.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.SelfMailerList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**List<SelfMailer>**](SelfMailer.md) | list of self-mailers | [optional] +**Object** | **string** | Value is type of resource. | [optional] +**NextUrl** | **string** | url of next page of items in list. | [optional] +**PreviousUrl** | **string** | url of previous page of items in list. | [optional] +**Count** | **int** | number of resources in a set | [optional] +**TotalCount** | **int** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SelfMailerSize.md b/docs/SelfMailerSize.md new file mode 100644 index 0000000..68943d0 --- /dev/null +++ b/docs/SelfMailerSize.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.SelfMailerSize +Specifies the size of the self mailer. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SelfMailersApi.md b/docs/SelfMailersApi.md new file mode 100644 index 0000000..e82348c --- /dev/null +++ b/docs/SelfMailersApi.md @@ -0,0 +1,338 @@ +# lob.dotnet.Api.SelfMailersApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**SelfMailerCreate**](SelfMailersApi.md#selfmailercreate) | **POST** /self_mailers | create +[**SelfMailerDelete**](SelfMailersApi.md#selfmailerdelete) | **DELETE** /self_mailers/{sfm_id} | delete +[**SelfMailerRetrieve**](SelfMailersApi.md#selfmailerretrieve) | **GET** /self_mailers/{sfm_id} | get +[**SelfMailersList**](SelfMailersApi.md#selfmailerslist) | **GET** /self_mailers | list + + + +# **SelfMailerCreate** +> SelfMailer SelfMailerCreate (SelfMailerEditable selfMailerEditable, string idempotencyKey = null) + +create + +Creates a new self_mailer given information + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class SelfMailerCreateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new SelfMailersApi(config); + var selfMailerEditable = new SelfMailerEditable(); // SelfMailerEditable | + var idempotencyKey = idempotencyKey_example; // string | A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + + try + { + // create + SelfMailer result = apiInstance.SelfMailerCreate(selfMailerEditable, idempotencyKey); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling SelfMailersApi.SelfMailerCreate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **selfMailerEditable** | [**SelfMailerEditable**](SelfMailerEditable.md)| | + **idempotencyKey** | **string**| A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). | [optional] + +### Return type + +[**SelfMailer**](SelfMailer.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a self_mailer object | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **SelfMailerDelete** +> SelfMailerDeletion SelfMailerDelete (string sfmId) + +delete + +Completely removes a self mailer from production. This can only be done if the self mailer's `send_date` has not yet passed. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class SelfMailerDeleteExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new SelfMailersApi(config); + var sfmId = sfmId_example; // string | id of the self_mailer + + try + { + // delete + SelfMailerDeletion result = apiInstance.SelfMailerDelete(sfmId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling SelfMailersApi.SelfMailerDelete: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sfmId** | **string**| id of the self_mailer | + +### Return type + +[**SelfMailerDeletion**](SelfMailerDeletion.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Deleted the card | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **SelfMailerRetrieve** +> SelfMailer SelfMailerRetrieve (string sfmId) + +get + +Retrieves the details of an existing self_mailer. You need only supply the unique self_mailer identifier that was returned upon self_mailer creation. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class SelfMailerRetrieveExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new SelfMailersApi(config); + var sfmId = sfmId_example; // string | id of the self_mailer + + try + { + // get + SelfMailer result = apiInstance.SelfMailerRetrieve(sfmId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling SelfMailersApi.SelfMailerRetrieve: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sfmId** | **string**| id of the self_mailer | + +### Return type + +[**SelfMailer**](SelfMailer.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a self_mailer object | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **SelfMailersList** +> SelfMailerList SelfMailersList (int? limit = null, string before = null, string after = null, List include = null, Dictionary dateCreated = null, Dictionary metadata = null, SelfMailerSize? size = null, bool? scheduled = null, Dictionary sendDate = null, MailType? mailType = null, SortBy5 sortBy = null) + +list + +Returns a list of your self_mailers. The self_mailers are returned sorted by creation date, with the most recently created self_mailers appearing first. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class SelfMailersListExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new SelfMailersApi(config); + var limit = 56; // int? | How many results to return. (optional) (default to 10) + var before = before_example; // string | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + var after = after_example; // string | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + var include = new List(); // List | Request that the response include the total count by specifying `include[]=total_count`. (optional) + var dateCreated = new Dictionary(); // Dictionary | Filter by date created. (optional) + var metadata = new Dictionary(); // Dictionary | Filter by metadata key-value pair`. (optional) + var size = ; // SelfMailerSize? | The self mailer sizes to be returned. (optional) + var scheduled = true; // bool? | * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + var sendDate = new Dictionary(); // Dictionary | Filter by date sent. (optional) + var mailType = ; // MailType? | A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + var sortBy = new SortBy5(); // SortBy5 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + + try + { + // list + SelfMailerList result = apiInstance.SelfMailersList(limit, before, after, include, dateCreated, metadata, size, scheduled, sendDate, mailType, sortBy); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling SelfMailersApi.SelfMailersList: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int?**| How many results to return. | [optional] [default to 10] + **before** | **string**| A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. | [optional] + **after** | **string**| A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. | [optional] + **include** | [**List<string>**](string.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] + **dateCreated** | [**Dictionary<string, string>**](string.md)| Filter by date created. | [optional] + **metadata** | [**Dictionary<string, string>**](string.md)| Filter by metadata key-value pair`. | [optional] + **size** | **SelfMailerSize?**| The self mailer sizes to be returned. | [optional] + **scheduled** | **bool?**| * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` | [optional] + **sendDate** | [**Dictionary<string, string>**](string.md)| Filter by date sent. | [optional] + **mailType** | **MailType?**| A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. | [optional] + **sortBy** | [**SortBy5**](SortBy5.md)| Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. | [optional] + +### Return type + +[**SelfMailerList**](SelfMailerList.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A dictionary with a data property that contains an array of up to `limit` self_mailers. | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/SortBy.md b/docs/SortBy.md new file mode 100644 index 0000000..6d8e123 --- /dev/null +++ b/docs/SortBy.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.SortBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DateCreated** | **string** | | [optional] +**SendDate** | **string** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SortBy1.md b/docs/SortBy1.md new file mode 100644 index 0000000..ab6e4c4 --- /dev/null +++ b/docs/SortBy1.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.SortBy1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DateCreated** | **string** | | [optional] +**SendDate** | **string** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SortBy2.md b/docs/SortBy2.md new file mode 100644 index 0000000..b6a2bff --- /dev/null +++ b/docs/SortBy2.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.SortBy2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DateCreated** | **string** | | [optional] +**SendDate** | **string** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SortBy3.md b/docs/SortBy3.md new file mode 100644 index 0000000..9887b2e --- /dev/null +++ b/docs/SortBy3.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.SortBy3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DateCreated** | **string** | | [optional] +**SendDate** | **string** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SortBy4.md b/docs/SortBy4.md new file mode 100644 index 0000000..9d71b19 --- /dev/null +++ b/docs/SortBy4.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.SortBy4 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DateCreated** | **string** | | [optional] +**SendDate** | **string** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/SortBy5.md b/docs/SortBy5.md new file mode 100644 index 0000000..5c6508d --- /dev/null +++ b/docs/SortBy5.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.SortBy5 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DateCreated** | **string** | | [optional] +**SendDate** | **string** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Suggestions.md b/docs/Suggestions.md new file mode 100644 index 0000000..cf57ba8 --- /dev/null +++ b/docs/Suggestions.md @@ -0,0 +1,14 @@ +# lob.dotnet.Model.Suggestions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PrimaryLine** | **string** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` | [optional] +**City** | **string** | | [optional] +**State** | **string** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. | [optional] +**ZipCode** | **string** | A 5-digit zip code. Left empty if a test key is used. | [optional] +**Object** | **string** | Value is resource type. | [optional] [default to ObjectEnum.UsAutocompletion] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Template.md b/docs/Template.md new file mode 100644 index 0000000..a9ab61c --- /dev/null +++ b/docs/Template.md @@ -0,0 +1,18 @@ +# lob.dotnet.Model.Template + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Id** | **string** | Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). | [optional] +**Versions** | [**List<TemplateVersion>**](TemplateVersion.md) | An array of all non-deleted [version objects](#tag/Template-Versions) associated with the template. | [optional] +**PublishedVersion** | [**TemplateVersion**](TemplateVersion.md) | | [optional] +**Object** | **string** | Value is resource type. | [optional] [default to ObjectEnum.Template] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**DateModified** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TemplateDeletion.md b/docs/TemplateDeletion.md new file mode 100644 index 0000000..e1f7cbd --- /dev/null +++ b/docs/TemplateDeletion.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.TemplateDeletion +Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | Value is type of resource. | [optional] [default to ObjectEnum.TemplateDeleted] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TemplateList.md b/docs/TemplateList.md new file mode 100644 index 0000000..0fdf58b --- /dev/null +++ b/docs/TemplateList.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.TemplateList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**List<Template>**](Template.md) | list of templates | [optional] +**Object** | **string** | Value is type of resource. | [optional] +**NextUrl** | **string** | url of next page of items in list. | [optional] +**PreviousUrl** | **string** | url of previous page of items in list. | [optional] +**Count** | **int** | number of resources in a set | [optional] +**TotalCount** | **int** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TemplateUpdate.md b/docs/TemplateUpdate.md new file mode 100644 index 0000000..50fc27b --- /dev/null +++ b/docs/TemplateUpdate.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.TemplateUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**PublishedVersion** | **string** | Unique identifier prefixed with `vrsn_`. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TemplateVersion.md b/docs/TemplateVersion.md new file mode 100644 index 0000000..e78a777 --- /dev/null +++ b/docs/TemplateVersion.md @@ -0,0 +1,19 @@ +# lob.dotnet.Model.TemplateVersion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `vrsn_`. | [optional] +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Html** | **string** | An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](#operation/postcard_create) - `front` and `back` - [Self Mailers](#operation/self_mailer_create) - `inside` and `outside` - [Letters](#operation/letter_create) - `file` - [Checks](#operation/check_create) - `check_bottom` and `attachment` - [Cards](#operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. | [optional] +**Engine** | [**EngineHtml**](EngineHtml.md) | | [optional] +**SuggestJsonEditor** | **bool** | Used by frontend, true if the template uses advanced features. | [optional] +**MergeVariables** | **Object** | Used by frontend, an object representing the keys of every merge variable present in the template. It has one key named 'keys', and its value is an array of strings. | [optional] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**DateModified** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | Value is resource type. | [optional] [default to ObjectEnum.Version] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TemplateVersionDeletion.md b/docs/TemplateVersionDeletion.md new file mode 100644 index 0000000..1c87f02 --- /dev/null +++ b/docs/TemplateVersionDeletion.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.TemplateVersionDeletion +Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `vrsn_`. | [optional] +**Deleted** | **bool** | Only returned if the resource has been successfully deleted. | [optional] +**Object** | **string** | Value is type of resource. | [optional] [default to ObjectEnum.TemplateVersionDeleted] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TemplateVersionList.md b/docs/TemplateVersionList.md new file mode 100644 index 0000000..57bd873 --- /dev/null +++ b/docs/TemplateVersionList.md @@ -0,0 +1,15 @@ +# lob.dotnet.Model.TemplateVersionList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Data** | [**List<TemplateVersion>**](TemplateVersion.md) | list of template versions | [optional] +**Object** | **string** | Value is type of resource. | [optional] +**NextUrl** | **string** | url of next page of items in list. | [optional] +**PreviousUrl** | **string** | url of previous page of items in list. | [optional] +**Count** | **int** | number of resources in a set | [optional] +**TotalCount** | **int** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TemplateVersionUpdatable.md b/docs/TemplateVersionUpdatable.md new file mode 100644 index 0000000..93fa460 --- /dev/null +++ b/docs/TemplateVersionUpdatable.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.TemplateVersionUpdatable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Engine** | [**EngineHtml**](EngineHtml.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TemplateVersionWritable.md b/docs/TemplateVersionWritable.md new file mode 100644 index 0000000..6cf2ab9 --- /dev/null +++ b/docs/TemplateVersionWritable.md @@ -0,0 +1,12 @@ +# lob.dotnet.Model.TemplateVersionWritable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Html** | **string** | An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](#operation/postcard_create) - `front` and `back` - [Self Mailers](#operation/self_mailer_create) - `inside` and `outside` - [Letters](#operation/letter_create) - `file` - [Checks](#operation/check_create) - `check_bottom` and `attachment` - [Cards](#operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. | [optional] +**Engine** | [**EngineHtml**](EngineHtml.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TemplateVersionsApi.md b/docs/TemplateVersionsApi.md new file mode 100644 index 0000000..467cca6 --- /dev/null +++ b/docs/TemplateVersionsApi.md @@ -0,0 +1,413 @@ +# lob.dotnet.Api.TemplateVersionsApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateTemplateVersion**](TemplateVersionsApi.md#createtemplateversion) | **POST** /templates/{tmpl_id}/versions | create +[**TemplateVersionDelete**](TemplateVersionsApi.md#templateversiondelete) | **DELETE** /templates/{tmpl_id}/versions/{vrsn_id} | delete +[**TemplateVersionRetrieve**](TemplateVersionsApi.md#templateversionretrieve) | **GET** /templates/{tmpl_id}/versions/{vrsn_id} | get +[**TemplateVersionUpdate**](TemplateVersionsApi.md#templateversionupdate) | **POST** /templates/{tmpl_id}/versions/{vrsn_id} | update +[**TemplateVersionsList**](TemplateVersionsApi.md#templateversionslist) | **GET** /templates/{tmpl_id}/versions | list + + + +# **CreateTemplateVersion** +> TemplateVersion CreateTemplateVersion (string tmplId, TemplateVersionWritable templateVersionWritable) + +create + +Creates a new template version attached to the specified template. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class CreateTemplateVersionExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new TemplateVersionsApi(config); + var tmplId = tmplId_example; // string | The ID of the template the new version will be attached to + var templateVersionWritable = new TemplateVersionWritable(); // TemplateVersionWritable | + + try + { + // create + TemplateVersion result = apiInstance.CreateTemplateVersion(tmplId, templateVersionWritable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TemplateVersionsApi.CreateTemplateVersion: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tmplId** | **string**| The ID of the template the new version will be attached to | + **templateVersionWritable** | [**TemplateVersionWritable**](TemplateVersionWritable.md)| | + +### Return type + +[**TemplateVersion**](TemplateVersion.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns the template version with the given template and version ids. | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **TemplateVersionDelete** +> TemplateVersionDeletion TemplateVersionDelete (string tmplId, string vrsnId) + +delete + +Permanently deletes a template version. A template's `published_version` can not be deleted. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class TemplateVersionDeleteExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new TemplateVersionsApi(config); + var tmplId = tmplId_example; // string | The ID of the template to which the version belongs. + var vrsnId = vrsnId_example; // string | id of the template_version + + try + { + // delete + TemplateVersionDeletion result = apiInstance.TemplateVersionDelete(tmplId, vrsnId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TemplateVersionsApi.TemplateVersionDelete: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tmplId** | **string**| The ID of the template to which the version belongs. | + **vrsnId** | **string**| id of the template_version | + +### Return type + +[**TemplateVersionDeletion**](TemplateVersionDeletion.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Deleted | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **TemplateVersionRetrieve** +> TemplateVersion TemplateVersionRetrieve (string tmplId, string vrsnId) + +get + +Retrieves the template version with the given template and version ids. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class TemplateVersionRetrieveExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new TemplateVersionsApi(config); + var tmplId = tmplId_example; // string | The ID of the template to which the version belongs. + var vrsnId = vrsnId_example; // string | id of the template_version + + try + { + // get + TemplateVersion result = apiInstance.TemplateVersionRetrieve(tmplId, vrsnId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TemplateVersionsApi.TemplateVersionRetrieve: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tmplId** | **string**| The ID of the template to which the version belongs. | + **vrsnId** | **string**| id of the template_version | + +### Return type + +[**TemplateVersion**](TemplateVersion.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns the template version with the given template and version ids. | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **TemplateVersionUpdate** +> TemplateVersion TemplateVersionUpdate (string tmplId, string vrsnId, TemplateVersionUpdatable templateVersionUpdatable) + +update + +Updates the template version with the given template and version ids. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class TemplateVersionUpdateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new TemplateVersionsApi(config); + var tmplId = tmplId_example; // string | The ID of the template to which the version belongs. + var vrsnId = vrsnId_example; // string | id of the template_version + var templateVersionUpdatable = new TemplateVersionUpdatable(); // TemplateVersionUpdatable | + + try + { + // update + TemplateVersion result = apiInstance.TemplateVersionUpdate(tmplId, vrsnId, templateVersionUpdatable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TemplateVersionsApi.TemplateVersionUpdate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tmplId** | **string**| The ID of the template to which the version belongs. | + **vrsnId** | **string**| id of the template_version | + **templateVersionUpdatable** | [**TemplateVersionUpdatable**](TemplateVersionUpdatable.md)| | + +### Return type + +[**TemplateVersion**](TemplateVersion.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns the template version with the given template and version ids. | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **TemplateVersionsList** +> TemplateVersionList TemplateVersionsList (string tmplId, int? limit = null, string before = null, string after = null, List include = null, Dictionary dateCreated = null) + +list + +Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class TemplateVersionsListExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new TemplateVersionsApi(config); + var tmplId = tmplId_example; // string | The ID of the template associated with the retrieved versions + var limit = 56; // int? | How many results to return. (optional) (default to 10) + var before = before_example; // string | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + var after = after_example; // string | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + var include = new List(); // List | Request that the response include the total count by specifying `include[]=total_count`. (optional) + var dateCreated = new Dictionary(); // Dictionary | Filter by date created. (optional) + + try + { + // list + TemplateVersionList result = apiInstance.TemplateVersionsList(tmplId, limit, before, after, include, dateCreated); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TemplateVersionsApi.TemplateVersionsList: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tmplId** | **string**| The ID of the template associated with the retrieved versions | + **limit** | **int?**| How many results to return. | [optional] [default to 10] + **before** | **string**| A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. | [optional] + **after** | **string**| A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. | [optional] + **include** | [**List<string>**](string.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] + **dateCreated** | [**Dictionary<string, string>**](string.md)| Filter by date created. | [optional] + +### Return type + +[**TemplateVersionList**](TemplateVersionList.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A dictionary with a data property that contains an array of up to `limit` template versions. Each entry in the array is a separate template version object. The previous and next page of template versions can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively.<br>If no more template versions are available beyond the current set of returned results, the `next_url` field will be empty. | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TemplateWritable.md b/docs/TemplateWritable.md new file mode 100644 index 0000000..216caf9 --- /dev/null +++ b/docs/TemplateWritable.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.TemplateWritable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **string** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] +**Html** | **string** | An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](#operation/postcard_create) - `front` and `back` - [Self Mailers](#operation/self_mailer_create) - `inside` and `outside` - [Letters](#operation/letter_create) - `file` - [Checks](#operation/check_create) - `check_bottom` and `attachment` - [Cards](#operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. | [optional] +**Metadata** | **Dictionary<string, string>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] +**Engine** | [**EngineHtml**](EngineHtml.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TemplatesApi.md b/docs/TemplatesApi.md new file mode 100644 index 0000000..336dbb6 --- /dev/null +++ b/docs/TemplatesApi.md @@ -0,0 +1,405 @@ +# lob.dotnet.Api.TemplatesApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateTemplate**](TemplatesApi.md#createtemplate) | **POST** /templates | create +[**TemplateDelete**](TemplatesApi.md#templatedelete) | **DELETE** /templates/{tmpl_id} | delete +[**TemplateRetrieve**](TemplatesApi.md#templateretrieve) | **GET** /templates/{tmpl_id} | get +[**TemplateUpdate**](TemplatesApi.md#templateupdate) | **POST** /templates/{tmpl_id} | update +[**TemplatesList**](TemplatesApi.md#templateslist) | **GET** /templates | list + + + +# **CreateTemplate** +> Template CreateTemplate (TemplateWritable templateWritable) + +create + +Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions). If you attempt to create a template past your limit, you will receive a `403` error. There is no limit in Test mode. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class CreateTemplateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new TemplatesApi(config); + var templateWritable = new TemplateWritable(); // TemplateWritable | + + try + { + // create + Template result = apiInstance.CreateTemplate(templateWritable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TemplatesApi.CreateTemplate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **templateWritable** | [**TemplateWritable**](TemplateWritable.md)| | + +### Return type + +[**Template**](Template.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a template object | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **TemplateDelete** +> TemplateDeletion TemplateDelete (string tmplId) + +delete + +Permanently deletes a template. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class TemplateDeleteExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new TemplatesApi(config); + var tmplId = tmplId_example; // string | id of the template + + try + { + // delete + TemplateDeletion result = apiInstance.TemplateDelete(tmplId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TemplatesApi.TemplateDelete: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tmplId** | **string**| id of the template | + +### Return type + +[**TemplateDeletion**](TemplateDeletion.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Deleted | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **TemplateRetrieve** +> Template TemplateRetrieve (string tmplId) + +get + +Retrieves the details of an existing template. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class TemplateRetrieveExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new TemplatesApi(config); + var tmplId = tmplId_example; // string | id of the template + + try + { + // get + Template result = apiInstance.TemplateRetrieve(tmplId); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TemplatesApi.TemplateRetrieve: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tmplId** | **string**| id of the template | + +### Return type + +[**Template**](Template.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a template object | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **TemplateUpdate** +> Template TemplateUpdate (string tmplId, TemplateUpdate templateUpdate) + +update + +Updates the description and/or published version of the template with the given id. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class TemplateUpdateExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new TemplatesApi(config); + var tmplId = tmplId_example; // string | id of the template + var templateUpdate = new TemplateUpdate(); // TemplateUpdate | + + try + { + // update + Template result = apiInstance.TemplateUpdate(tmplId, templateUpdate); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TemplatesApi.TemplateUpdate: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tmplId** | **string**| id of the template | + **templateUpdate** | [**TemplateUpdate**](TemplateUpdate.md)| | + +### Return type + +[**Template**](Template.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns the updated template object | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **TemplatesList** +> TemplateList TemplatesList (int? limit = null, string before = null, string after = null, List include = null, Dictionary dateCreated = null, Dictionary metadata = null) + +list + +Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class TemplatesListExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new TemplatesApi(config); + var limit = 56; // int? | How many results to return. (optional) (default to 10) + var before = before_example; // string | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + var after = after_example; // string | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + var include = new List(); // List | Request that the response include the total count by specifying `include[]=total_count`. (optional) + var dateCreated = new Dictionary(); // Dictionary | Filter by date created. (optional) + var metadata = new Dictionary(); // Dictionary | Filter by metadata key-value pair`. (optional) + + try + { + // list + TemplateList result = apiInstance.TemplatesList(limit, before, after, include, dateCreated, metadata); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling TemplatesApi.TemplatesList: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **int?**| How many results to return. | [optional] [default to 10] + **before** | **string**| A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. | [optional] + **after** | **string**| A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. | [optional] + **include** | [**List<string>**](string.md)| Request that the response include the total count by specifying `include[]=total_count`. | [optional] + **dateCreated** | [**Dictionary<string, string>**](string.md)| Filter by date created. | [optional] + **metadata** | [**Dictionary<string, string>**](string.md)| Filter by metadata key-value pair`. | [optional] + +### Return type + +[**TemplateList**](TemplateList.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A dictionary with a data property that contains an array of up to `limit` templates. Each entry in the array is a separate template. The previous and next page of templates can be retrieved by calling the endpoint contained in the `previous_url` and `next_url` fields in the API response respectively.<br>If no more templates are available beyond the current set of returned results, the `next_url` field will be empty. | - | +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/Thumbnail.md b/docs/Thumbnail.md new file mode 100644 index 0000000..120e092 --- /dev/null +++ b/docs/Thumbnail.md @@ -0,0 +1,12 @@ +# lob.dotnet.Model.Thumbnail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Small** | **string** | A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. | [optional] +**Medium** | **string** | A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. | [optional] +**Large** | **string** | A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TrackingEventCertified.md b/docs/TrackingEventCertified.md new file mode 100644 index 0000000..eac42dc --- /dev/null +++ b/docs/TrackingEventCertified.md @@ -0,0 +1,18 @@ +# lob.dotnet.Model.TrackingEventCertified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | a Certified letter tracking event | [optional] +**Name** | **string** | Name of tracking event for Certified letters. Letters sent with USPS Certified Mail are fully tracked by USPS, therefore their tracking events have an additional details object with more detailed information about the tracking event. Some certified tracking event names have multiple meanings, noted in the list here. See the description of the details object for the full set of combined certified tracking event name meanings. * `Mailed` - Package has been accepted into the carrier network for delivery. * `In Transit` - Maps to four distinct stages of transit. * `In Local Area` - Package is at a location near the end destination. * `Processed for Delivery` - Maps to two distinct stages of delivery. * `Pickup Available` - Package is available for pickup at carrier location. * `Delivered` - Package has been delivered. * `Re-Routed` - Package has been forwarded. * `Returned to Sender` - Package is to be returned to sender. * `Issue` - Maps to (at least) 15 possible issues, some of which are actionable. | [optional] +**Details** | [**TrackingEventDetails**](TrackingEventDetails.md) | | [optional] +**Location** | **string** | The zip code in which the event occurred if it exists, otherwise will be the name of a Regional Distribution Center if it exists, otherwise will be null. | [optional] +**Id** | **string** | Unique identifier prefixed with `evnt_`. | [optional] +**Time** | **DateTime** | A timestamp in ISO 8601 format of the date USPS registered the event. | [optional] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**DateModified** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] +**Object** | **string** | | [optional] [default to ObjectEnum.TrackingEvent] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TrackingEventDetails.md b/docs/TrackingEventDetails.md new file mode 100644 index 0000000..34604bd --- /dev/null +++ b/docs/TrackingEventDetails.md @@ -0,0 +1,13 @@ +# lob.dotnet.Model.TrackingEventDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Event** | **string** | Find the full table [here](#tag/Tracking-Events). A detailed substatus about the event: * `package_accepted` - Package has been accepted into the carrier network for delivery. * `package_arrived` - Package has arrived at an intermediate location in the carrier network. * `package_departed` - Package has departed from an intermediate location in the carrier network. * `package_processing` - Package is processing at an intermediate location in the carrier network. * `package_processed` - Package has been processed at an intermediate location. * `package_in_local_area` - Package is at a location near the end destination. * `delivery_scheduled` - Package is scheduled for delivery. * `out_for_delivery` - Package is out for delivery. * `pickup_available` - Package is available for pickup at carrier location. * `delivered` - Package has been delivered. * `package_forwarded` - Package has been forwarded. * `returned_to_sender` - Package is to be returned to sender. * `address_issue` - Address information is incorrect. Contact carrier to ensure delivery. * `contact_carrier` - Contact the carrier for more information. * `delayed` - Delivery of package is delayed. * `delivery_attempted` - Delivery of package has been attempted. Contact carrier to ensure delivery. * `delivery_rescheduled` - Delivery of package has been rescheduled. * `location_inaccessible` - Delivery location inaccessible to carrier. Contact carrier to ensure delivery. * `notice_left` - Carrier left notice during attempted delivery. Follow carrier instructions on notice. * `package_damaged` - Package has been damaged. Contact carrier for more details. * `package_disposed` - Package has been disposed. * `package_held` - Package held at carrier location. Contact carrier for more details. * `package_lost` - Package has been lost. Contact carrier for more details. * `package_unclaimed` - Package is unclaimed. * `package_undeliverable` - Package is not able to be delivered. * `reschedule_delivery` - Contact carrier to reschedule delivery. * `other` - Unrecognized carrier status. | [optional] +**Description** | **string** | The description as listed in the description for event. | [optional] +**Notes** | **string** | Event-specific notes from USPS about the tracking event. | [optional] +**ActionRequired** | **bool** | `true` if action is required by the end recipient, `false` otherwise. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/TrackingEventNormal.md b/docs/TrackingEventNormal.md new file mode 100644 index 0000000..e3a2ecd --- /dev/null +++ b/docs/TrackingEventNormal.md @@ -0,0 +1,18 @@ +# lob.dotnet.Model.TrackingEventNormal + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **string** | non-Certified postcards, self mailers, letters, and checks | [optional] +**Name** | **string** | Name of tracking event (for normal postcards, self mailers, letters, and checks): * `In Transit` - The mailpiece is being processed at the entry/origin facility. * `In Local Area` - The mailpiece is being processed at the destination facility. * `Processed for Delivery` - The mailpiece has been greenlit for delivery at the recipient's nearest postal facility. The mailpiece should reach the mailbox within 1 business day of this tracking event. * `Re-Routed` - The mailpiece is re-routed due to recipient change of address, address errors, or USPS relabeling of barcode/ID tag area. * `Returned to Sender` - The mailpiece is being returned to sender due to barcode, ID tag area, or address errors. * `Mailed` - The mailpiece has been handed off to and accepted by USPS and is en route. [More about Mailed.](https://support.lob.com/hc/en-us/articles/360001724400-What-does-a-Mailed-tracking-event-mean-) Note this data is only available in Enterprise editions of Lob. [Contact Sales](https://lob.com/support/contact#contact) if you want access to this feature. [More about tracking](https://support.lob.com/hc/en-us/articles/115000097404-Can-I-track-my-mail-) | [optional] +**Details** | **Object** | Will be `null` for `type=normal` events | [optional] +**Location** | **string** | The zip code in which the scan event occurred. Null for `Mailed` events. | [optional] +**Id** | **string** | Unique identifier prefixed with `evnt_`. | [optional] +**Time** | **DateTime** | A timestamp in ISO 8601 format of the date USPS registered the event. | [optional] +**DateCreated** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] +**DateModified** | **DateTime** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] +**Object** | **string** | | [optional] [default to ObjectEnum.TrackingEvent] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UsAutocompletions.md b/docs/UsAutocompletions.md new file mode 100644 index 0000000..80c5d15 --- /dev/null +++ b/docs/UsAutocompletions.md @@ -0,0 +1,12 @@ +# lob.dotnet.Model.UsAutocompletions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `us_auto_`. | [optional] +**Suggestions** | [**List<Suggestions>**](Suggestions.md) | An array of objects representing suggested addresses. | [optional] +**Object** | **string** | Value is resource type. | [optional] [default to ObjectEnum.UsAutocompletion] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UsAutocompletionsApi.md b/docs/UsAutocompletionsApi.md new file mode 100644 index 0000000..28e27c1 --- /dev/null +++ b/docs/UsAutocompletionsApi.md @@ -0,0 +1,85 @@ +# lob.dotnet.Api.UsAutocompletionsApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**UsAutocompletion**](UsAutocompletionsApi.md#usautocompletion) | **POST** /us_autocompletions | autocomplete + + + +# **UsAutocompletion** +> UsAutocompletions UsAutocompletion (UsAutocompletionsWritable usAutocompletionsWritable) + +autocomplete + +Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us). + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class UsAutocompletionExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new UsAutocompletionsApi(config); + var usAutocompletionsWritable = new UsAutocompletionsWritable(); // UsAutocompletionsWritable | + + try + { + // autocomplete + UsAutocompletions result = apiInstance.UsAutocompletion(usAutocompletionsWritable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling UsAutocompletionsApi.UsAutocompletion: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **usAutocompletionsWritable** | [**UsAutocompletionsWritable**](UsAutocompletionsWritable.md)| | + +### Return type + +[**UsAutocompletions**](UsAutocompletions.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a US autocompletion object. | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/UsAutocompletionsWritable.md b/docs/UsAutocompletionsWritable.md new file mode 100644 index 0000000..a3305dc --- /dev/null +++ b/docs/UsAutocompletionsWritable.md @@ -0,0 +1,14 @@ +# lob.dotnet.Model.UsAutocompletionsWritable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddressPrefix** | **string** | Only accepts numbers and street names in an alphanumeric format. | [optional] +**City** | **string** | An optional city input used to filter suggestions. Case insensitive and does not match partial abbreviations. | [optional] +**State** | **string** | An optional state input used to filter suggestions. Case insensitive and does not match partial abbreviations. | [optional] +**ZipCode** | **string** | An optional ZIP Code input used to filter suggestions. Matches partial entries. | [optional] +**GeoIpSort** | **bool** | If `true`, sort suggestions by proximity to the IP set in the `X-Forwarded-For` header. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UsComponents.md b/docs/UsComponents.md new file mode 100644 index 0000000..31b8a76 --- /dev/null +++ b/docs/UsComponents.md @@ -0,0 +1,36 @@ +# lob.dotnet.Model.UsComponents +A nested object containing a breakdown of each component of an address. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PrimaryNumber** | **string** | The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number. | [optional] +**StreetPredirection** | **string** | Geographic direction preceding a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`). | [optional] +**StreetName** | **string** | The name of the street. | [optional] +**StreetSuffix** | **string** | The standard USPS abbreviation for the street suffix (`ST`, `AVE`, `BLVD`, etc). | [optional] +**StreetPostdirection** | **string** | Geographic direction following a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`). | [optional] +**SecondaryDesignator** | **string** | The standard USPS abbreviation describing the `components[secondary_number]` (`STE`, `APT`, `BLDG`, etc). | [optional] +**SecondaryNumber** | **string** | Number of the apartment/unit/etc. | [optional] +**PmbDesignator** | **string** | Designator of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox. | [optional] +**PmbNumber** | **string** | Number of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox. | [optional] +**ExtraSecondaryDesignator** | **string** | An extra (often unnecessary) secondary designator provided with the input address. | [optional] +**ExtraSecondaryNumber** | **string** | An extra (often unnecessary) secondary number provided with the input address. | [optional] +**City** | **string** | | [optional] +**State** | **string** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. | [optional] +**ZipCode** | **string** | The 5-digit ZIP code | [optional] +**ZipCodePlus4** | **string** | | [optional] +**ZipCodeType** | [**ZipCodeType**](ZipCodeType.md) | | [optional] +**DeliveryPointBarcode** | **string** | A 12-digit identifier that uniquely identifies a delivery point (location where mail can be sent and received). It consists of the 5-digit ZIP code (`zip_code`), 4-digit ZIP+4 add-on (`zip_code_plus_4`), 2-digit delivery point, and 1-digit delivery point check digit. | [optional] +**AddressType** | **string** | Uses USPS's [Residential Delivery Indicator (RDI)](https://www.usps.com/nationalpremieraccounts/rdi.htm) to identify whether an address is classified as residential or business. Possible values are: * `residential` –– The address is residential or a PO Box. * `commercial` –– The address is commercial. * `''` –– Not enough information provided to be determined. | [optional] +**RecordType** | **string** | A description of the type of address. Populated if a DPV match is made (`deliverability_analysis[dpv_confirmation]` is `Y`, `S`, or `D`). For more detailed information about each record type, see [US Verification Details](#tag/US-Verification-Types). | [optional] +**DefaultBuildingAddress** | **bool** | Designates whether or not the address is the default address for a building containing multiple delivery points. | [optional] +**County** | **string** | County name of the address city. | [optional] +**CountyFips** | **string** | A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code. | [optional] +**CarrierRoute** | **string** | A 4-character code assigned to a mail delivery route within a ZIP code. | [optional] +**CarrierRouteType** | **string** | The type of `components[carrier_route]`. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types). | [optional] +**Latitude** | **float?** | A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be used with `longitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`). | [optional] +**Longitude** | **float?** | A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be used with `latitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`). | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UsVerification.md b/docs/UsVerification.md new file mode 100644 index 0000000..c52035a --- /dev/null +++ b/docs/UsVerification.md @@ -0,0 +1,20 @@ +# lob.dotnet.Model.UsVerification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `us_ver_`. | [optional] +**Recipient** | **string** | The intended recipient, typically a person's or firm's name. | [optional] +**PrimaryLine** | **string** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` | [optional] +**SecondaryLine** | **string** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. | [optional] +**Urbanization** | **string** | Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification. | [optional] +**LastLine** | **string** | Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`) | [optional] +**Deliverability** | **string** | Summarizes the deliverability of the `us_verification` object. For full details, see the `deliverability_analysis` field. Possible values are: * `deliverable` – The address is deliverable by the USPS. * `deliverable_unnecessary_unit` – The address is deliverable, but the secondary unit information is unnecessary. * `deliverable_incorrect_unit` – The address is deliverable to the building's default address but the secondary unit provided may not exist. There is a chance the mail will not reach the intended recipient. * `deliverable_missing_unit` – The address is deliverable to the building's default address but is missing secondary unit information. There is a chance the mail will not reach the intended recipient. * `undeliverable` – The address is not deliverable according to the USPS. | [optional] +**Components** | [**UsComponents**](UsComponents.md) | | [optional] +**DeliverabilityAnalysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) | | [optional] +**LobConfidenceScore** | [**LobConfidenceScore**](LobConfidenceScore.md) | | [optional] +**Object** | **string** | | [optional] [default to ObjectEnum.UsVerification] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UsVerificationOrError.md b/docs/UsVerificationOrError.md new file mode 100644 index 0000000..d5108dd --- /dev/null +++ b/docs/UsVerificationOrError.md @@ -0,0 +1,22 @@ +# lob.dotnet.Model.UsVerificationOrError +A model used to represent an entry in a result list where the entry can either be a us_verification or an Error. The SDK will perform necessary casting into the correct corresponding type. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **string** | Unique identifier prefixed with `us_ver_`. | [optional] +**Recipient** | **string** | The intended recipient, typically a person's or firm's name. | [optional] +**PrimaryLine** | **string** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` | [optional] +**SecondaryLine** | **string** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. | [optional] +**Urbanization** | **string** | Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification. | [optional] +**LastLine** | **string** | | [optional] +**Deliverability** | **string** | | [optional] +**Components** | [**UsComponents**](UsComponents.md) | | [optional] +**DeliverabilityAnalysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) | | [optional] +**LobConfidenceScore** | [**LobConfidenceScore**](LobConfidenceScore.md) | | [optional] +**Object** | **string** | | [optional] [default to ObjectEnum.UsVerification] +**Error** | [**BulkError**](BulkError.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UsVerifications.md b/docs/UsVerifications.md new file mode 100644 index 0000000..9a1496c --- /dev/null +++ b/docs/UsVerifications.md @@ -0,0 +1,11 @@ +# lob.dotnet.Model.UsVerifications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Addresses** | [**List<UsVerificationOrError>**](UsVerificationOrError.md) | | [optional] +**Errors** | **bool** | Indicates whether any errors occurred during the verification process. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/UsVerificationsApi.md b/docs/UsVerificationsApi.md new file mode 100644 index 0000000..4adb6dd --- /dev/null +++ b/docs/UsVerificationsApi.md @@ -0,0 +1,166 @@ +# lob.dotnet.Api.UsVerificationsApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**BulkUsVerifications**](UsVerificationsApi.md#bulkusverifications) | **POST** /bulk/us_verifications | verifyBulk +[**UsVerification**](UsVerificationsApi.md#usverification) | **POST** /us_verifications | verifySingle + + + +# **BulkUsVerifications** +> UsVerifications BulkUsVerifications (MultipleComponentsList multipleComponentsList, string _case = null) + +verifyBulk + +Verify a list of US or US territory addresses with a live API key. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class BulkUsVerificationsExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new UsVerificationsApi(config); + var multipleComponentsList = new MultipleComponentsList(); // MultipleComponentsList | + var _case = _case_example; // string | Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional) (default to upper) + + try + { + // verifyBulk + UsVerifications result = apiInstance.BulkUsVerifications(multipleComponentsList, _case); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling UsVerificationsApi.BulkUsVerifications: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **multipleComponentsList** | [**MultipleComponentsList**](MultipleComponentsList.md)| | + **_case** | **string**| Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. | [optional] [default to upper] + +### Return type + +[**UsVerifications**](UsVerifications.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a list of US verification objects. | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + + +# **UsVerification** +> UsVerification UsVerification (UsVerificationsWritable usVerificationsWritable, string _case = null) + +verifySingle + +Verify a US or US territory address with a live API key. + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class UsVerificationExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new UsVerificationsApi(config); + var usVerificationsWritable = new UsVerificationsWritable(); // UsVerificationsWritable | + var _case = _case_example; // string | Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional) (default to upper) + + try + { + // verifySingle + UsVerification result = apiInstance.UsVerification(usVerificationsWritable, _case); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling UsVerificationsApi.UsVerification: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **usVerificationsWritable** | [**UsVerificationsWritable**](UsVerificationsWritable.md)| | + **_case** | **string**| Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. | [optional] [default to upper] + +### Return type + +[**UsVerification**](UsVerification.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a US verification object. | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/UsVerificationsWritable.md b/docs/UsVerificationsWritable.md new file mode 100644 index 0000000..6aaa28d --- /dev/null +++ b/docs/UsVerificationsWritable.md @@ -0,0 +1,17 @@ +# lob.dotnet.Model.UsVerificationsWritable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Address** | **string** | The entire address in one string (e.g., \"210 King Street 94107\"). _Does not support a recipient and will error when other payload parameters are provided._ | [optional] +**Recipient** | **string** | The intended recipient, typically a person's or firm's name. | [optional] +**PrimaryLine** | **string** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` | [optional] +**SecondaryLine** | **string** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. | [optional] +**Urbanization** | **string** | Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification. | [optional] +**City** | **string** | | [optional] +**State** | **string** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed. | [optional] +**ZipCode** | **string** | Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`). | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/Zip.md b/docs/Zip.md new file mode 100644 index 0000000..0be5603 --- /dev/null +++ b/docs/Zip.md @@ -0,0 +1,14 @@ +# lob.dotnet.Model.Zip + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ZipCode** | **string** | A 5-digit ZIP code. | [optional] +**Id** | **string** | Unique identifier prefixed with `us_zip_`. | [optional] +**Cities** | [**List<ZipLookupCity>**](ZipLookupCity.md) | An array of city objects containing valid cities for the `zip_code`. Multiple cities will be returned if more than one city is associated with the input ZIP code. | [optional] +**ZipCodeType** | [**ZipCodeType**](ZipCodeType.md) | | [optional] +**Object** | **string** | | [optional] [default to ObjectEnum.UsZipLookup] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ZipCodeType.md b/docs/ZipCodeType.md new file mode 100644 index 0000000..b0bfca9 --- /dev/null +++ b/docs/ZipCodeType.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.ZipCodeType +A description of the ZIP code type. For more detailed information about each ZIP code type, see [US Verification Details](#tag/US-Verification-Types). + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ZipEditable.md b/docs/ZipEditable.md new file mode 100644 index 0000000..b452e24 --- /dev/null +++ b/docs/ZipEditable.md @@ -0,0 +1,10 @@ +# lob.dotnet.Model.ZipEditable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ZipCode** | **string** | A 5-digit ZIP code. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ZipLookupCity.md b/docs/ZipLookupCity.md new file mode 100644 index 0000000..47c332a --- /dev/null +++ b/docs/ZipLookupCity.md @@ -0,0 +1,14 @@ +# lob.dotnet.Model.ZipLookupCity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**City** | **string** | | [optional] +**State** | **string** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. | [optional] +**County** | **string** | County name of the address city. | [optional] +**CountyFips** | **string** | A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code. | [optional] +**Preferred** | **bool** | Indicates whether or not the city is the [USPS default city](https://en.wikipedia.org/wiki/ZIP_Code#ZIP_Codes_and_previous_zoning_lines) (preferred city) of a ZIP code. There is only one preferred city per ZIP code, which will always be in position 0 in the array of cities. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + diff --git a/docs/ZipLookupsApi.md b/docs/ZipLookupsApi.md new file mode 100644 index 0000000..be9ee04 --- /dev/null +++ b/docs/ZipLookupsApi.md @@ -0,0 +1,85 @@ +# lob.dotnet.Api.ZipLookupsApi + +All URIs are relative to *https://api.lob.com/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**ZipLookup**](ZipLookupsApi.md#ziplookup) | **POST** /us_zip_lookups | lookup + + + +# **ZipLookup** +> Zip ZipLookup (ZipEditable zipEditable) + +lookup + +Returns information about a ZIP code + +### Example +```csharp +using System.Collections.Generic; +using System.Diagnostics; +using lob.dotnet.Api; +using lob.dotnet.Client; +using lob.dotnet.Model; + +namespace Example +{ + public class ZipLookupExample + { + public static void Main() + { + Configuration config = new Configuration(); + config.BasePath = "https://api.lob.com/v1"; + // Configure HTTP basic authorization: basicAuth + config.Username = "YOUR_USERNAME"; + config.Password = "YOUR_PASSWORD"; + + var apiInstance = new ZipLookupsApi(config); + var zipEditable = new ZipEditable(); // ZipEditable | + + try + { + // lookup + Zip result = apiInstance.ZipLookup(zipEditable); + Debug.WriteLine(result); + } + catch (ApiException e) + { + Debug.Print("Exception when calling ZipLookupsApi.ZipLookup: " + e.Message ); + Debug.Print("Status Code: "+ e.ErrorCode); + Debug.Print(e.StackTrace); + } + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **zipEditable** | [**ZipEditable**](ZipEditable.md)| | + +### Return type + +[**Zip**](Zip.md) + +### Authorization + +[basicAuth](../README.md#basicAuth) + +### HTTP request headers + + - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Returns a zip lookup object if a valid zip was provided. | * ratelimit-limit -
* ratelimit-remaining -
* ratelimit-reset -
| +| **0** | Lob uses RESTful HTTP response codes to indicate success or failure of an API request. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/git_push.sh b/git_push.sh new file mode 100644 index 0000000..f53a75d --- /dev/null +++ b/git_push.sh @@ -0,0 +1,57 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=$(git remote) +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' diff --git a/lob.dotnet.sln b/lob.dotnet.sln new file mode 100644 index 0000000..4047211 --- /dev/null +++ b/lob.dotnet.sln @@ -0,0 +1,27 @@ +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 2012 +VisualStudioVersion = 12.0.0.0 +MinimumVisualStudioVersion = 10.0.0.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "lob.dotnet", "src\lob.dotnet\lob.dotnet.csproj", "{B5B6AC6B-8BA4-426E-ACEE-E873DE218E3D}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "lob.dotnet.Test", "src\lob.dotnet.Test\lob.dotnet.Test.csproj", "{19F1DEBC-DE5E-4517-8062-F000CD499087}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {B5B6AC6B-8BA4-426E-ACEE-E873DE218E3D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {B5B6AC6B-8BA4-426E-ACEE-E873DE218E3D}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B5B6AC6B-8BA4-426E-ACEE-E873DE218E3D}.Release|Any CPU.ActiveCfg = Release|Any CPU + {B5B6AC6B-8BA4-426E-ACEE-E873DE218E3D}.Release|Any CPU.Build.0 = Release|Any CPU + {19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {19F1DEBC-DE5E-4517-8062-F000CD499087}.Debug|Any CPU.Build.0 = Debug|Any CPU + {19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.ActiveCfg = Release|Any CPU + {19F1DEBC-DE5E-4517-8062-F000CD499087}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal \ No newline at end of file diff --git a/src/lob.dotnet.Test/Api/AddressesApiTests.cs b/src/lob.dotnet.Test/Api/AddressesApiTests.cs new file mode 100644 index 0000000..91c63b1 --- /dev/null +++ b/src/lob.dotnet.Test/Api/AddressesApiTests.cs @@ -0,0 +1,111 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing AddressesApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class AddressesApiTests : IDisposable + { + private AddressesApi instance; + + public AddressesApiTests() + { + instance = new AddressesApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of AddressesApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' AddressesApi + //Assert.IsType(instance); + } + + /// + /// Test AddressCreate + /// + [Fact] + public void AddressCreateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //AddressEditable addressEditable = null; + //var response = instance.AddressCreate(addressEditable); + //Assert.IsType
(response); + } + + /// + /// Test AddressDelete + /// + [Fact] + public void AddressDeleteTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string adrId = null; + //var response = instance.AddressDelete(adrId); + //Assert.IsType(response); + } + + /// + /// Test AddressRetrieve + /// + [Fact] + public void AddressRetrieveTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string adrId = null; + //var response = instance.AddressRetrieve(adrId); + //Assert.IsType
(response); + } + + /// + /// Test AddressesList + /// + [Fact] + public void AddressesListTest() + { + // TODO uncomment below to test the method and replace null with proper value + //int? limit = null; + //string before = null; + //string after = null; + //List include = null; + //Dictionary dateCreated = null; + //Dictionary metadata = null; + //var response = instance.AddressesList(limit, before, after, include, dateCreated, metadata); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/BankAccountsApiTests.cs b/src/lob.dotnet.Test/Api/BankAccountsApiTests.cs new file mode 100644 index 0000000..bab3b6d --- /dev/null +++ b/src/lob.dotnet.Test/Api/BankAccountsApiTests.cs @@ -0,0 +1,124 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing BankAccountsApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class BankAccountsApiTests : IDisposable + { + private BankAccountsApi instance; + + public BankAccountsApiTests() + { + instance = new BankAccountsApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of BankAccountsApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' BankAccountsApi + //Assert.IsType(instance); + } + + /// + /// Test BankAccountCreate + /// + [Fact] + public void BankAccountCreateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //BankAccountWritable bankAccountWritable = null; + //var response = instance.BankAccountCreate(bankAccountWritable); + //Assert.IsType(response); + } + + /// + /// Test BankAccountDelete + /// + [Fact] + public void BankAccountDeleteTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string bankId = null; + //var response = instance.BankAccountDelete(bankId); + //Assert.IsType(response); + } + + /// + /// Test BankAccountRetrieve + /// + [Fact] + public void BankAccountRetrieveTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string bankId = null; + //var response = instance.BankAccountRetrieve(bankId); + //Assert.IsType(response); + } + + /// + /// Test BankAccountVerify + /// + [Fact] + public void BankAccountVerifyTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string bankId = null; + //BankAccountVerify bankAccountVerify = null; + //var response = instance.BankAccountVerify(bankId, bankAccountVerify); + //Assert.IsType(response); + } + + /// + /// Test BankAccountsList + /// + [Fact] + public void BankAccountsListTest() + { + // TODO uncomment below to test the method and replace null with proper value + //int? limit = null; + //string before = null; + //string after = null; + //List include = null; + //Dictionary dateCreated = null; + //Dictionary metadata = null; + //var response = instance.BankAccountsList(limit, before, after, include, dateCreated, metadata); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/BillingGroupsApiTests.cs b/src/lob.dotnet.Test/Api/BillingGroupsApiTests.cs new file mode 100644 index 0000000..8ef6962 --- /dev/null +++ b/src/lob.dotnet.Test/Api/BillingGroupsApiTests.cs @@ -0,0 +1,112 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing BillingGroupsApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class BillingGroupsApiTests : IDisposable + { + private BillingGroupsApi instance; + + public BillingGroupsApiTests() + { + instance = new BillingGroupsApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of BillingGroupsApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' BillingGroupsApi + //Assert.IsType(instance); + } + + /// + /// Test BillingGroupCreate + /// + [Fact] + public void BillingGroupCreateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //BillingGroupEditable billingGroupEditable = null; + //var response = instance.BillingGroupCreate(billingGroupEditable); + //Assert.IsType(response); + } + + /// + /// Test BillingGroupRetrieve + /// + [Fact] + public void BillingGroupRetrieveTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string bgId = null; + //var response = instance.BillingGroupRetrieve(bgId); + //Assert.IsType(response); + } + + /// + /// Test BillingGroupUpdate + /// + [Fact] + public void BillingGroupUpdateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string bgId = null; + //BillingGroupEditable billingGroupEditable = null; + //var response = instance.BillingGroupUpdate(bgId, billingGroupEditable); + //Assert.IsType(response); + } + + /// + /// Test BillingGroupsList + /// + [Fact] + public void BillingGroupsListTest() + { + // TODO uncomment below to test the method and replace null with proper value + //int? limit = null; + //int? offset = null; + //List include = null; + //Dictionary dateCreated = null; + //Dictionary dateModified = null; + //SortBy5 sortBy = null; + //var response = instance.BillingGroupsList(limit, offset, include, dateCreated, dateModified, sortBy); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/CardOrdersApiTests.cs b/src/lob.dotnet.Test/Api/CardOrdersApiTests.cs new file mode 100644 index 0000000..e3c568e --- /dev/null +++ b/src/lob.dotnet.Test/Api/CardOrdersApiTests.cs @@ -0,0 +1,85 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing CardOrdersApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class CardOrdersApiTests : IDisposable + { + private CardOrdersApi instance; + + public CardOrdersApiTests() + { + instance = new CardOrdersApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of CardOrdersApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' CardOrdersApi + //Assert.IsType(instance); + } + + /// + /// Test CardOrderCreate + /// + [Fact] + public void CardOrderCreateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string cardId = null; + //CardOrderEditable cardOrderEditable = null; + //var response = instance.CardOrderCreate(cardId, cardOrderEditable); + //Assert.IsType(response); + } + + /// + /// Test CardOrdersRetrieve + /// + [Fact] + public void CardOrdersRetrieveTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string cardId = null; + //int? limit = null; + //int? offset = null; + //var response = instance.CardOrdersRetrieve(cardId, limit, offset); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/CardsApiTests.cs b/src/lob.dotnet.Test/Api/CardsApiTests.cs new file mode 100644 index 0000000..1cd2f3a --- /dev/null +++ b/src/lob.dotnet.Test/Api/CardsApiTests.cs @@ -0,0 +1,122 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing CardsApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class CardsApiTests : IDisposable + { + private CardsApi instance; + + public CardsApiTests() + { + instance = new CardsApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of CardsApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' CardsApi + //Assert.IsType(instance); + } + + /// + /// Test CardCreate + /// + [Fact] + public void CardCreateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //CardEditable cardEditable = null; + //var response = instance.CardCreate(cardEditable); + //Assert.IsType(response); + } + + /// + /// Test CardDelete + /// + [Fact] + public void CardDeleteTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string cardId = null; + //var response = instance.CardDelete(cardId); + //Assert.IsType(response); + } + + /// + /// Test CardRetrieve + /// + [Fact] + public void CardRetrieveTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string cardId = null; + //var response = instance.CardRetrieve(cardId); + //Assert.IsType(response); + } + + /// + /// Test CardUpdate + /// + [Fact] + public void CardUpdateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string cardId = null; + //CardUpdatable cardUpdatable = null; + //var response = instance.CardUpdate(cardId, cardUpdatable); + //Assert.IsType(response); + } + + /// + /// Test CardsList + /// + [Fact] + public void CardsListTest() + { + // TODO uncomment below to test the method and replace null with proper value + //int? limit = null; + //string before = null; + //string after = null; + //SortBy5 sortBy = null; + //var response = instance.CardsList(limit, before, after, sortBy); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/ChecksApiTests.cs b/src/lob.dotnet.Test/Api/ChecksApiTests.cs new file mode 100644 index 0000000..fee2f3f --- /dev/null +++ b/src/lob.dotnet.Test/Api/ChecksApiTests.cs @@ -0,0 +1,116 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing ChecksApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class ChecksApiTests : IDisposable + { + private ChecksApi instance; + + public ChecksApiTests() + { + instance = new ChecksApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of ChecksApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' ChecksApi + //Assert.IsType(instance); + } + + /// + /// Test CheckCancel + /// + [Fact] + public void CheckCancelTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string chkId = null; + //var response = instance.CheckCancel(chkId); + //Assert.IsType(response); + } + + /// + /// Test CheckCreate + /// + [Fact] + public void CheckCreateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //CheckEditable checkEditable = null; + //string idempotencyKey = null; + //var response = instance.CheckCreate(checkEditable, idempotencyKey); + //Assert.IsType(response); + } + + /// + /// Test CheckRetrieve + /// + [Fact] + public void CheckRetrieveTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string chkId = null; + //var response = instance.CheckRetrieve(chkId); + //Assert.IsType(response); + } + + /// + /// Test ChecksList + /// + [Fact] + public void ChecksListTest() + { + // TODO uncomment below to test the method and replace null with proper value + //int? limit = null; + //string before = null; + //string after = null; + //List include = null; + //Dictionary dateCreated = null; + //Dictionary metadata = null; + //bool? scheduled = null; + //Dictionary sendDate = null; + //MailType? mailType = null; + //SortBy5 sortBy = null; + //var response = instance.ChecksList(limit, before, after, include, dateCreated, metadata, scheduled, sendDate, mailType, sortBy); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/IntlAutocompletionsApiTests.cs b/src/lob.dotnet.Test/Api/IntlAutocompletionsApiTests.cs new file mode 100644 index 0000000..5933d20 --- /dev/null +++ b/src/lob.dotnet.Test/Api/IntlAutocompletionsApiTests.cs @@ -0,0 +1,71 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing IntlAutocompletionsApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class IntlAutocompletionsApiTests : IDisposable + { + private IntlAutocompletionsApi instance; + + public IntlAutocompletionsApiTests() + { + instance = new IntlAutocompletionsApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of IntlAutocompletionsApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' IntlAutocompletionsApi + //Assert.IsType(instance); + } + + /// + /// Test IntlAutocompletion + /// + [Fact] + public void IntlAutocompletionTest() + { + // TODO uncomment below to test the method and replace null with proper value + //IntlAutocompletionsWritable intlAutocompletionsWritable = null; + //string xLangOutput = null; + //var response = instance.IntlAutocompletion(intlAutocompletionsWritable, xLangOutput); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/IntlVerificationsApiTests.cs b/src/lob.dotnet.Test/Api/IntlVerificationsApiTests.cs new file mode 100644 index 0000000..d5a81d1 --- /dev/null +++ b/src/lob.dotnet.Test/Api/IntlVerificationsApiTests.cs @@ -0,0 +1,83 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing IntlVerificationsApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class IntlVerificationsApiTests : IDisposable + { + private IntlVerificationsApi instance; + + public IntlVerificationsApiTests() + { + instance = new IntlVerificationsApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of IntlVerificationsApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' IntlVerificationsApi + //Assert.IsType(instance); + } + + /// + /// Test BulkIntlVerifications + /// + [Fact] + public void BulkIntlVerificationsTest() + { + // TODO uncomment below to test the method and replace null with proper value + //IntlVerificationsPayload intlVerificationsPayload = null; + //var response = instance.BulkIntlVerifications(intlVerificationsPayload); + //Assert.IsType(response); + } + + /// + /// Test IntlVerification + /// + [Fact] + public void IntlVerificationTest() + { + // TODO uncomment below to test the method and replace null with proper value + //IntlVerificationWritable intlVerificationWritable = null; + //string xLangOutput = null; + //var response = instance.IntlVerification(intlVerificationWritable, xLangOutput); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/LettersApiTests.cs b/src/lob.dotnet.Test/Api/LettersApiTests.cs new file mode 100644 index 0000000..86de81d --- /dev/null +++ b/src/lob.dotnet.Test/Api/LettersApiTests.cs @@ -0,0 +1,117 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing LettersApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class LettersApiTests : IDisposable + { + private LettersApi instance; + + public LettersApiTests() + { + instance = new LettersApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of LettersApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' LettersApi + //Assert.IsType(instance); + } + + /// + /// Test LetterCancel + /// + [Fact] + public void LetterCancelTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string ltrId = null; + //var response = instance.LetterCancel(ltrId); + //Assert.IsType(response); + } + + /// + /// Test LetterCreate + /// + [Fact] + public void LetterCreateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //LetterEditable letterEditable = null; + //string idempotencyKey = null; + //var response = instance.LetterCreate(letterEditable, idempotencyKey); + //Assert.IsType(response); + } + + /// + /// Test LetterRetrieve + /// + [Fact] + public void LetterRetrieveTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string ltrId = null; + //var response = instance.LetterRetrieve(ltrId); + //Assert.IsType(response); + } + + /// + /// Test LettersList + /// + [Fact] + public void LettersListTest() + { + // TODO uncomment below to test the method and replace null with proper value + //int? limit = null; + //string before = null; + //string after = null; + //List include = null; + //Dictionary dateCreated = null; + //Dictionary metadata = null; + //bool? color = null; + //bool? scheduled = null; + //Dictionary sendDate = null; + //MailType? mailType = null; + //SortBy5 sortBy = null; + //var response = instance.LettersList(limit, before, after, include, dateCreated, metadata, color, scheduled, sendDate, mailType, sortBy); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/PostcardsApiTests.cs b/src/lob.dotnet.Test/Api/PostcardsApiTests.cs new file mode 100644 index 0000000..21d4f77 --- /dev/null +++ b/src/lob.dotnet.Test/Api/PostcardsApiTests.cs @@ -0,0 +1,117 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing PostcardsApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class PostcardsApiTests : IDisposable + { + private PostcardsApi instance; + + public PostcardsApiTests() + { + instance = new PostcardsApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of PostcardsApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' PostcardsApi + //Assert.IsType(instance); + } + + /// + /// Test PostcardCreate + /// + [Fact] + public void PostcardCreateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //PostcardEditable postcardEditable = null; + //string idempotencyKey = null; + //var response = instance.PostcardCreate(postcardEditable, idempotencyKey); + //Assert.IsType(response); + } + + /// + /// Test PostcardDelete + /// + [Fact] + public void PostcardDeleteTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string pscId = null; + //var response = instance.PostcardDelete(pscId); + //Assert.IsType(response); + } + + /// + /// Test PostcardRetrieve + /// + [Fact] + public void PostcardRetrieveTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string pscId = null; + //var response = instance.PostcardRetrieve(pscId); + //Assert.IsType(response); + } + + /// + /// Test PostcardsList + /// + [Fact] + public void PostcardsListTest() + { + // TODO uncomment below to test the method and replace null with proper value + //int? limit = null; + //string before = null; + //string after = null; + //List include = null; + //Dictionary dateCreated = null; + //Dictionary metadata = null; + //PostcardSize? size = null; + //bool? scheduled = null; + //Dictionary sendDate = null; + //MailType? mailType = null; + //SortBy5 sortBy = null; + //var response = instance.PostcardsList(limit, before, after, include, dateCreated, metadata, size, scheduled, sendDate, mailType, sortBy); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/ReverseGeocodeLookupsApiTests.cs b/src/lob.dotnet.Test/Api/ReverseGeocodeLookupsApiTests.cs new file mode 100644 index 0000000..00976bd --- /dev/null +++ b/src/lob.dotnet.Test/Api/ReverseGeocodeLookupsApiTests.cs @@ -0,0 +1,71 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing ReverseGeocodeLookupsApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class ReverseGeocodeLookupsApiTests : IDisposable + { + private ReverseGeocodeLookupsApi instance; + + public ReverseGeocodeLookupsApiTests() + { + instance = new ReverseGeocodeLookupsApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of ReverseGeocodeLookupsApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' ReverseGeocodeLookupsApi + //Assert.IsType(instance); + } + + /// + /// Test ReverseGeocodeLookup + /// + [Fact] + public void ReverseGeocodeLookupTest() + { + // TODO uncomment below to test the method and replace null with proper value + //Location location = null; + //int? size = null; + //var response = instance.ReverseGeocodeLookup(location, size); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/SelfMailersApiTests.cs b/src/lob.dotnet.Test/Api/SelfMailersApiTests.cs new file mode 100644 index 0000000..4df3b2e --- /dev/null +++ b/src/lob.dotnet.Test/Api/SelfMailersApiTests.cs @@ -0,0 +1,117 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing SelfMailersApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class SelfMailersApiTests : IDisposable + { + private SelfMailersApi instance; + + public SelfMailersApiTests() + { + instance = new SelfMailersApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of SelfMailersApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' SelfMailersApi + //Assert.IsType(instance); + } + + /// + /// Test SelfMailerCreate + /// + [Fact] + public void SelfMailerCreateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //SelfMailerEditable selfMailerEditable = null; + //string idempotencyKey = null; + //var response = instance.SelfMailerCreate(selfMailerEditable, idempotencyKey); + //Assert.IsType(response); + } + + /// + /// Test SelfMailerDelete + /// + [Fact] + public void SelfMailerDeleteTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string sfmId = null; + //var response = instance.SelfMailerDelete(sfmId); + //Assert.IsType(response); + } + + /// + /// Test SelfMailerRetrieve + /// + [Fact] + public void SelfMailerRetrieveTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string sfmId = null; + //var response = instance.SelfMailerRetrieve(sfmId); + //Assert.IsType(response); + } + + /// + /// Test SelfMailersList + /// + [Fact] + public void SelfMailersListTest() + { + // TODO uncomment below to test the method and replace null with proper value + //int? limit = null; + //string before = null; + //string after = null; + //List include = null; + //Dictionary dateCreated = null; + //Dictionary metadata = null; + //SelfMailerSize? size = null; + //bool? scheduled = null; + //Dictionary sendDate = null; + //MailType? mailType = null; + //SortBy5 sortBy = null; + //var response = instance.SelfMailersList(limit, before, after, include, dateCreated, metadata, size, scheduled, sendDate, mailType, sortBy); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/TemplateVersionsApiTests.cs b/src/lob.dotnet.Test/Api/TemplateVersionsApiTests.cs new file mode 100644 index 0000000..cd72f9d --- /dev/null +++ b/src/lob.dotnet.Test/Api/TemplateVersionsApiTests.cs @@ -0,0 +1,128 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing TemplateVersionsApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class TemplateVersionsApiTests : IDisposable + { + private TemplateVersionsApi instance; + + public TemplateVersionsApiTests() + { + instance = new TemplateVersionsApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of TemplateVersionsApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' TemplateVersionsApi + //Assert.IsType(instance); + } + + /// + /// Test CreateTemplateVersion + /// + [Fact] + public void CreateTemplateVersionTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string tmplId = null; + //TemplateVersionWritable templateVersionWritable = null; + //var response = instance.CreateTemplateVersion(tmplId, templateVersionWritable); + //Assert.IsType(response); + } + + /// + /// Test TemplateVersionDelete + /// + [Fact] + public void TemplateVersionDeleteTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string tmplId = null; + //string vrsnId = null; + //var response = instance.TemplateVersionDelete(tmplId, vrsnId); + //Assert.IsType(response); + } + + /// + /// Test TemplateVersionRetrieve + /// + [Fact] + public void TemplateVersionRetrieveTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string tmplId = null; + //string vrsnId = null; + //var response = instance.TemplateVersionRetrieve(tmplId, vrsnId); + //Assert.IsType(response); + } + + /// + /// Test TemplateVersionUpdate + /// + [Fact] + public void TemplateVersionUpdateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string tmplId = null; + //string vrsnId = null; + //TemplateVersionUpdatable templateVersionUpdatable = null; + //var response = instance.TemplateVersionUpdate(tmplId, vrsnId, templateVersionUpdatable); + //Assert.IsType(response); + } + + /// + /// Test TemplateVersionsList + /// + [Fact] + public void TemplateVersionsListTest() + { + // TODO uncomment below to test the method and replace null with proper value + //string tmplId = null; + //int? limit = null; + //string before = null; + //string after = null; + //List include = null; + //Dictionary dateCreated = null; + //var response = instance.TemplateVersionsList(tmplId, limit, before, after, include, dateCreated); + //Assert.IsType(response); + } + } +} diff --git a/src/lob.dotnet.Test/Api/TemplatesApiTests.cs b/src/lob.dotnet.Test/Api/TemplatesApiTests.cs new file mode 100644 index 0000000..5802b37 --- /dev/null +++ b/src/lob.dotnet.Test/Api/TemplatesApiTests.cs @@ -0,0 +1,124 @@ +/* + * 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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? + * + * The version of the OpenAPI document: 1.3.0 + * Contact: lob-openapi@lob.com + * Generated by: https://github.com/openapitools/openapi-generator.git + */ + +using System; +using System.IO; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using RestSharp; +using Xunit; + +using lob.dotnet.Client; +using lob.dotnet.Api; +// uncomment below to import models +//using lob.dotnet.Model; + +namespace lob.dotnet.Test.Api +{ + ///

+ /// Class for testing TemplatesApi + /// + /// + /// This file is automatically generated by OpenAPI Generator (https://openapi-generator.tech). + /// Please update the test case below to test the API endpoint. + /// + public class TemplatesApiTests : IDisposable + { + private TemplatesApi instance; + + public TemplatesApiTests() + { + instance = new TemplatesApi(); + } + + public void Dispose() + { + // Cleanup when everything is done. + } + + /// + /// Test an instance of TemplatesApi + /// + [Fact] + public void InstanceTest() + { + // TODO uncomment below to test 'IsType' TemplatesApi + //Assert.IsType(instance); + } + + /// + /// Test CreateTemplate + /// + [Fact] + public void CreateTemplateTest() + { + // TODO uncomment below to test the method and replace null with proper value + //TemplateWritable templateWritable = null; + //var response = instance.CreateTemplate(templateWritable); + //Assert.IsType