lob 6.0.8 → 6.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CODE_SNIPPETS.md +10 -10
- data/Gemfile +0 -0
- data/Gemfile.lock +22 -18
- data/LICENSE +0 -0
- data/MIGRATION.md +0 -0
- data/Rakefile +0 -0
- data/__tests__/Api/Address.unit.rb +9 -9
- data/__tests__/Api/BankAccount.unit.rb +3 -3
- data/__tests__/Api/BillingGroup.unit.rb +1 -1
- data/__tests__/Api/Card.unit.rb +1 -1
- data/__tests__/Api/CardOrder.unit.rb +1 -1
- data/__tests__/Api/Check.unit.rb +1 -1
- data/__tests__/Api/IntlAutocompletion.unit.rb +1 -1
- data/__tests__/Api/IntlVerification.unit.rb +1 -1
- data/__tests__/Api/Letter.unit.rb +1 -1
- data/__tests__/Api/Postcard.unit.rb +1 -1
- data/__tests__/Api/Require.unit.rb +0 -1
- data/__tests__/Api/ReverseGeocodeLookup.unit.rb +1 -1
- data/__tests__/Api/SelfMailer.unit.rb +1 -1
- data/__tests__/Api/Template.unit.rb +1 -1
- data/__tests__/Api/TemplateVersion.unit.rb +1 -1
- data/__tests__/Api/UsAutocompletion.unit.rb +1 -1
- data/__tests__/Api/UsVerification.unit.rb +1 -1
- data/__tests__/Api/ZipLookup.unit.rb +1 -1
- data/__tests__/Integration/Address.spec.rb +4 -4
- data/__tests__/Integration/BankAccount.spec.rb +2 -2
- data/__tests__/Integration/BillingGroup.spec.rb +3 -3
- data/__tests__/Integration/Card.spec.rb +1 -1
- data/__tests__/Integration/CardOrder.spec.rb +1 -1
- data/__tests__/Integration/Check.spec.rb +10 -6
- data/__tests__/Integration/IntlAutocompletion.spec.rb +2 -2
- data/__tests__/Integration/IntlVerification.spec.rb +3 -3
- data/__tests__/Integration/Letter.spec.rb +16 -9
- data/__tests__/Integration/Postcard.spec.rb +40 -4
- data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +1 -1
- data/__tests__/Integration/SelfMailer.spec.rb +22 -2
- data/__tests__/Integration/Template.spec.rb +4 -3
- data/__tests__/Integration/TemplateVersion.spec.rb +1 -1
- data/__tests__/Integration/UsAutocompletion.spec.rb +1 -2
- data/__tests__/Integration/UsVerification.spec.rb +1 -1
- data/__tests__/Integration/ZipLookup.spec.rb +1 -1
- data/__tests__/TestFixtures.rb +0 -0
- data/docs/Address.md +44 -41
- data/docs/AddressDeletion.md +1 -1
- data/docs/AddressDomestic.md +1 -1
- data/docs/AddressDomesticExpanded.md +1 -1
- data/docs/AddressEditable.md +1 -1
- data/docs/AddressList.md +1 -1
- data/docs/AddressesApi.md +4 -4
- data/docs/BankAccount.md +1 -1
- data/docs/BankAccountDeletion.md +1 -1
- data/docs/BankAccountList.md +1 -1
- data/docs/BankAccountVerify.md +1 -1
- data/docs/BankAccountWritable.md +1 -1
- data/docs/BankAccountsApi.md +5 -5
- data/docs/BankTypeEnum.md +1 -1
- data/docs/BillingGroup.md +1 -1
- data/docs/BillingGroupEditable.md +1 -1
- data/docs/BillingGroupList.md +1 -1
- data/docs/BillingGroupsApi.md +4 -4
- data/docs/Buckslip.md +1 -1
- data/docs/BuckslipDeletion.md +1 -1
- data/docs/BuckslipEditable.md +1 -1
- data/docs/BuckslipOrder.md +1 -1
- data/docs/BuckslipOrderEditable.md +1 -1
- data/docs/BuckslipOrdersApi.md +2 -2
- data/docs/BuckslipOrdersList.md +1 -1
- data/docs/BuckslipUpdatable.md +1 -1
- data/docs/BuckslipsApi.md +13 -9
- data/docs/BuckslipsList.md +1 -1
- data/docs/BulkError.md +1 -1
- data/docs/BulkErrorProperties.md +1 -1
- data/docs/Campaign.md +2 -2
- data/docs/CampaignCreative.md +1 -1
- data/docs/CampaignDeletion.md +1 -1
- data/docs/CampaignUpdatable.md +1 -1
- data/docs/CampaignWritable.md +2 -2
- data/docs/CampaignsApi.md +6 -6
- data/docs/CampaignsList.md +1 -1
- data/docs/Card.md +1 -1
- data/docs/CardDeletion.md +1 -1
- data/docs/CardEditable.md +1 -1
- data/docs/CardList.md +1 -1
- data/docs/CardOrder.md +1 -1
- data/docs/CardOrderEditable.md +1 -1
- data/docs/CardOrderList.md +1 -1
- data/docs/CardOrdersApi.md +2 -2
- data/docs/CardUpdatable.md +1 -1
- data/docs/CardsApi.md +5 -5
- data/docs/Check.md +4 -2
- data/docs/CheckDeletion.md +1 -1
- data/docs/CheckEditable.md +4 -2
- data/docs/CheckList.md +1 -1
- data/docs/ChecksApi.md +7 -7
- data/docs/ChkUseType.md +15 -0
- data/docs/CmpScheduleType.md +1 -1
- data/docs/CmpUseType.md +1 -1
- data/docs/CountryExtended.md +1 -1
- data/docs/CountryExtendedExpanded.md +1 -1
- data/docs/CountryExtendedExpandedNoUs.md +0 -0
- data/docs/CreativePatch.md +1 -1
- data/docs/CreativeResponse.md +1 -1
- data/docs/CreativeWritable.md +1 -1
- data/docs/CreativesApi.md +3 -3
- data/docs/CustomEnvelopeReturned.md +1 -1
- data/docs/DefaultApi.md +1 -1
- data/docs/DeliverabilityAnalysis.md +16 -16
- data/docs/DpvFootnote.md +1 -1
- data/docs/EngineHtml.md +1 -1
- data/docs/EventType.md +1 -1
- data/docs/Events.md +1 -1
- data/docs/Export.md +1 -1
- data/docs/ExportModel.md +1 -1
- data/docs/GeocodeAddresses.md +1 -1
- data/docs/GeocodeComponents.md +1 -1
- data/docs/HTTPValidationError.md +1 -1
- data/docs/IdentityValidation.md +1 -1
- data/docs/IdentityValidationApi.md +1 -1
- data/docs/InlineObject.md +1 -1
- data/docs/IntlAddress.md +2 -2
- data/docs/IntlAutocompletions.md +1 -1
- data/docs/IntlAutocompletionsApi.md +2 -2
- data/docs/IntlAutocompletionsWritable.md +1 -1
- data/docs/IntlComponents.md +1 -1
- data/docs/IntlSuggestions.md +1 -1
- data/docs/IntlVerification.md +1 -1
- data/docs/IntlVerificationOrError.md +1 -1
- data/docs/IntlVerificationWritable.md +1 -1
- data/docs/IntlVerifications.md +1 -1
- data/docs/IntlVerificationsApi.md +3 -3
- data/docs/IntlVerificationsPayload.md +1 -1
- data/docs/Letter.md +6 -2
- data/docs/LetterCustomEnvelope.md +1 -1
- data/docs/LetterDeletion.md +1 -1
- data/docs/LetterDetailsReturned.md +1 -1
- data/docs/LetterDetailsWritable.md +1 -1
- data/docs/LetterEditable.md +4 -2
- data/docs/LetterList.md +1 -1
- data/docs/LettersApi.md +10 -8
- data/docs/LobConfidenceScore.md +1 -1
- data/docs/LobError.md +1 -1
- data/docs/Location.md +1 -1
- data/docs/LocationAnalysis.md +1 -1
- data/docs/LtrUseType.md +15 -0
- data/docs/MailType.md +1 -1
- data/docs/MultiLineAddress.md +1 -1
- data/docs/MultipleComponents.md +1 -1
- data/docs/MultipleComponentsIntl.md +1 -1
- data/docs/MultipleComponentsList.md +1 -1
- data/docs/OptionalAddressColumnMapping.md +22 -0
- data/docs/PlaceholderModel.md +1 -1
- data/docs/Postcard.md +4 -2
- data/docs/PostcardDeletion.md +1 -1
- data/docs/PostcardDetailsReturned.md +1 -1
- data/docs/PostcardDetailsWritable.md +1 -1
- data/docs/PostcardEditable.md +4 -2
- data/docs/PostcardList.md +1 -1
- data/docs/PostcardSize.md +1 -1
- data/docs/PostcardsApi.md +7 -7
- data/docs/PscUseType.md +15 -0
- data/docs/QrCode.md +1 -1
- data/docs/RequiredAddressColumnMapping.md +26 -0
- data/docs/ReturnEnvelope.md +1 -1
- data/docs/ReverseGeocode.md +1 -1
- data/docs/ReverseGeocodeLookupsApi.md +1 -1
- data/docs/SelfMailer.md +5 -3
- data/docs/SelfMailerDeletion.md +1 -1
- data/docs/SelfMailerEditable.md +4 -2
- data/docs/SelfMailerList.md +1 -1
- data/docs/SelfMailerSize.md +1 -1
- data/docs/SelfMailersApi.md +7 -7
- data/docs/SfmUseType.md +15 -0
- data/docs/SnapPack.md +50 -0
- data/docs/SnapPackDeletion.md +22 -0
- data/docs/SnapPackEditable.md +40 -0
- data/docs/SnapPackList.md +28 -0
- data/docs/SnapPackSize.md +15 -0
- data/docs/SnapPacksApi.md +317 -0
- data/docs/SnpUseType.md +15 -0
- data/docs/SortBy.md +1 -1
- data/docs/SortBy1.md +1 -1
- data/docs/SortBy2.md +1 -1
- data/docs/SortBy3.md +1 -1
- data/docs/SortBy4.md +20 -0
- data/docs/SortByDateModified.md +1 -1
- data/docs/Suggestions.md +1 -1
- data/docs/Template.md +1 -1
- data/docs/TemplateDeletion.md +1 -1
- data/docs/TemplateList.md +1 -1
- data/docs/TemplateUpdate.md +1 -1
- data/docs/TemplateVersion.md +1 -1
- data/docs/TemplateVersionDeletion.md +1 -1
- data/docs/TemplateVersionList.md +1 -1
- data/docs/TemplateVersionUpdatable.md +1 -1
- data/docs/TemplateVersionWritable.md +1 -1
- data/docs/TemplateVersionsApi.md +5 -5
- data/docs/TemplateWritable.md +1 -1
- data/docs/TemplatesApi.md +5 -5
- data/docs/Thumbnail.md +1 -1
- data/docs/TrackingEventCertified.md +1 -1
- data/docs/TrackingEventDetails.md +1 -1
- data/docs/TrackingEventNormal.md +2 -2
- data/docs/Upload.md +12 -6
- data/docs/UploadCreateExport.md +1 -1
- data/docs/UploadFile.md +1 -1
- data/docs/UploadState.md +1 -1
- data/docs/UploadUpdatable.md +10 -4
- data/docs/UploadWritable.md +11 -3
- data/docs/UploadsApi.md +102 -102
- data/docs/UploadsMetadata.md +18 -0
- data/docs/UsAddress.md +0 -0
- data/docs/UsAutocompletions.md +1 -1
- data/docs/UsAutocompletionsApi.md +1 -1
- data/docs/UsAutocompletionsWritable.md +1 -1
- data/docs/UsComponents.md +28 -28
- data/docs/UsVerification.md +1 -1
- data/docs/UsVerificationOrError.md +1 -1
- data/docs/UsVerifications.md +1 -1
- data/docs/UsVerificationsApi.md +2 -2
- data/docs/UsVerificationsWritable.md +1 -1
- data/docs/ValidationError.md +1 -1
- data/docs/Zip.md +1 -1
- data/docs/ZipCodeType.md +1 -1
- data/docs/ZipEditable.md +1 -1
- data/docs/ZipLookupCity.md +1 -1
- data/docs/ZipLookupsApi.md +1 -1
- data/git_push.sh +0 -0
- data/lib/{openapi_client → lob}/api/checks_api.rb +2 -2
- data/lib/{openapi_client → lob}/api/letters_api.rb +2 -2
- data/lib/{openapi_client → lob}/api/postcards_api.rb +2 -2
- data/lib/{openapi_client → lob}/api/self_mailers_api.rb +2 -2
- data/lib/lob/api/snap_packs_api.rb +340 -0
- data/lib/{openapi_client → lob}/models/address.rb +0 -0
- data/lib/{openapi_client → lob}/models/bank_account.rb +18 -7
- data/lib/{openapi_client → lob}/models/bank_account_verify.rb +69 -13
- data/lib/{openapi_client → lob}/models/check.rb +3 -3
- data/lib/{openapi_client → lob}/models/country_extended_expanded_no_us.rb +0 -0
- data/lib/{openapi_client → lob}/models/intl_address.rb +12 -14
- data/lib/{openapi_client → lob}/models/intl_components.rb +0 -0
- data/lib/{openapi_client → lob}/models/letter.rb +4 -19
- data/lib/{openapi_client → lob}/models/multiple_components.rb +5 -5
- data/lib/{openapi_client → lob}/models/postcard.rb +3 -3
- data/lib/{openapi_client → lob}/models/self_mailer.rb +3 -3
- data/lib/{openapi_client → lob}/models/self_mailer_size.rb +1 -0
- data/lib/lob/models/snap_pack.rb +584 -0
- data/lib/lob/models/snap_pack_deletion.rb +303 -0
- data/lib/lob/models/snap_pack_editable.rb +384 -0
- data/lib/lob/models/snap_pack_list.rb +324 -0
- data/lib/lob/models/snap_pack_size.rb +36 -0
- data/lib/lob/models/snp_use_type.rb +38 -0
- data/lib/lob/models/sort_by4.rb +283 -0
- data/lib/{openapi_client → lob}/models/thumbnail.rb +9 -9
- data/lib/{openapi_client → lob}/models/upload.rb +16 -1
- data/lib/{openapi_client → lob}/models/us_address.rb +0 -0
- data/lib/{openapi_client → lob}/models/us_verification.rb +8 -8
- data/lib/{openapi_client → lob}/models/us_verification_or_error.rb +6 -6
- data/lib/{openapi_client → lob}/models/us_verifications.rb +1 -1
- data/lib/{openapi_client → lob}/models/us_verifications_writable.rb +6 -6
- data/lib/{openapi_client → lob}/version.rb +1 -1
- data/lib/lob.rb +223 -1
- data/{openapi_client.gemspec → lob.gemspec} +8 -7
- data/spec/api/addresses_api_spec.rb +0 -0
- data/spec/api/bank_accounts_api_spec.rb +77 -44
- data/spec/api/billing_groups_api_spec.rb +0 -0
- data/spec/api/buckslip_orders_api_spec.rb +62 -0
- data/spec/api/buckslips_api_spec.rb +100 -0
- data/spec/api/campaigns_api_spec.rb +0 -0
- data/spec/api/card_orders_api_spec.rb +0 -0
- data/spec/api/cards_api_spec.rb +0 -0
- data/spec/api/checks_api_spec.rb +0 -0
- data/spec/api/creatives_api_spec.rb +0 -0
- data/spec/api/default_api_spec.rb +0 -0
- data/spec/api/identity_validation_api_spec.rb +0 -0
- data/spec/api/intl_autocompletions_api_spec.rb +0 -0
- data/spec/api/intl_verifications_api_spec.rb +0 -0
- data/spec/api/letters_api_spec.rb +0 -0
- data/spec/api/postcards_api_spec.rb +0 -0
- data/spec/api/reverse_geocode_lookups_api_spec.rb +0 -0
- data/spec/api/self_mailers_api_spec.rb +0 -0
- data/spec/api/snap_packs_api_spec.rb +94 -0
- data/spec/api/template_versions_api_spec.rb +0 -0
- data/spec/api/templates_api_spec.rb +0 -0
- data/spec/api/uploads_api_spec.rb +0 -0
- data/spec/api/us_autocompletions_api_spec.rb +0 -0
- data/spec/api/us_verifications_api_spec.rb +0 -0
- data/spec/api/zip_lookups_api_spec.rb +0 -0
- data/spec/api_client_spec.rb +0 -0
- data/spec/configuration_spec.rb +0 -0
- data/spec/spec_helper.rb +1 -1
- metadata +238 -208
- data/lib/openapi_client.rb +0 -212
- /data/lib/{openapi_client → lob}/api/addresses_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/bank_accounts_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/billing_groups_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/buckslip_orders_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/buckslips_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/campaigns_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/card_orders_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/cards_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/creatives_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/default_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/identity_validation_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/intl_autocompletions_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/intl_verifications_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/reverse_geocode_lookups_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/template_versions_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/templates_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/uploads_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/us_autocompletions_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/us_verifications_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/zip_lookups_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api_client.rb +0 -0
- /data/lib/{openapi_client → lob}/api_error.rb +0 -0
- /data/lib/{openapi_client → lob}/configuration.rb +0 -0
- /data/lib/{openapi_client → lob}/models/address_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/address_domestic.rb +0 -0
- /data/lib/{openapi_client → lob}/models/address_domestic_expanded.rb +0 -0
- /data/lib/{openapi_client → lob}/models/address_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/address_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/bank_account_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/bank_account_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/bank_account_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/bank_type_enum.rb +0 -0
- /data/lib/{openapi_client → lob}/models/billing_group.rb +0 -0
- /data/lib/{openapi_client → lob}/models/billing_group_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/billing_group_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip_order.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip_order_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip_orders_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip_updatable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslips_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/bulk_error.rb +0 -0
- /data/lib/{openapi_client → lob}/models/bulk_error_properties.rb +0 -0
- /data/lib/{openapi_client → lob}/models/campaign.rb +0 -0
- /data/lib/{openapi_client → lob}/models/campaign_creative.rb +0 -0
- /data/lib/{openapi_client → lob}/models/campaign_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/campaign_updatable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/campaign_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/campaigns_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_order.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_order_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_order_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_updatable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/check_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/check_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/check_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/chk_use_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/cmp_schedule_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/cmp_use_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/country_extended.rb +0 -0
- /data/lib/{openapi_client → lob}/models/country_extended_expanded.rb +0 -0
- /data/lib/{openapi_client → lob}/models/creative_patch.rb +0 -0
- /data/lib/{openapi_client → lob}/models/creative_response.rb +0 -0
- /data/lib/{openapi_client → lob}/models/creative_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/custom_envelope_returned.rb +0 -0
- /data/lib/{openapi_client → lob}/models/deliverability_analysis.rb +0 -0
- /data/lib/{openapi_client → lob}/models/dpv_footnote.rb +0 -0
- /data/lib/{openapi_client → lob}/models/engine_html.rb +0 -0
- /data/lib/{openapi_client → lob}/models/event_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/events.rb +0 -0
- /data/lib/{openapi_client → lob}/models/export.rb +0 -0
- /data/lib/{openapi_client → lob}/models/export_model.rb +0 -0
- /data/lib/{openapi_client → lob}/models/geocode_addresses.rb +0 -0
- /data/lib/{openapi_client → lob}/models/geocode_components.rb +0 -0
- /data/lib/{openapi_client → lob}/models/http_validation_error.rb +0 -0
- /data/lib/{openapi_client → lob}/models/identity_validation.rb +0 -0
- /data/lib/{openapi_client → lob}/models/inline_object.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_autocompletions.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_autocompletions_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_suggestions.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_verification.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_verification_or_error.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_verification_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_verifications.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_verifications_payload.rb +0 -0
- /data/lib/{openapi_client → lob}/models/letter_custom_envelope.rb +0 -0
- /data/lib/{openapi_client → lob}/models/letter_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/letter_details_returned.rb +0 -0
- /data/lib/{openapi_client → lob}/models/letter_details_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/letter_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/letter_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/lob_confidence_score.rb +0 -0
- /data/lib/{openapi_client → lob}/models/lob_error.rb +0 -0
- /data/lib/{openapi_client → lob}/models/location.rb +0 -0
- /data/lib/{openapi_client → lob}/models/location_analysis.rb +0 -0
- /data/lib/{openapi_client → lob}/models/ltr_use_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/mail_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/multi_line_address.rb +0 -0
- /data/lib/{openapi_client → lob}/models/multiple_components_intl.rb +0 -0
- /data/lib/{openapi_client → lob}/models/multiple_components_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/optional_address_column_mapping.rb +0 -0
- /data/lib/{openapi_client → lob}/models/placeholder_model.rb +0 -0
- /data/lib/{openapi_client → lob}/models/postcard_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/postcard_details_returned.rb +0 -0
- /data/lib/{openapi_client → lob}/models/postcard_details_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/postcard_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/postcard_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/postcard_size.rb +0 -0
- /data/lib/{openapi_client → lob}/models/psc_use_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/qr_code.rb +0 -0
- /data/lib/{openapi_client → lob}/models/required_address_column_mapping.rb +0 -0
- /data/lib/{openapi_client → lob}/models/return_envelope.rb +0 -0
- /data/lib/{openapi_client → lob}/models/reverse_geocode.rb +0 -0
- /data/lib/{openapi_client → lob}/models/self_mailer_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/self_mailer_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/self_mailer_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/sfm_use_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/sort_by.rb +0 -0
- /data/lib/{openapi_client → lob}/models/sort_by1.rb +0 -0
- /data/lib/{openapi_client → lob}/models/sort_by2.rb +0 -0
- /data/lib/{openapi_client → lob}/models/sort_by3.rb +0 -0
- /data/lib/{openapi_client → lob}/models/sort_by_date_modified.rb +0 -0
- /data/lib/{openapi_client → lob}/models/suggestions.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_update.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_version.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_version_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_version_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_version_updatable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_version_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/tracking_event_certified.rb +0 -0
- /data/lib/{openapi_client → lob}/models/tracking_event_details.rb +0 -0
- /data/lib/{openapi_client → lob}/models/tracking_event_normal.rb +0 -0
- /data/lib/{openapi_client → lob}/models/upload_create_export.rb +0 -0
- /data/lib/{openapi_client → lob}/models/upload_file.rb +0 -0
- /data/lib/{openapi_client → lob}/models/upload_state.rb +0 -0
- /data/lib/{openapi_client → lob}/models/upload_updatable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/upload_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/uploads_metadata.rb +0 -0
- /data/lib/{openapi_client → lob}/models/us_autocompletions.rb +0 -0
- /data/lib/{openapi_client → lob}/models/us_autocompletions_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/us_components.rb +0 -0
- /data/lib/{openapi_client → lob}/models/validation_error.rb +0 -0
- /data/lib/{openapi_client → lob}/models/zip.rb +0 -0
- /data/lib/{openapi_client → lob}/models/zip_code_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/zip_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/zip_lookup_city.rb +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# IntlVerification.spec.rb
|
|
2
2
|
require_relative '../TestFixtures'
|
|
3
3
|
include Lob
|
|
4
|
-
$:.unshift File.expand_path("../../lib/
|
|
4
|
+
$:.unshift File.expand_path("../../lib/lob", File.dirname(__FILE__))
|
|
5
5
|
|
|
6
6
|
RSpec.describe "IntlVerificationsApi" do
|
|
7
7
|
it "can be instantiated" do
|
|
@@ -47,14 +47,14 @@ RSpec.describe "IntlVerificationsApi" do
|
|
|
47
47
|
})
|
|
48
48
|
end
|
|
49
49
|
|
|
50
|
-
|
|
50
|
+
skip "Verifies valid addresses in bulk" do
|
|
51
51
|
verifiedList = @intlVerificationApi.verifyBulk(@addressList)
|
|
52
52
|
expect(verifiedList.addresses.length()).to be(2)
|
|
53
53
|
expect(verifiedList.addresses[0].deliverability).to eq("deliverable")
|
|
54
54
|
expect(verifiedList.addresses[1].deliverability).to eq("deliverable_missing_info")
|
|
55
55
|
end
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
skip "Verifies single deliverable address" do
|
|
58
58
|
verifiedAddr = @intlVerificationApi.verifySingle(@validAddress)
|
|
59
59
|
expect(verifiedAddr.deliverability).to eq("deliverable")
|
|
60
60
|
end
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Letter.spec.rb
|
|
2
2
|
require_relative '../TestFixtures'
|
|
3
3
|
include Lob
|
|
4
|
-
$:.unshift File.expand_path("../../lib/
|
|
4
|
+
$:.unshift File.expand_path("../../lib/lob", File.dirname(__FILE__))
|
|
5
5
|
require 'uri'
|
|
6
6
|
|
|
7
7
|
RSpec.describe "LettersApi" do
|
|
@@ -32,7 +32,8 @@ RSpec.describe "LettersApi" do
|
|
|
32
32
|
to: @someAddr.id,
|
|
33
33
|
from: @someAddr.id,
|
|
34
34
|
file: TestFixtures.FILE_LOCATION_8X11,
|
|
35
|
-
color: true
|
|
35
|
+
color: true,
|
|
36
|
+
use_type: 'marketing'
|
|
36
37
|
})
|
|
37
38
|
end
|
|
38
39
|
|
|
@@ -94,7 +95,8 @@ RSpec.describe "LettersApi" do
|
|
|
94
95
|
to: @someAddr.id,
|
|
95
96
|
from: @someAddr.id,
|
|
96
97
|
file: TestFixtures.FILE_LOCATION_8X11,
|
|
97
|
-
color: true
|
|
98
|
+
color: true,
|
|
99
|
+
use_type: 'marketing'
|
|
98
100
|
})
|
|
99
101
|
|
|
100
102
|
response = @letterApi.create(letterEditable)
|
|
@@ -134,21 +136,24 @@ RSpec.describe "LettersApi" do
|
|
|
134
136
|
to: @someAddr.id,
|
|
135
137
|
from: @someAddr.id,
|
|
136
138
|
file: TestFixtures.FILE_LOCATION_8X11,
|
|
137
|
-
color: true
|
|
139
|
+
color: true,
|
|
140
|
+
use_type: 'marketing'
|
|
138
141
|
})
|
|
139
142
|
|
|
140
143
|
letterEditable2 = LetterEditable.new({
|
|
141
144
|
to: @someAddr.id,
|
|
142
145
|
from: @someAddr.id,
|
|
143
146
|
file: TestFixtures.FILE_LOCATION_8X11,
|
|
144
|
-
color: true
|
|
147
|
+
color: true,
|
|
148
|
+
use_type: 'marketing'
|
|
145
149
|
})
|
|
146
150
|
|
|
147
151
|
letterEditable3 = LetterEditable.new({
|
|
148
152
|
to: @someAddr.id,
|
|
149
153
|
from: @someAddr.id,
|
|
150
154
|
file: TestFixtures.FILE_LOCATION_8X11,
|
|
151
|
-
color: true
|
|
155
|
+
color: true,
|
|
156
|
+
use_type: 'marketing'
|
|
152
157
|
})
|
|
153
158
|
|
|
154
159
|
response1 = @letterApi.create(letterEditable1)
|
|
@@ -173,7 +178,7 @@ RSpec.describe "LettersApi" do
|
|
|
173
178
|
|
|
174
179
|
expect(response.data[0].id).not_to eq(first_ltr_id)
|
|
175
180
|
|
|
176
|
-
uri = URI.parse(response.
|
|
181
|
+
uri = URI.parse(response.previous_url)
|
|
177
182
|
params = CGI.parse(uri.query)
|
|
178
183
|
|
|
179
184
|
response = @letterApi.list({ :"limit" => 2, :"before" => params["before"][0] })
|
|
@@ -191,7 +196,7 @@ RSpec.describe "LettersApi" do
|
|
|
191
196
|
["mail_type", nil, nil, nil, nil, nil, nil, MailType::FIRST_CLASS, nil, nil],
|
|
192
197
|
["sort_by", nil, nil, nil, nil, nil, nil, nil, { "date_created": "asc" }],
|
|
193
198
|
].each do |which_param, include_param, date_created, metadata, color, scheduled, send_date, mail_type, sort_by|
|
|
194
|
-
|
|
199
|
+
skip "lists letters #{which_param && ("with " + which_param + " param")}" do
|
|
195
200
|
args = {}
|
|
196
201
|
|
|
197
202
|
if include_param then
|
|
@@ -265,7 +270,9 @@ RSpec.describe "LettersApi" do
|
|
|
265
270
|
to: @someAddr.id,
|
|
266
271
|
from: @someAddr.id,
|
|
267
272
|
file: TestFixtures.FILE_LOCATION_8X11,
|
|
268
|
-
color: true
|
|
273
|
+
color: true,
|
|
274
|
+
use_type: 'marketing'
|
|
275
|
+
|
|
269
276
|
})
|
|
270
277
|
|
|
271
278
|
response = @letterApi.create(letterEditable)
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Postcard.spec.rb
|
|
2
2
|
require_relative '../TestFixtures'
|
|
3
3
|
include Lob
|
|
4
|
-
$:.unshift File.expand_path("../../lib/
|
|
4
|
+
$:.unshift File.expand_path("../../lib/lob", File.dirname(__FILE__))
|
|
5
5
|
require 'uri'
|
|
6
6
|
|
|
7
7
|
RSpec.describe "Postcards Api" do
|
|
@@ -39,7 +39,7 @@ RSpec.describe "Postcards Api" do
|
|
|
39
39
|
from: @addressEditable2,
|
|
40
40
|
front: TestFixtures.FILE_LOCATION_4x6,
|
|
41
41
|
back: TestFixtures.FILE_LOCATION_4x6,
|
|
42
|
-
|
|
42
|
+
use_type: 'marketing'
|
|
43
43
|
});
|
|
44
44
|
end
|
|
45
45
|
|
|
@@ -103,7 +103,7 @@ RSpec.describe "Postcards Api" do
|
|
|
103
103
|
from: @addressEditable2,
|
|
104
104
|
front: TestFixtures.FILE_LOCATION_4x6,
|
|
105
105
|
back: TestFixtures.FILE_LOCATION_4x6,
|
|
106
|
-
|
|
106
|
+
use_type: 'marketing'
|
|
107
107
|
});
|
|
108
108
|
|
|
109
109
|
response = @postcardApi.create(@dummyPostcard)
|
|
@@ -126,6 +126,38 @@ RSpec.describe "Postcards Api" do
|
|
|
126
126
|
before(:all) do
|
|
127
127
|
api = TestFixtures.api_client_with_test_key()
|
|
128
128
|
@postcardApi = PostcardsApi.new(api)
|
|
129
|
+
|
|
130
|
+
addressEditable1 = AddressEditable.new({
|
|
131
|
+
name: "Thing T. Thing",
|
|
132
|
+
address_line1: "1313 CEMETERY LN",
|
|
133
|
+
address_city: "WESTFIELD",
|
|
134
|
+
address_state: "NJ",
|
|
135
|
+
address_zip: "07000",
|
|
136
|
+
})
|
|
137
|
+
|
|
138
|
+
addressEditable2 = AddressEditable.new({
|
|
139
|
+
name: "FESTER",
|
|
140
|
+
address_line1: "001 CEMETERY LN",
|
|
141
|
+
address_line2: "SUITE 666",
|
|
142
|
+
address_city: "WESTFIELD",
|
|
143
|
+
address_state: "NJ",
|
|
144
|
+
address_zip: "07000",
|
|
145
|
+
})
|
|
146
|
+
|
|
147
|
+
dummyPostcard = PostcardEditable.new({
|
|
148
|
+
to: addressEditable1,
|
|
149
|
+
from: addressEditable2,
|
|
150
|
+
front: TestFixtures.FILE_LOCATION_4x6,
|
|
151
|
+
back: TestFixtures.FILE_LOCATION_4x6,
|
|
152
|
+
use_type: 'marketing'
|
|
153
|
+
})
|
|
154
|
+
|
|
155
|
+
response1 = @postcardApi.create(dummyPostcard)
|
|
156
|
+
response2 = @postcardApi.create(dummyPostcard)
|
|
157
|
+
response3 = @postcardApi.create(dummyPostcard)
|
|
158
|
+
response4 = @postcardApi.create(dummyPostcard)
|
|
159
|
+
response5 = @postcardApi.create(dummyPostcard)
|
|
160
|
+
@postcardIds = [response1.id, response2.id, response3.id, response4.id, response5.id]
|
|
129
161
|
end
|
|
130
162
|
|
|
131
163
|
it "lists postcards with limit, before, and after params" do
|
|
@@ -168,6 +200,10 @@ RSpec.describe "Postcards Api" do
|
|
|
168
200
|
end
|
|
169
201
|
end
|
|
170
202
|
end
|
|
203
|
+
|
|
204
|
+
after(:all) do
|
|
205
|
+
@postcardIds.each { |id| @postcardApi.cancel(id) }
|
|
206
|
+
end
|
|
171
207
|
end
|
|
172
208
|
|
|
173
209
|
describe "cancel" do
|
|
@@ -197,7 +233,7 @@ RSpec.describe "Postcards Api" do
|
|
|
197
233
|
from: @addressEditable2,
|
|
198
234
|
front: TestFixtures.FILE_LOCATION_4x6,
|
|
199
235
|
back: TestFixtures.FILE_LOCATION_4x6,
|
|
200
|
-
|
|
236
|
+
use_type: 'marketing'
|
|
201
237
|
});
|
|
202
238
|
|
|
203
239
|
response = @postcardApi.create(@dummyPostcard)
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# UsAutocompletion.spec.rb
|
|
2
2
|
require_relative '../TestFixtures'
|
|
3
3
|
include Lob
|
|
4
|
-
$:.unshift File.expand_path("../../lib/
|
|
4
|
+
$:.unshift File.expand_path("../../lib/lob", File.dirname(__FILE__))
|
|
5
5
|
|
|
6
6
|
RSpec.describe "ReverseGeocodeLookupsApi" do
|
|
7
7
|
it "can be instantiated" do
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# SelfMailer.spec.rb
|
|
2
2
|
require_relative '../TestFixtures'
|
|
3
3
|
include Lob
|
|
4
|
-
$:.unshift File.expand_path("../../lib/
|
|
4
|
+
$:.unshift File.expand_path("../../lib/lob", File.dirname(__FILE__))
|
|
5
5
|
require 'uri'
|
|
6
6
|
|
|
7
7
|
RSpec.describe "SelfMailersApi" do
|
|
@@ -138,13 +138,31 @@ RSpec.describe "SelfMailersApi" do
|
|
|
138
138
|
use_type: SfmUseType::MARKETING
|
|
139
139
|
})
|
|
140
140
|
|
|
141
|
+
selfMailerEditable4 = SelfMailerEditable.new({
|
|
142
|
+
to: addr,
|
|
143
|
+
inside: TestFixtures.FILE_LOCATION_6X18,
|
|
144
|
+
outside: TestFixtures.FILE_LOCATION_6X18,
|
|
145
|
+
use_type: SfmUseType::MARKETING
|
|
146
|
+
})
|
|
147
|
+
|
|
148
|
+
selfMailerEditable5 = SelfMailerEditable.new({
|
|
149
|
+
to: addr,
|
|
150
|
+
inside: TestFixtures.FILE_LOCATION_6X18,
|
|
151
|
+
outside: TestFixtures.FILE_LOCATION_6X18,
|
|
152
|
+
use_type: SfmUseType::MARKETING
|
|
153
|
+
})
|
|
154
|
+
|
|
141
155
|
response1 = @selfMailerApi.create(selfMailerEditable1)
|
|
142
156
|
response2 = @selfMailerApi.create(selfMailerEditable2)
|
|
143
157
|
response3 = @selfMailerApi.create(selfMailerEditable3)
|
|
158
|
+
response4 = @selfMailerApi.create(selfMailerEditable4)
|
|
159
|
+
response5 = @selfMailerApi.create(selfMailerEditable5)
|
|
144
160
|
|
|
145
161
|
@selfMailer1Id = response1.id
|
|
146
162
|
@selfMailer2Id = response2.id
|
|
147
163
|
@selfMailer3Id = response3.id
|
|
164
|
+
@selfMailer4Id = response4.id
|
|
165
|
+
@selfMailer5Id = response5.id
|
|
148
166
|
end
|
|
149
167
|
|
|
150
168
|
it "lists self mailers with limit, before, and after params" do
|
|
@@ -179,7 +197,7 @@ RSpec.describe "SelfMailersApi" do
|
|
|
179
197
|
["mail_type", nil, nil, nil, nil, nil, nil, MailType::FIRST_CLASS, nil],
|
|
180
198
|
["sort_by", nil, nil, nil, nil, nil, nil, nil, { "date_created": "asc" }]
|
|
181
199
|
].each do |which_param, include_param, date_created, metadata, size, scheduled, send_date, mail_type, sort_by|
|
|
182
|
-
|
|
200
|
+
skip "lists self mailers #{which_param && ("with " + which_param + " param")}" do
|
|
183
201
|
args = {}
|
|
184
202
|
|
|
185
203
|
if include_param then
|
|
@@ -232,6 +250,8 @@ RSpec.describe "SelfMailersApi" do
|
|
|
232
250
|
@selfMailerApi.delete(@selfMailer1Id)
|
|
233
251
|
@selfMailerApi.delete(@selfMailer2Id)
|
|
234
252
|
@selfMailerApi.delete(@selfMailer3Id)
|
|
253
|
+
@selfMailerApi.delete(@selfMailer4Id)
|
|
254
|
+
@selfMailerApi.delete(@selfMailer5Id)
|
|
235
255
|
end
|
|
236
256
|
end
|
|
237
257
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Template.spec.rb
|
|
2
2
|
require_relative '../TestFixtures'
|
|
3
3
|
include Lob
|
|
4
|
-
$:.unshift File.expand_path("../../lib/
|
|
4
|
+
$:.unshift File.expand_path("../../lib/lob", File.dirname(__FILE__))
|
|
5
5
|
require 'uri'
|
|
6
6
|
|
|
7
7
|
RSpec.describe "TemplatesApi" do
|
|
@@ -98,7 +98,8 @@ RSpec.describe "TemplatesApi" do
|
|
|
98
98
|
|
|
99
99
|
templateWritable3 = TemplateWritable.new({
|
|
100
100
|
description: "Ruby Integration Test",
|
|
101
|
-
html: "<html>Updated HTML for Ruby Integration Test</html>"
|
|
101
|
+
html: "<html>Updated HTML for Ruby Integration Test</html>",
|
|
102
|
+
metadata: { name: "Harry" }
|
|
102
103
|
})
|
|
103
104
|
|
|
104
105
|
response1 = @templateApi.create(templateWritable1)
|
|
@@ -123,7 +124,7 @@ RSpec.describe "TemplatesApi" do
|
|
|
123
124
|
|
|
124
125
|
expect(response.data[0].id).not_to eq(first_tmpl_id)
|
|
125
126
|
|
|
126
|
-
uri = URI.parse(response.
|
|
127
|
+
uri = URI.parse(response.previous_url)
|
|
127
128
|
params = CGI.parse(uri.query)
|
|
128
129
|
|
|
129
130
|
response = @templateApi.list({ :"limit" => 2, :"before" => params["before"][0] })
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# TemplateVersion.spec.rb
|
|
2
2
|
require_relative '../TestFixtures'
|
|
3
3
|
include Lob
|
|
4
|
-
$:.unshift File.expand_path("../../lib/
|
|
4
|
+
$:.unshift File.expand_path("../../lib/lob", File.dirname(__FILE__))
|
|
5
5
|
require 'uri'
|
|
6
6
|
|
|
7
7
|
RSpec.describe "TemplateVersionsApi" do
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# UsAutocompletion.spec.rb
|
|
2
2
|
require_relative '../TestFixtures'
|
|
3
3
|
include Lob
|
|
4
|
-
$:.unshift File.expand_path("../../lib/
|
|
4
|
+
$:.unshift File.expand_path("../../lib/lob", File.dirname(__FILE__))
|
|
5
5
|
|
|
6
6
|
RSpec.describe "UsAutocompletionsApi" do
|
|
7
7
|
it "can be instantiated" do
|
|
@@ -24,7 +24,6 @@ RSpec.describe "UsAutocompletionsApi" do
|
|
|
24
24
|
|
|
25
25
|
it "Autocompletes US address (with test key)" do
|
|
26
26
|
autocompletedAddr = @usAutocompletionApi.autocomplete(@validAddress)
|
|
27
|
-
puts autocompletedAddr.suggestions[0].primary_line
|
|
28
27
|
expect(autocompletedAddr.suggestions[0].primary_line).to eq("1 TELEGRAPH HILL BLVD")
|
|
29
28
|
end
|
|
30
29
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# UsVerification.spec.rb
|
|
2
2
|
require_relative '../TestFixtures'
|
|
3
3
|
include Lob
|
|
4
|
-
$:.unshift File.expand_path("../../lib/
|
|
4
|
+
$:.unshift File.expand_path("../../lib/lob", File.dirname(__FILE__))
|
|
5
5
|
|
|
6
6
|
RSpec.describe "UsVerificationsApi" do
|
|
7
7
|
it "can be instantiated" do
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# UsAutocompletion.spec.rb
|
|
2
2
|
require_relative '../TestFixtures'
|
|
3
3
|
include Lob
|
|
4
|
-
$:.unshift File.expand_path("../../lib/
|
|
4
|
+
$:.unshift File.expand_path("../../lib/lob", File.dirname(__FILE__))
|
|
5
5
|
|
|
6
6
|
RSpec.describe "ZipLookupsApi" do
|
|
7
7
|
it "can be instantiated" do
|
data/__tests__/TestFixtures.rb
CHANGED
|
File without changes
|
data/docs/Address.md
CHANGED
|
@@ -1,49 +1,52 @@
|
|
|
1
1
|
# Lob::Address
|
|
2
2
|
|
|
3
|
-
##
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier prefixed with `adr_`. | [optional] |
|
|
8
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
|
9
|
+
| **name** | **String** | name associated with address | [optional] |
|
|
10
|
+
| **company** | **String** | Either `name` or `company` is required, you may also add both. | [optional] |
|
|
11
|
+
| **phone** | **String** | Must be no longer than 40 characters. | [optional] |
|
|
12
|
+
| **email** | **String** | Must be no longer than 100 characters. | [optional] |
|
|
13
|
+
| **metadata** | **Hash<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] |
|
|
14
|
+
| **address_line1** | **String** | | [optional] |
|
|
15
|
+
| **address_line2** | **String** | | [optional] |
|
|
16
|
+
| **address_city** | **String** | | [optional] |
|
|
17
|
+
| **address_state** | **String** | 2 letter state short-name code for US address or must be no longer than 200 characters for non-US address. | [optional] |
|
|
18
|
+
| **address_zip** | **String** | Must follow the ZIP format of `12345` or ZIP+4 format of `12345-1234` for US address or must be no longer than 40 characters for non-US address. | [optional] |
|
|
19
|
+
| **address_country** | [**CountryExtendedExpanded**](CountryExtendedExpanded.md) | | [optional] |
|
|
20
|
+
| **object** | **String** | | [optional][default to 'address'] |
|
|
21
|
+
| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] |
|
|
22
|
+
| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] |
|
|
23
|
+
| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
|
|
24
|
+
| **recipient_moved** | **Boolean** | 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] |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
27
|
|
|
28
28
|
```ruby
|
|
29
29
|
require 'lob'
|
|
30
30
|
|
|
31
|
-
Lob::Address.build(
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
31
|
+
instance = Lob::Address.build(
|
|
32
|
+
id: null,
|
|
33
|
+
description: null,
|
|
34
|
+
name: null,
|
|
35
|
+
company: null,
|
|
36
|
+
phone: null,
|
|
37
|
+
email: null,
|
|
38
|
+
metadata: null,
|
|
39
|
+
address_line1: null,
|
|
40
|
+
address_line2: null,
|
|
41
|
+
address_city: null,
|
|
42
|
+
address_state: null,
|
|
43
|
+
address_zip: null,
|
|
44
|
+
address_country: null,
|
|
45
|
+
object: null,
|
|
46
|
+
date_created: null,
|
|
47
|
+
date_modified: null,
|
|
48
|
+
deleted: null,
|
|
49
|
+
recipient_moved: null
|
|
50
|
+
)
|
|
36
51
|
```
|
|
37
52
|
|
|
38
|
-
#### Parameters
|
|
39
|
-
|
|
40
|
-
| Name | Type | Description |
|
|
41
|
-
| ---- | ---- | ----------- |
|
|
42
|
-
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
|
43
|
-
|
|
44
|
-
#### Return type
|
|
45
|
-
|
|
46
|
-
- `IntlAddress`
|
|
47
|
-
- `UsAddress`
|
|
48
|
-
- `nil` (if no type matches)
|
|
49
|
-
|
data/docs/AddressDeletion.md
CHANGED
data/docs/AddressDomestic.md
CHANGED
data/docs/AddressEditable.md
CHANGED
data/docs/AddressList.md
CHANGED
data/docs/AddressesApi.md
CHANGED
|
@@ -22,7 +22,7 @@ Creates a new address given information
|
|
|
22
22
|
|
|
23
23
|
```ruby
|
|
24
24
|
require 'time'
|
|
25
|
-
require '
|
|
25
|
+
require 'lob'
|
|
26
26
|
# setup authorization
|
|
27
27
|
Lob.configure do |config|
|
|
28
28
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -92,7 +92,7 @@ Deletes the details of an existing address.
|
|
|
92
92
|
|
|
93
93
|
```ruby
|
|
94
94
|
require 'time'
|
|
95
|
-
require '
|
|
95
|
+
require 'lob'
|
|
96
96
|
# setup authorization
|
|
97
97
|
Lob.configure do |config|
|
|
98
98
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -162,7 +162,7 @@ Retrieves the details of an existing address.
|
|
|
162
162
|
|
|
163
163
|
```ruby
|
|
164
164
|
require 'time'
|
|
165
|
-
require '
|
|
165
|
+
require 'lob'
|
|
166
166
|
# setup authorization
|
|
167
167
|
Lob.configure do |config|
|
|
168
168
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -232,7 +232,7 @@ Returns a list of your addresses.
|
|
|
232
232
|
|
|
233
233
|
```ruby
|
|
234
234
|
require 'time'
|
|
235
|
-
require '
|
|
235
|
+
require 'lob'
|
|
236
236
|
# setup authorization
|
|
237
237
|
Lob.configure do |config|
|
|
238
238
|
# Configure HTTP basic authorization: basicAuth
|
data/docs/BankAccount.md
CHANGED
data/docs/BankAccountDeletion.md
CHANGED
data/docs/BankAccountList.md
CHANGED
data/docs/BankAccountVerify.md
CHANGED
data/docs/BankAccountWritable.md
CHANGED
data/docs/BankAccountsApi.md
CHANGED
|
@@ -23,7 +23,7 @@ Creates a new bank account with the provided properties. Bank accounts created i
|
|
|
23
23
|
|
|
24
24
|
```ruby
|
|
25
25
|
require 'time'
|
|
26
|
-
require '
|
|
26
|
+
require 'lob'
|
|
27
27
|
# setup authorization
|
|
28
28
|
Lob.configure do |config|
|
|
29
29
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -93,7 +93,7 @@ Permanently deletes a bank account. It cannot be undone.
|
|
|
93
93
|
|
|
94
94
|
```ruby
|
|
95
95
|
require 'time'
|
|
96
|
-
require '
|
|
96
|
+
require 'lob'
|
|
97
97
|
# setup authorization
|
|
98
98
|
Lob.configure do |config|
|
|
99
99
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -163,7 +163,7 @@ Retrieves the details of an existing bank account. You need only supply the uniq
|
|
|
163
163
|
|
|
164
164
|
```ruby
|
|
165
165
|
require 'time'
|
|
166
|
-
require '
|
|
166
|
+
require 'lob'
|
|
167
167
|
# setup authorization
|
|
168
168
|
Lob.configure do |config|
|
|
169
169
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -233,7 +233,7 @@ Verify a bank account in order to create a check.
|
|
|
233
233
|
|
|
234
234
|
```ruby
|
|
235
235
|
require 'time'
|
|
236
|
-
require '
|
|
236
|
+
require 'lob'
|
|
237
237
|
# setup authorization
|
|
238
238
|
Lob.configure do |config|
|
|
239
239
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -305,7 +305,7 @@ Returns a list of your bank accounts. The bank accounts are returned sorted by c
|
|
|
305
305
|
|
|
306
306
|
```ruby
|
|
307
307
|
require 'time'
|
|
308
|
-
require '
|
|
308
|
+
require 'lob'
|
|
309
309
|
# setup authorization
|
|
310
310
|
Lob.configure do |config|
|
|
311
311
|
# Configure HTTP basic authorization: basicAuth
|
data/docs/BankTypeEnum.md
CHANGED
data/docs/BillingGroup.md
CHANGED