lob 6.0.8 → 6.0.9
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 +2 -2
- data/LICENSE +0 -0
- data/MIGRATION.md +0 -0
- data/Rakefile +0 -0
- data/__tests__/Api/Address.unit.rb +1 -1
- data/__tests__/Api/BankAccount.unit.rb +1 -1
- 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 +1 -1
- 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 +9 -5
- data/__tests__/Integration/IntlAutocompletion.spec.rb +2 -2
- data/__tests__/Integration/IntlVerification.spec.rb +3 -3
- data/__tests__/Integration/Letter.spec.rb +15 -8
- data/__tests__/Integration/Postcard.spec.rb +4 -4
- data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +1 -1
- data/__tests__/Integration/SelfMailer.spec.rb +2 -2
- data/__tests__/Integration/Template.spec.rb +1 -1
- data/__tests__/Integration/TemplateVersion.spec.rb +1 -1
- data/__tests__/Integration/UsAutocompletion.spec.rb +1 -1
- 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 +0 -0
- 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/lob/api_client.rb +392 -0
- data/lib/lob/api_error.rb +57 -0
- data/lib/lob/configuration.rb +279 -0
- data/lib/lob/models/address.rb +616 -0
- data/lib/{openapi_client → lob}/models/bank_account.rb +3 -3
- 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 +0 -0
- 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/lob/version.rb +15 -0
- data/lib/lob.rb +220 -1
- data/lib/openapi_client/version.rb +1 -1
- data/lib/openapi_client.rb +173 -173
- 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 +0 -0
- 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 +236 -201
- data/lib/openapi_client/models/address.rb +0 -105
- /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}/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_verify.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
data/docs/Upload.md
CHANGED
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **id** | **String** | Unique identifier prefixed with `upl_`. | |
|
|
8
8
|
| **account_id** | **String** | Account ID that made the request | |
|
|
9
|
-
| **campaign_id** | **String** | Unique identifier prefixed with `cmp_`. | |
|
|
10
9
|
| **mode** | **String** | The environment in which the mailpieces were created. Today, will only be `live`. | |
|
|
10
|
+
| **campaign_id** | **String** | Campaign ID associated with the upload | |
|
|
11
11
|
| **failures_url** | **String** | Url where your campaign mailpiece failures can be retrieved | [optional] |
|
|
12
12
|
| **original_filename** | **String** | Filename of the upload | [optional] |
|
|
13
13
|
| **state** | [**UploadState**](UploadState.md) | | [default to 'Draft'] |
|
|
@@ -17,18 +17,21 @@
|
|
|
17
17
|
| **bytes_processed** | **Integer** | Number of bytes processed in your CSV | |
|
|
18
18
|
| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the upload was created | |
|
|
19
19
|
| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the upload was last modified | |
|
|
20
|
-
| **
|
|
20
|
+
| **required_address_column_mapping** | [**RequiredAddressColumnMapping**](RequiredAddressColumnMapping.md) | | |
|
|
21
|
+
| **optional_address_column_mapping** | [**OptionalAddressColumnMapping**](OptionalAddressColumnMapping.md) | | |
|
|
22
|
+
| **metadata** | [**UploadsMetadata**](UploadsMetadata.md) | | |
|
|
23
|
+
| **merge_variable_column_mapping** | **Object** | The mapping of column headers in your file to the merge variables present in your creative. See our <a href=\"https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide#step-3-map-merge-variable-data-if-applicable-7\" target=\"_blank\">Campaign Audience Guide</a> for additional details. <br />If a merge variable has the same \"name\" as a \"key\" in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects, then they **CANNOT** have a different value in this object. If a different value is provided, then when the campaign is processing it will get overwritten with the mapped value present in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects. | |
|
|
21
24
|
|
|
22
25
|
## Example
|
|
23
26
|
|
|
24
27
|
```ruby
|
|
25
|
-
require '
|
|
28
|
+
require 'lob'
|
|
26
29
|
|
|
27
30
|
instance = Lob::Upload.new(
|
|
28
31
|
id: null,
|
|
29
|
-
account_id:
|
|
30
|
-
campaign_id: null,
|
|
32
|
+
account_id: fa9ea650fc7b31a89f92,
|
|
31
33
|
mode: null,
|
|
34
|
+
campaign_id: null,
|
|
32
35
|
failures_url: null,
|
|
33
36
|
original_filename: null,
|
|
34
37
|
state: null,
|
|
@@ -38,7 +41,10 @@ instance = Lob::Upload.new(
|
|
|
38
41
|
bytes_processed: null,
|
|
39
42
|
date_created: null,
|
|
40
43
|
date_modified: null,
|
|
41
|
-
|
|
44
|
+
required_address_column_mapping: null,
|
|
45
|
+
optional_address_column_mapping: null,
|
|
46
|
+
metadata: null,
|
|
47
|
+
merge_variable_column_mapping: {"name":"recipient_name","gift_code":"code"}
|
|
42
48
|
)
|
|
43
49
|
```
|
|
44
50
|
|
data/docs/UploadCreateExport.md
CHANGED
data/docs/UploadFile.md
CHANGED
data/docs/UploadState.md
CHANGED
data/docs/UploadUpdatable.md
CHANGED
|
@@ -4,17 +4,23 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **state** | [**UploadState**](UploadState.md) | | [optional][default to 'Draft'] |
|
|
8
7
|
| **original_filename** | **String** | Original filename provided when the upload is created. | [optional] |
|
|
8
|
+
| **required_address_column_mapping** | [**RequiredAddressColumnMapping**](RequiredAddressColumnMapping.md) | | [optional] |
|
|
9
|
+
| **optional_address_column_mapping** | [**OptionalAddressColumnMapping**](OptionalAddressColumnMapping.md) | | [optional] |
|
|
10
|
+
| **metadata** | [**UploadsMetadata**](UploadsMetadata.md) | | [optional] |
|
|
11
|
+
| **merge_variable_column_mapping** | **Object** | The mapping of column headers in your file to the merge variables present in your creative. See our <a href=\"https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide#step-3-map-merge-variable-data-if-applicable-7\" target=\"_blank\">Campaign Audience Guide</a> for additional details. <br />If a merge variable has the same \"name\" as a \"key\" in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects, then they **CANNOT** have a different value in this object. If a different value is provided, then when the campaign is processing it will get overwritten with the mapped value present in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects. | [optional] |
|
|
9
12
|
|
|
10
13
|
## Example
|
|
11
14
|
|
|
12
15
|
```ruby
|
|
13
|
-
require '
|
|
16
|
+
require 'lob'
|
|
14
17
|
|
|
15
18
|
instance = Lob::UploadUpdatable.new(
|
|
16
|
-
|
|
17
|
-
|
|
19
|
+
original_filename: null,
|
|
20
|
+
required_address_column_mapping: null,
|
|
21
|
+
optional_address_column_mapping: null,
|
|
22
|
+
metadata: null,
|
|
23
|
+
merge_variable_column_mapping: {"name":"recipient_name","gift_code":"code"}
|
|
18
24
|
)
|
|
19
25
|
```
|
|
20
26
|
|
data/docs/UploadWritable.md
CHANGED
|
@@ -4,15 +4,23 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **campaign_id** | **String** |
|
|
7
|
+
| **campaign_id** | **String** | | |
|
|
8
|
+
| **required_address_column_mapping** | [**RequiredAddressColumnMapping**](RequiredAddressColumnMapping.md) | | [optional] |
|
|
9
|
+
| **optional_address_column_mapping** | [**OptionalAddressColumnMapping**](OptionalAddressColumnMapping.md) | | [optional] |
|
|
10
|
+
| **metadata** | [**UploadsMetadata**](UploadsMetadata.md) | | [optional] |
|
|
11
|
+
| **merge_variable_column_mapping** | **Object** | The mapping of column headers in your file to the merge variables present in your creative. See our <a href=\"https://help.lob.com/print-and-mail/building-a-mail-strategy/campaign-or-triggered-sends/campaign-audience-guide#step-3-map-merge-variable-data-if-applicable-7\" target=\"_blank\">Campaign Audience Guide</a> for additional details. <br />If a merge variable has the same \"name\" as a \"key\" in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects, then they **CANNOT** have a different value in this object. If a different value is provided, then when the campaign is processing it will get overwritten with the mapped value present in the `requiredAddressColumnMapping` or `optionalAddressColumnMapping` objects. | [optional] |
|
|
8
12
|
|
|
9
13
|
## Example
|
|
10
14
|
|
|
11
15
|
```ruby
|
|
12
|
-
require '
|
|
16
|
+
require 'lob'
|
|
13
17
|
|
|
14
18
|
instance = Lob::UploadWritable.new(
|
|
15
|
-
campaign_id: null
|
|
19
|
+
campaign_id: null,
|
|
20
|
+
required_address_column_mapping: null,
|
|
21
|
+
optional_address_column_mapping: null,
|
|
22
|
+
metadata: null,
|
|
23
|
+
merge_variable_column_mapping: {"name":"recipient_name","gift_code":"code"}
|
|
16
24
|
)
|
|
17
25
|
```
|
|
18
26
|
|
data/docs/UploadsApi.md
CHANGED
|
@@ -5,13 +5,13 @@ All URIs are relative to *https://api.lob.com/v1*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**export_retrieve**](UploadsApi.md#export_retrieve) | **GET** /uploads/{upl_id}/exports/{ex_id} | get_export |
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
8
|
+
| [**get**](UploadsApi.md#get) | **GET** /uploads/{upl_id} | get |
|
|
9
|
+
| [**upload_create**](UploadsApi.md#upload_create) | **POST** /uploads | create |
|
|
10
|
+
| [**upload_delete**](UploadsApi.md#upload_delete) | **DELETE** /uploads/{upl_id} | delete |
|
|
10
11
|
| [**upload_export_create**](UploadsApi.md#upload_export_create) | **POST** /uploads/{upl_id}/exports | create_export |
|
|
11
12
|
| [**upload_file_create**](UploadsApi.md#upload_file_create) | **POST** /uploads/{upl_id}/file | upload_file |
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
14
|
-
| [**uploads_list**](UploadsApi.md#uploads_list) | **GET** /uploads | list_upload |
|
|
13
|
+
| [**upload_update**](UploadsApi.md#upload_update) | **PATCH** /uploads/{upl_id} | update |
|
|
14
|
+
| [**uploads_list**](UploadsApi.md#uploads_list) | **GET** /uploads | list |
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
## export_retrieve
|
|
@@ -26,7 +26,7 @@ Retrieves the details of an existing export. You need only supply the unique exp
|
|
|
26
26
|
|
|
27
27
|
```ruby
|
|
28
28
|
require 'time'
|
|
29
|
-
require '
|
|
29
|
+
require 'lob'
|
|
30
30
|
# setup authorization
|
|
31
31
|
Lob.configure do |config|
|
|
32
32
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -86,11 +86,81 @@ end
|
|
|
86
86
|
- **Accept**: application/json
|
|
87
87
|
|
|
88
88
|
|
|
89
|
+
## get
|
|
90
|
+
|
|
91
|
+
> <Upload> get(upl_id)
|
|
92
|
+
|
|
93
|
+
get
|
|
94
|
+
|
|
95
|
+
Retrieves the details of an existing upload. You need only supply the unique upload identifier that was returned upon upload creation.
|
|
96
|
+
|
|
97
|
+
### Examples
|
|
98
|
+
|
|
99
|
+
```ruby
|
|
100
|
+
require 'time'
|
|
101
|
+
require 'lob'
|
|
102
|
+
# setup authorization
|
|
103
|
+
Lob.configure do |config|
|
|
104
|
+
# Configure HTTP basic authorization: basicAuth
|
|
105
|
+
config.username = 'YOUR USERNAME'
|
|
106
|
+
config.password = 'YOUR PASSWORD'
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
api_instance = Lob::UploadsApi.new
|
|
110
|
+
upl_id = 'upl_id_example' # String | id of the upload
|
|
111
|
+
|
|
112
|
+
begin
|
|
113
|
+
# get
|
|
114
|
+
result = api_instance.get(upl_id)
|
|
115
|
+
p result
|
|
116
|
+
rescue Lob::ApiError => e
|
|
117
|
+
puts "Error when calling UploadsApi->get: #{e}"
|
|
118
|
+
end
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
#### Using the get_with_http_info variant
|
|
122
|
+
|
|
123
|
+
This returns an Array which contains the response data, status code and headers.
|
|
124
|
+
|
|
125
|
+
> <Array(<Upload>, Integer, Hash)> get_with_http_info(upl_id)
|
|
126
|
+
|
|
127
|
+
```ruby
|
|
128
|
+
begin
|
|
129
|
+
# get
|
|
130
|
+
data, status_code, headers = api_instance.get_with_http_info(upl_id)
|
|
131
|
+
p status_code # => 2xx
|
|
132
|
+
p headers # => { ... }
|
|
133
|
+
p data # => <Upload>
|
|
134
|
+
rescue Lob::ApiError => e
|
|
135
|
+
puts "Error when calling UploadsApi->get_with_http_info: #{e}"
|
|
136
|
+
end
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Parameters
|
|
140
|
+
|
|
141
|
+
| Name | Type | Description | Notes |
|
|
142
|
+
| ---- | ---- | ----------- | ----- |
|
|
143
|
+
| **upl_id** | **String** | id of the upload | |
|
|
144
|
+
|
|
145
|
+
### Return type
|
|
146
|
+
|
|
147
|
+
[**Upload**](Upload.md)
|
|
148
|
+
|
|
149
|
+
### Authorization
|
|
150
|
+
|
|
151
|
+
[basicAuth](../README.md#basicAuth)
|
|
152
|
+
|
|
153
|
+
### HTTP request headers
|
|
154
|
+
|
|
155
|
+
- **Content-Type**: Not defined
|
|
156
|
+
- **Accept**: application/json
|
|
157
|
+
|
|
158
|
+
|
|
89
159
|
## upload_create
|
|
90
160
|
|
|
91
161
|
> <Upload> upload_create(upload_writable)
|
|
92
162
|
|
|
93
|
-
|
|
163
|
+
create
|
|
94
164
|
|
|
95
165
|
Creates a new upload with the provided properties.
|
|
96
166
|
|
|
@@ -98,7 +168,7 @@ Creates a new upload with the provided properties.
|
|
|
98
168
|
|
|
99
169
|
```ruby
|
|
100
170
|
require 'time'
|
|
101
|
-
require '
|
|
171
|
+
require 'lob'
|
|
102
172
|
# setup authorization
|
|
103
173
|
Lob.configure do |config|
|
|
104
174
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -110,11 +180,11 @@ api_instance = Lob::UploadsApi.new
|
|
|
110
180
|
upload_writable = Lob::UploadWritable.new({campaign_id: 'campaign_id_example'}) # UploadWritable |
|
|
111
181
|
|
|
112
182
|
begin
|
|
113
|
-
#
|
|
114
|
-
result = api_instance.
|
|
183
|
+
# create
|
|
184
|
+
result = api_instance.create(upload_writable)
|
|
115
185
|
p result
|
|
116
186
|
rescue Lob::ApiError => e
|
|
117
|
-
puts "Error when calling UploadsApi->
|
|
187
|
+
puts "Error when calling UploadsApi->create: #{e}"
|
|
118
188
|
end
|
|
119
189
|
```
|
|
120
190
|
|
|
@@ -126,7 +196,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
126
196
|
|
|
127
197
|
```ruby
|
|
128
198
|
begin
|
|
129
|
-
#
|
|
199
|
+
# create
|
|
130
200
|
data, status_code, headers = api_instance.upload_create_with_http_info(upload_writable)
|
|
131
201
|
p status_code # => 2xx
|
|
132
202
|
p headers # => { ... }
|
|
@@ -160,7 +230,7 @@ end
|
|
|
160
230
|
|
|
161
231
|
> upload_delete(upl_id)
|
|
162
232
|
|
|
163
|
-
|
|
233
|
+
delete
|
|
164
234
|
|
|
165
235
|
Delete an existing upload. You need only supply the unique identifier that was returned upon upload creation.
|
|
166
236
|
|
|
@@ -168,7 +238,7 @@ Delete an existing upload. You need only supply the unique identifier that was r
|
|
|
168
238
|
|
|
169
239
|
```ruby
|
|
170
240
|
require 'time'
|
|
171
|
-
require '
|
|
241
|
+
require 'lob'
|
|
172
242
|
# setup authorization
|
|
173
243
|
Lob.configure do |config|
|
|
174
244
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -180,10 +250,10 @@ api_instance = Lob::UploadsApi.new
|
|
|
180
250
|
upl_id = 'upl_id_example' # String | id of the upload
|
|
181
251
|
|
|
182
252
|
begin
|
|
183
|
-
#
|
|
184
|
-
api_instance.
|
|
253
|
+
# delete
|
|
254
|
+
api_instance.delete(upl_id)
|
|
185
255
|
rescue Lob::ApiError => e
|
|
186
|
-
puts "Error when calling UploadsApi->
|
|
256
|
+
puts "Error when calling UploadsApi->delete: #{e}"
|
|
187
257
|
end
|
|
188
258
|
```
|
|
189
259
|
|
|
@@ -195,7 +265,7 @@ This returns an Array which contains the response data (`nil` in this case), sta
|
|
|
195
265
|
|
|
196
266
|
```ruby
|
|
197
267
|
begin
|
|
198
|
-
#
|
|
268
|
+
# delete
|
|
199
269
|
data, status_code, headers = api_instance.upload_delete_with_http_info(upl_id)
|
|
200
270
|
p status_code # => 2xx
|
|
201
271
|
p headers # => { ... }
|
|
@@ -237,7 +307,7 @@ Campaign Exports can help you understand exactly which records in a campaign cou
|
|
|
237
307
|
|
|
238
308
|
```ruby
|
|
239
309
|
require 'time'
|
|
240
|
-
require '
|
|
310
|
+
require 'lob'
|
|
241
311
|
# setup authorization
|
|
242
312
|
Lob.configure do |config|
|
|
243
313
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -309,7 +379,7 @@ Upload an [audience file](https://help.lob.com/best-practices/campaign-audience-
|
|
|
309
379
|
|
|
310
380
|
```ruby
|
|
311
381
|
require 'time'
|
|
312
|
-
require '
|
|
382
|
+
require 'lob'
|
|
313
383
|
# setup authorization
|
|
314
384
|
Lob.configure do |config|
|
|
315
385
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -369,81 +439,11 @@ end
|
|
|
369
439
|
- **Accept**: application/json
|
|
370
440
|
|
|
371
441
|
|
|
372
|
-
## upload_retrieve
|
|
373
|
-
|
|
374
|
-
> <Upload> upload_retrieve(upl_id)
|
|
375
|
-
|
|
376
|
-
get_upload
|
|
377
|
-
|
|
378
|
-
Retrieves the details of an existing upload. You need only supply the unique upload identifier that was returned upon upload creation.
|
|
379
|
-
|
|
380
|
-
### Examples
|
|
381
|
-
|
|
382
|
-
```ruby
|
|
383
|
-
require 'time'
|
|
384
|
-
require 'openapi_client'
|
|
385
|
-
# setup authorization
|
|
386
|
-
Lob.configure do |config|
|
|
387
|
-
# Configure HTTP basic authorization: basicAuth
|
|
388
|
-
config.username = 'YOUR USERNAME'
|
|
389
|
-
config.password = 'YOUR PASSWORD'
|
|
390
|
-
end
|
|
391
|
-
|
|
392
|
-
api_instance = Lob::UploadsApi.new
|
|
393
|
-
upl_id = 'upl_id_example' # String | id of the upload
|
|
394
|
-
|
|
395
|
-
begin
|
|
396
|
-
# get_upload
|
|
397
|
-
result = api_instance.get_upload(upl_id)
|
|
398
|
-
p result
|
|
399
|
-
rescue Lob::ApiError => e
|
|
400
|
-
puts "Error when calling UploadsApi->get_upload: #{e}"
|
|
401
|
-
end
|
|
402
|
-
```
|
|
403
|
-
|
|
404
|
-
#### Using the upload_retrieve_with_http_info variant
|
|
405
|
-
|
|
406
|
-
This returns an Array which contains the response data, status code and headers.
|
|
407
|
-
|
|
408
|
-
> <Array(<Upload>, Integer, Hash)> upload_retrieve_with_http_info(upl_id)
|
|
409
|
-
|
|
410
|
-
```ruby
|
|
411
|
-
begin
|
|
412
|
-
# get_upload
|
|
413
|
-
data, status_code, headers = api_instance.upload_retrieve_with_http_info(upl_id)
|
|
414
|
-
p status_code # => 2xx
|
|
415
|
-
p headers # => { ... }
|
|
416
|
-
p data # => <Upload>
|
|
417
|
-
rescue Lob::ApiError => e
|
|
418
|
-
puts "Error when calling UploadsApi->upload_retrieve_with_http_info: #{e}"
|
|
419
|
-
end
|
|
420
|
-
```
|
|
421
|
-
|
|
422
|
-
### Parameters
|
|
423
|
-
|
|
424
|
-
| Name | Type | Description | Notes |
|
|
425
|
-
| ---- | ---- | ----------- | ----- |
|
|
426
|
-
| **upl_id** | **String** | id of the upload | |
|
|
427
|
-
|
|
428
|
-
### Return type
|
|
429
|
-
|
|
430
|
-
[**Upload**](Upload.md)
|
|
431
|
-
|
|
432
|
-
### Authorization
|
|
433
|
-
|
|
434
|
-
[basicAuth](../README.md#basicAuth)
|
|
435
|
-
|
|
436
|
-
### HTTP request headers
|
|
437
|
-
|
|
438
|
-
- **Content-Type**: Not defined
|
|
439
|
-
- **Accept**: application/json
|
|
440
|
-
|
|
441
|
-
|
|
442
442
|
## upload_update
|
|
443
443
|
|
|
444
444
|
> <Upload> upload_update(upl_id, upload_updatable)
|
|
445
445
|
|
|
446
|
-
|
|
446
|
+
update
|
|
447
447
|
|
|
448
448
|
Update the details of an existing upload. You need only supply the unique identifier that was returned upon upload creation.
|
|
449
449
|
|
|
@@ -451,7 +451,7 @@ Update the details of an existing upload. You need only supply the unique identi
|
|
|
451
451
|
|
|
452
452
|
```ruby
|
|
453
453
|
require 'time'
|
|
454
|
-
require '
|
|
454
|
+
require 'lob'
|
|
455
455
|
# setup authorization
|
|
456
456
|
Lob.configure do |config|
|
|
457
457
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -464,11 +464,11 @@ upl_id = 'upl_id_example' # String | id of the upload
|
|
|
464
464
|
upload_updatable = Lob::UploadUpdatable.new # UploadUpdatable |
|
|
465
465
|
|
|
466
466
|
begin
|
|
467
|
-
#
|
|
468
|
-
result = api_instance.
|
|
467
|
+
# update
|
|
468
|
+
result = api_instance.update(upl_id, upload_updatable)
|
|
469
469
|
p result
|
|
470
470
|
rescue Lob::ApiError => e
|
|
471
|
-
puts "Error when calling UploadsApi->
|
|
471
|
+
puts "Error when calling UploadsApi->update: #{e}"
|
|
472
472
|
end
|
|
473
473
|
```
|
|
474
474
|
|
|
@@ -480,7 +480,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
480
480
|
|
|
481
481
|
```ruby
|
|
482
482
|
begin
|
|
483
|
-
#
|
|
483
|
+
# update
|
|
484
484
|
data, status_code, headers = api_instance.upload_update_with_http_info(upl_id, upload_updatable)
|
|
485
485
|
p status_code # => 2xx
|
|
486
486
|
p headers # => { ... }
|
|
@@ -515,7 +515,7 @@ end
|
|
|
515
515
|
|
|
516
516
|
> <Array<Upload>> uploads_list(opts)
|
|
517
517
|
|
|
518
|
-
|
|
518
|
+
list
|
|
519
519
|
|
|
520
520
|
Returns a list of your uploads. Optionally, filter uploads by campaign.
|
|
521
521
|
|
|
@@ -523,7 +523,7 @@ Returns a list of your uploads. Optionally, filter uploads by campaign.
|
|
|
523
523
|
|
|
524
524
|
```ruby
|
|
525
525
|
require 'time'
|
|
526
|
-
require '
|
|
526
|
+
require 'lob'
|
|
527
527
|
# setup authorization
|
|
528
528
|
Lob.configure do |config|
|
|
529
529
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -537,11 +537,11 @@ opts = {
|
|
|
537
537
|
}
|
|
538
538
|
|
|
539
539
|
begin
|
|
540
|
-
#
|
|
541
|
-
result = api_instance.
|
|
540
|
+
# list
|
|
541
|
+
result = api_instance.list(opts)
|
|
542
542
|
p result
|
|
543
543
|
rescue Lob::ApiError => e
|
|
544
|
-
puts "Error when calling UploadsApi->
|
|
544
|
+
puts "Error when calling UploadsApi->list: #{e}"
|
|
545
545
|
end
|
|
546
546
|
```
|
|
547
547
|
|
|
@@ -553,7 +553,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
553
553
|
|
|
554
554
|
```ruby
|
|
555
555
|
begin
|
|
556
|
-
#
|
|
556
|
+
# list
|
|
557
557
|
data, status_code, headers = api_instance.uploads_list_with_http_info(opts)
|
|
558
558
|
p status_code # => 2xx
|
|
559
559
|
p headers # => { ... }
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Lob::UploadsMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **columns** | **Array<String>** | The list of column names from the csv file which you want associated with each of your mailpieces | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'lob'
|
|
13
|
+
|
|
14
|
+
instance = Lob::UploadsMetadata.new(
|
|
15
|
+
columns: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/UsAddress.md
CHANGED
|
File without changes
|
data/docs/UsAutocompletions.md
CHANGED
|
@@ -19,7 +19,7 @@ Given an address prefix consisting of a partial primary line, as well as optiona
|
|
|
19
19
|
|
|
20
20
|
```ruby
|
|
21
21
|
require 'time'
|
|
22
|
-
require '
|
|
22
|
+
require 'lob'
|
|
23
23
|
# setup authorization
|
|
24
24
|
Lob.configure do |config|
|
|
25
25
|
# Configure HTTP basic authorization: basicAuth
|
data/docs/UsComponents.md
CHANGED
|
@@ -35,36 +35,36 @@
|
|
|
35
35
|
## Example
|
|
36
36
|
|
|
37
37
|
```ruby
|
|
38
|
-
require '
|
|
38
|
+
require 'lob'
|
|
39
39
|
|
|
40
40
|
instance = Lob::UsComponents.new(
|
|
41
|
-
primary_number:
|
|
42
|
-
street_predirection:
|
|
43
|
-
street_name:
|
|
44
|
-
street_suffix:
|
|
45
|
-
street_postdirection:
|
|
46
|
-
secondary_designator:
|
|
47
|
-
secondary_number:
|
|
48
|
-
pmb_designator:
|
|
49
|
-
pmb_number:
|
|
50
|
-
extra_secondary_designator:
|
|
51
|
-
extra_secondary_number:
|
|
52
|
-
city:
|
|
53
|
-
state:
|
|
54
|
-
zip_code:
|
|
55
|
-
zip_code_plus_4:
|
|
56
|
-
zip_code_type:
|
|
57
|
-
delivery_point_barcode:
|
|
58
|
-
address_type:
|
|
59
|
-
record_type:
|
|
60
|
-
default_building_address:
|
|
61
|
-
county:
|
|
62
|
-
county_fips:
|
|
63
|
-
carrier_route:
|
|
64
|
-
carrier_route_type:
|
|
65
|
-
po_box_only_flag:
|
|
66
|
-
latitude:
|
|
67
|
-
longitude:
|
|
41
|
+
primary_number: null,
|
|
42
|
+
street_predirection: null,
|
|
43
|
+
street_name: null,
|
|
44
|
+
street_suffix: null,
|
|
45
|
+
street_postdirection: null,
|
|
46
|
+
secondary_designator: null,
|
|
47
|
+
secondary_number: null,
|
|
48
|
+
pmb_designator: null,
|
|
49
|
+
pmb_number: null,
|
|
50
|
+
extra_secondary_designator: null,
|
|
51
|
+
extra_secondary_number: null,
|
|
52
|
+
city: null,
|
|
53
|
+
state: null,
|
|
54
|
+
zip_code: null,
|
|
55
|
+
zip_code_plus_4: null,
|
|
56
|
+
zip_code_type: null,
|
|
57
|
+
delivery_point_barcode: null,
|
|
58
|
+
address_type: null,
|
|
59
|
+
record_type: null,
|
|
60
|
+
default_building_address: null,
|
|
61
|
+
county: null,
|
|
62
|
+
county_fips: null,
|
|
63
|
+
carrier_route: null,
|
|
64
|
+
carrier_route_type: null,
|
|
65
|
+
po_box_only_flag: null,
|
|
66
|
+
latitude: null,
|
|
67
|
+
longitude: null
|
|
68
68
|
)
|
|
69
69
|
```
|
|
70
70
|
|
data/docs/UsVerification.md
CHANGED
data/docs/UsVerifications.md
CHANGED
data/docs/UsVerificationsApi.md
CHANGED
|
@@ -20,7 +20,7 @@ Verify a list of US or US territory addresses with a live API key.
|
|
|
20
20
|
|
|
21
21
|
```ruby
|
|
22
22
|
require 'time'
|
|
23
|
-
require '
|
|
23
|
+
require 'lob'
|
|
24
24
|
# setup authorization
|
|
25
25
|
Lob.configure do |config|
|
|
26
26
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -94,7 +94,7 @@ Verify a US or US territory address with a live API key.
|
|
|
94
94
|
|
|
95
95
|
```ruby
|
|
96
96
|
require 'time'
|
|
97
|
-
require '
|
|
97
|
+
require 'lob'
|
|
98
98
|
# setup authorization
|
|
99
99
|
Lob.configure do |config|
|
|
100
100
|
# Configure HTTP basic authorization: basicAuth
|