lob 6.0.7 → 6.0.9
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CODE_SNIPPETS.md +10 -10
- data/Gemfile +0 -0
- data/Gemfile.lock +3 -3
- 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 +1 -1
- 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 +15 -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 +54 -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 +54 -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/{openapi_client → lob}/models/bank_account.rb +3 -3
- data/lib/{openapi_client → lob}/models/check.rb +3 -3
- data/lib/lob/models/country_extended_expanded_no_us.rb +254 -0
- data/lib/lob/models/intl_address.rb +624 -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/lob/models/us_address.rb +644 -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 +239 -198
- /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.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/ReverseGeocode.md
CHANGED
data/docs/SelfMailer.md
CHANGED
|
@@ -18,13 +18,14 @@
|
|
|
18
18
|
| **outside_template_version_id** | **String** | The unique ID of the specific version of the HTML template used for the outside of the self mailer. | [optional] |
|
|
19
19
|
| **inside_template_version_id** | **String** | The unique ID of the specific version of the HTML template used for the inside of the self mailer. | [optional] |
|
|
20
20
|
| **object** | **String** | Value is resource type. | [optional][default to 'self_mailer'] |
|
|
21
|
-
| **tracking_events** | [**Array<
|
|
21
|
+
| **tracking_events** | [**Array<TrackingEventNormal>**](TrackingEventNormal.md) | An array of tracking events ordered by ascending `time`. Not populated in test mode. | [optional] |
|
|
22
22
|
| **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. | |
|
|
23
|
+
| **use_type** | [**SfmUseType**](SfmUseType.md) | | |
|
|
23
24
|
|
|
24
25
|
## Example
|
|
25
26
|
|
|
26
27
|
```ruby
|
|
27
|
-
require '
|
|
28
|
+
require 'lob'
|
|
28
29
|
|
|
29
30
|
instance = Lob::SelfMailer.new(
|
|
30
31
|
id: null,
|
|
@@ -42,7 +43,8 @@ instance = Lob::SelfMailer.new(
|
|
|
42
43
|
inside_template_version_id: null,
|
|
43
44
|
object: null,
|
|
44
45
|
tracking_events: null,
|
|
45
|
-
url: null
|
|
46
|
+
url: null,
|
|
47
|
+
use_type: null
|
|
46
48
|
)
|
|
47
49
|
```
|
|
48
50
|
|
data/docs/SelfMailerDeletion.md
CHANGED
data/docs/SelfMailerEditable.md
CHANGED
|
@@ -15,11 +15,12 @@
|
|
|
15
15
|
| **inside** | **String** | The artwork to use as the inside of your self mailer. | |
|
|
16
16
|
| **outside** | **String** | The artwork to use as the outside of your self mailer. | |
|
|
17
17
|
| **billing_group_id** | **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] |
|
|
18
|
+
| **use_type** | [**SfmUseType**](SfmUseType.md) | | |
|
|
18
19
|
|
|
19
20
|
## Example
|
|
20
21
|
|
|
21
22
|
```ruby
|
|
22
|
-
require '
|
|
23
|
+
require 'lob'
|
|
23
24
|
|
|
24
25
|
instance = Lob::SelfMailerEditable.new(
|
|
25
26
|
to: null,
|
|
@@ -32,7 +33,8 @@ instance = Lob::SelfMailerEditable.new(
|
|
|
32
33
|
send_date: null,
|
|
33
34
|
inside: null,
|
|
34
35
|
outside: null,
|
|
35
|
-
billing_group_id: null
|
|
36
|
+
billing_group_id: null,
|
|
37
|
+
use_type: null
|
|
36
38
|
)
|
|
37
39
|
```
|
|
38
40
|
|
data/docs/SelfMailerList.md
CHANGED
data/docs/SelfMailerSize.md
CHANGED
data/docs/SelfMailersApi.md
CHANGED
|
@@ -22,7 +22,7 @@ Creates a new self_mailer 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
|
|
@@ -31,7 +31,7 @@ Lob.configure do |config|
|
|
|
31
31
|
end
|
|
32
32
|
|
|
33
33
|
api_instance = Lob::SelfMailersApi.new
|
|
34
|
-
self_mailer_editable = Lob::SelfMailerEditable.new({to:
|
|
34
|
+
self_mailer_editable = Lob::SelfMailerEditable.new({to: TODO, inside: 'inside_example', outside: 'outside_example', use_type: Lob::SfmUseType::MARKETING}) # SelfMailerEditable |
|
|
35
35
|
opts = {
|
|
36
36
|
idempotency_key: 'idempotency_key_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).
|
|
37
37
|
}
|
|
@@ -96,7 +96,7 @@ Completely removes a self mailer from production. This can only be done if the s
|
|
|
96
96
|
|
|
97
97
|
```ruby
|
|
98
98
|
require 'time'
|
|
99
|
-
require '
|
|
99
|
+
require 'lob'
|
|
100
100
|
# setup authorization
|
|
101
101
|
Lob.configure do |config|
|
|
102
102
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -166,7 +166,7 @@ Retrieves the details of an existing self_mailer. You need only supply the uniqu
|
|
|
166
166
|
|
|
167
167
|
```ruby
|
|
168
168
|
require 'time'
|
|
169
|
-
require '
|
|
169
|
+
require 'lob'
|
|
170
170
|
# setup authorization
|
|
171
171
|
Lob.configure do |config|
|
|
172
172
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -236,7 +236,7 @@ Returns a list of your self_mailers. The self_mailers are returned sorted by cre
|
|
|
236
236
|
|
|
237
237
|
```ruby
|
|
238
238
|
require 'time'
|
|
239
|
-
require '
|
|
239
|
+
require 'lob'
|
|
240
240
|
# setup authorization
|
|
241
241
|
Lob.configure do |config|
|
|
242
242
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -256,7 +256,7 @@ opts = {
|
|
|
256
256
|
scheduled: true, # Boolean | * `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`
|
|
257
257
|
send_date: { key: 'inner_example'}, # Hash<String, String> | Filter by date sent.
|
|
258
258
|
mail_type: Lob::MailType::FIRST_CLASS, # 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.
|
|
259
|
-
sort_by: Lob::
|
|
259
|
+
sort_by: Lob::SortBy4.new # SortBy4 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
260
260
|
}
|
|
261
261
|
|
|
262
262
|
begin
|
|
@@ -300,7 +300,7 @@ end
|
|
|
300
300
|
| **scheduled** | **Boolean** | * `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] |
|
|
301
301
|
| **send_date** | [**Hash<String, String>**](String.md) | Filter by date sent. | [optional] |
|
|
302
302
|
| **mail_type** | [**MailType**](.md) | 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][default to 'usps_first_class'] |
|
|
303
|
-
| **sort_by** | [**
|
|
303
|
+
| **sort_by** | [**SortBy4**](.md) | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. | [optional] |
|
|
304
304
|
|
|
305
305
|
### Return type
|
|
306
306
|
|
data/docs/SfmUseType.md
ADDED
data/docs/SnapPack.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Lob::SnapPack
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier prefixed with `ord_`. | |
|
|
8
|
+
| **to** | [**AnyType**](.md) | | |
|
|
9
|
+
| **from** | [**AnyType**](.md) | | [optional] |
|
|
10
|
+
| **size** | [**SnapPackSize**](SnapPackSize.md) | | [optional][default to '8.5x11'] |
|
|
11
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
|
12
|
+
| **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] |
|
|
13
|
+
| **mail_type** | [**MailType**](MailType.md) | | [optional][default to 'usps_first_class'] |
|
|
14
|
+
| **merge_variables** | **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] |
|
|
15
|
+
| **send_date** | **Time** | 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] |
|
|
16
|
+
| **outside_template_id** | **String** | The unique ID of the HTML template used for the outside of the snap pack. | [optional] |
|
|
17
|
+
| **inside_template_id** | **String** | The unique ID of the HTML template used for the inside of the snap pack. | [optional] |
|
|
18
|
+
| **outside_template_version_id** | **String** | The unique ID of the specific version of the HTML template used for the outside of the snap pack. | [optional] |
|
|
19
|
+
| **inside_template_version_id** | **String** | The unique ID of the specific version of the HTML template used for the inside of the snap pack. | [optional] |
|
|
20
|
+
| **object** | **String** | Value is resource type. | [optional][default to 'snap_pack'] |
|
|
21
|
+
| **tracking_events** | [**Array<TrackingEventNormal>**](TrackingEventNormal.md) | An array of tracking events ordered by ascending `time`. Not populated in test mode. | [optional] |
|
|
22
|
+
| **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. | |
|
|
23
|
+
| **use_type** | [**SnpUseType**](SnpUseType.md) | | |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require 'lob'
|
|
29
|
+
|
|
30
|
+
instance = Lob::SnapPack.new(
|
|
31
|
+
id: null,
|
|
32
|
+
to: null,
|
|
33
|
+
from: null,
|
|
34
|
+
size: null,
|
|
35
|
+
description: null,
|
|
36
|
+
metadata: null,
|
|
37
|
+
mail_type: null,
|
|
38
|
+
merge_variables: null,
|
|
39
|
+
send_date: null,
|
|
40
|
+
outside_template_id: null,
|
|
41
|
+
inside_template_id: null,
|
|
42
|
+
outside_template_version_id: null,
|
|
43
|
+
inside_template_version_id: null,
|
|
44
|
+
object: null,
|
|
45
|
+
tracking_events: null,
|
|
46
|
+
url: null,
|
|
47
|
+
use_type: null
|
|
48
|
+
)
|
|
49
|
+
```
|
|
50
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Lob::SnapPackDeletion
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier prefixed with `ord_`. | [optional] |
|
|
8
|
+
| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
|
|
9
|
+
| **object** | **String** | Value is type of resource. | [optional][default to 'snap_pack_deleted'] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'lob'
|
|
15
|
+
|
|
16
|
+
instance = Lob::SnapPackDeletion.new(
|
|
17
|
+
id: null,
|
|
18
|
+
deleted: null,
|
|
19
|
+
object: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Lob::SnapPackEditable
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **to** | [**AnyType**](.md) | Must either be an address ID or an inline object with correct address parameters. | |
|
|
8
|
+
| **from** | [**AnyType**](.md) | Must either be an address ID or an inline object with correct address parameters. | [optional] |
|
|
9
|
+
| **size** | [**SnapPackSize**](SnapPackSize.md) | | [optional][default to '8.5x11'] |
|
|
10
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
|
11
|
+
| **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] |
|
|
12
|
+
| **mail_type** | [**MailType**](MailType.md) | | [optional][default to 'usps_first_class'] |
|
|
13
|
+
| **merge_variables** | **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] |
|
|
14
|
+
| **send_date** | **Time** | 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] |
|
|
15
|
+
| **inside** | **String** | The artwork to use as the inside of your snap pack. | |
|
|
16
|
+
| **outside** | **String** | The artwork to use as the outside of your snap pack. | |
|
|
17
|
+
| **billing_group_id** | **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] |
|
|
18
|
+
| **use_type** | [**SnpUseType**](SnpUseType.md) | | |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'lob'
|
|
24
|
+
|
|
25
|
+
instance = Lob::SnapPackEditable.new(
|
|
26
|
+
to: null,
|
|
27
|
+
from: null,
|
|
28
|
+
size: null,
|
|
29
|
+
description: null,
|
|
30
|
+
metadata: null,
|
|
31
|
+
mail_type: null,
|
|
32
|
+
merge_variables: null,
|
|
33
|
+
send_date: null,
|
|
34
|
+
inside: null,
|
|
35
|
+
outside: null,
|
|
36
|
+
billing_group_id: null,
|
|
37
|
+
use_type: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Lob::SnapPackList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<SnapPack>**](SnapPack.md) | list of snap packs | [optional] |
|
|
8
|
+
| **object** | **String** | Value is type of resource. | [optional] |
|
|
9
|
+
| **next_url** | **String** | url of next page of items in list. | [optional] |
|
|
10
|
+
| **previous_url** | **String** | url of previous page of items in list. | [optional] |
|
|
11
|
+
| **count** | **Integer** | number of resources in a set | [optional] |
|
|
12
|
+
| **total_count** | **Integer** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'lob'
|
|
18
|
+
|
|
19
|
+
instance = Lob::SnapPackList.new(
|
|
20
|
+
data: null,
|
|
21
|
+
object: null,
|
|
22
|
+
next_url: null,
|
|
23
|
+
previous_url: null,
|
|
24
|
+
count: null,
|
|
25
|
+
total_count: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,317 @@
|
|
|
1
|
+
# Lob::SnapPacksApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.lob.com/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**snap_pack_create**](SnapPacksApi.md#snap_pack_create) | **POST** /snap_packs | create |
|
|
8
|
+
| [**snap_pack_delete**](SnapPacksApi.md#snap_pack_delete) | **DELETE** /snap_packs/{snp_id} | delete |
|
|
9
|
+
| [**snap_pack_retrieve**](SnapPacksApi.md#snap_pack_retrieve) | **GET** /snap_packs/{snp_id} | get |
|
|
10
|
+
| [**snap_packs_list**](SnapPacksApi.md#snap_packs_list) | **GET** /snap_packs | list |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## snap_pack_create
|
|
14
|
+
|
|
15
|
+
> <SnapPack> snap_pack_create(snap_pack_editable, opts)
|
|
16
|
+
|
|
17
|
+
create
|
|
18
|
+
|
|
19
|
+
Creates a new snap_pack given information
|
|
20
|
+
|
|
21
|
+
### Examples
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'time'
|
|
25
|
+
require 'lob'
|
|
26
|
+
# setup authorization
|
|
27
|
+
Lob.configure do |config|
|
|
28
|
+
# Configure HTTP basic authorization: basicAuth
|
|
29
|
+
config.username = 'YOUR USERNAME'
|
|
30
|
+
config.password = 'YOUR PASSWORD'
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
api_instance = Lob::SnapPacksApi.new
|
|
34
|
+
snap_pack_editable = Lob::SnapPackEditable.new({to: TODO, inside: 'inside_example', outside: 'outside_example', use_type: Lob::SnpUseType::MARKETING}) # SnapPackEditable |
|
|
35
|
+
opts = {
|
|
36
|
+
idempotency_key: 'idempotency_key_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).
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
# create
|
|
41
|
+
result = api_instance.create(snap_pack_editable, opts)
|
|
42
|
+
p result
|
|
43
|
+
rescue Lob::ApiError => e
|
|
44
|
+
puts "Error when calling SnapPacksApi->create: #{e}"
|
|
45
|
+
end
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
#### Using the snap_pack_create_with_http_info variant
|
|
49
|
+
|
|
50
|
+
This returns an Array which contains the response data, status code and headers.
|
|
51
|
+
|
|
52
|
+
> <Array(<SnapPack>, Integer, Hash)> snap_pack_create_with_http_info(snap_pack_editable, opts)
|
|
53
|
+
|
|
54
|
+
```ruby
|
|
55
|
+
begin
|
|
56
|
+
# create
|
|
57
|
+
data, status_code, headers = api_instance.snap_pack_create_with_http_info(snap_pack_editable, opts)
|
|
58
|
+
p status_code # => 2xx
|
|
59
|
+
p headers # => { ... }
|
|
60
|
+
p data # => <SnapPack>
|
|
61
|
+
rescue Lob::ApiError => e
|
|
62
|
+
puts "Error when calling SnapPacksApi->snap_pack_create_with_http_info: #{e}"
|
|
63
|
+
end
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Parameters
|
|
67
|
+
|
|
68
|
+
| Name | Type | Description | Notes |
|
|
69
|
+
| ---- | ---- | ----------- | ----- |
|
|
70
|
+
| **snap_pack_editable** | [**SnapPackEditable**](SnapPackEditable.md) | | |
|
|
71
|
+
| **idempotency_key** | **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] |
|
|
72
|
+
|
|
73
|
+
### Return type
|
|
74
|
+
|
|
75
|
+
[**SnapPack**](SnapPack.md)
|
|
76
|
+
|
|
77
|
+
### Authorization
|
|
78
|
+
|
|
79
|
+
[basicAuth](../README.md#basicAuth)
|
|
80
|
+
|
|
81
|
+
### HTTP request headers
|
|
82
|
+
|
|
83
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
|
84
|
+
- **Accept**: application/json
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
## snap_pack_delete
|
|
88
|
+
|
|
89
|
+
> <SnapPackDeletion> snap_pack_delete(snp_id)
|
|
90
|
+
|
|
91
|
+
delete
|
|
92
|
+
|
|
93
|
+
Completely removes a snap pack from production. This can only be done if the snap pack's `send_date` has not yet passed.
|
|
94
|
+
|
|
95
|
+
### Examples
|
|
96
|
+
|
|
97
|
+
```ruby
|
|
98
|
+
require 'time'
|
|
99
|
+
require 'lob'
|
|
100
|
+
# setup authorization
|
|
101
|
+
Lob.configure do |config|
|
|
102
|
+
# Configure HTTP basic authorization: basicAuth
|
|
103
|
+
config.username = 'YOUR USERNAME'
|
|
104
|
+
config.password = 'YOUR PASSWORD'
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
api_instance = Lob::SnapPacksApi.new
|
|
108
|
+
snp_id = 'snp_id_example' # String | id of the snap_pack
|
|
109
|
+
|
|
110
|
+
begin
|
|
111
|
+
# delete
|
|
112
|
+
result = api_instance.delete(snp_id)
|
|
113
|
+
p result
|
|
114
|
+
rescue Lob::ApiError => e
|
|
115
|
+
puts "Error when calling SnapPacksApi->delete: #{e}"
|
|
116
|
+
end
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
#### Using the snap_pack_delete_with_http_info variant
|
|
120
|
+
|
|
121
|
+
This returns an Array which contains the response data, status code and headers.
|
|
122
|
+
|
|
123
|
+
> <Array(<SnapPackDeletion>, Integer, Hash)> snap_pack_delete_with_http_info(snp_id)
|
|
124
|
+
|
|
125
|
+
```ruby
|
|
126
|
+
begin
|
|
127
|
+
# delete
|
|
128
|
+
data, status_code, headers = api_instance.snap_pack_delete_with_http_info(snp_id)
|
|
129
|
+
p status_code # => 2xx
|
|
130
|
+
p headers # => { ... }
|
|
131
|
+
p data # => <SnapPackDeletion>
|
|
132
|
+
rescue Lob::ApiError => e
|
|
133
|
+
puts "Error when calling SnapPacksApi->snap_pack_delete_with_http_info: #{e}"
|
|
134
|
+
end
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Parameters
|
|
138
|
+
|
|
139
|
+
| Name | Type | Description | Notes |
|
|
140
|
+
| ---- | ---- | ----------- | ----- |
|
|
141
|
+
| **snp_id** | **String** | id of the snap_pack | |
|
|
142
|
+
|
|
143
|
+
### Return type
|
|
144
|
+
|
|
145
|
+
[**SnapPackDeletion**](SnapPackDeletion.md)
|
|
146
|
+
|
|
147
|
+
### Authorization
|
|
148
|
+
|
|
149
|
+
[basicAuth](../README.md#basicAuth)
|
|
150
|
+
|
|
151
|
+
### HTTP request headers
|
|
152
|
+
|
|
153
|
+
- **Content-Type**: Not defined
|
|
154
|
+
- **Accept**: application/json
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
## snap_pack_retrieve
|
|
158
|
+
|
|
159
|
+
> <SnapPack> snap_pack_retrieve(snp_id)
|
|
160
|
+
|
|
161
|
+
get
|
|
162
|
+
|
|
163
|
+
Retrieves the details of an existing snap_pack. You need only supply the unique snap_pack identifier that was returned upon snap_pack creation.
|
|
164
|
+
|
|
165
|
+
### Examples
|
|
166
|
+
|
|
167
|
+
```ruby
|
|
168
|
+
require 'time'
|
|
169
|
+
require 'lob'
|
|
170
|
+
# setup authorization
|
|
171
|
+
Lob.configure do |config|
|
|
172
|
+
# Configure HTTP basic authorization: basicAuth
|
|
173
|
+
config.username = 'YOUR USERNAME'
|
|
174
|
+
config.password = 'YOUR PASSWORD'
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
api_instance = Lob::SnapPacksApi.new
|
|
178
|
+
snp_id = 'snp_id_example' # String | id of the snap_pack
|
|
179
|
+
|
|
180
|
+
begin
|
|
181
|
+
# get
|
|
182
|
+
result = api_instance.get(snp_id)
|
|
183
|
+
p result
|
|
184
|
+
rescue Lob::ApiError => e
|
|
185
|
+
puts "Error when calling SnapPacksApi->get: #{e}"
|
|
186
|
+
end
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
#### Using the snap_pack_retrieve_with_http_info variant
|
|
190
|
+
|
|
191
|
+
This returns an Array which contains the response data, status code and headers.
|
|
192
|
+
|
|
193
|
+
> <Array(<SnapPack>, Integer, Hash)> snap_pack_retrieve_with_http_info(snp_id)
|
|
194
|
+
|
|
195
|
+
```ruby
|
|
196
|
+
begin
|
|
197
|
+
# get
|
|
198
|
+
data, status_code, headers = api_instance.snap_pack_retrieve_with_http_info(snp_id)
|
|
199
|
+
p status_code # => 2xx
|
|
200
|
+
p headers # => { ... }
|
|
201
|
+
p data # => <SnapPack>
|
|
202
|
+
rescue Lob::ApiError => e
|
|
203
|
+
puts "Error when calling SnapPacksApi->snap_pack_retrieve_with_http_info: #{e}"
|
|
204
|
+
end
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Parameters
|
|
208
|
+
|
|
209
|
+
| Name | Type | Description | Notes |
|
|
210
|
+
| ---- | ---- | ----------- | ----- |
|
|
211
|
+
| **snp_id** | **String** | id of the snap_pack | |
|
|
212
|
+
|
|
213
|
+
### Return type
|
|
214
|
+
|
|
215
|
+
[**SnapPack**](SnapPack.md)
|
|
216
|
+
|
|
217
|
+
### Authorization
|
|
218
|
+
|
|
219
|
+
[basicAuth](../README.md#basicAuth)
|
|
220
|
+
|
|
221
|
+
### HTTP request headers
|
|
222
|
+
|
|
223
|
+
- **Content-Type**: Not defined
|
|
224
|
+
- **Accept**: application/json
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
## snap_packs_list
|
|
228
|
+
|
|
229
|
+
> <SnapPackList> snap_packs_list(opts)
|
|
230
|
+
|
|
231
|
+
list
|
|
232
|
+
|
|
233
|
+
Returns a list of your Snap Packs. The snap packs are returned sorted by creation date, with the most recently created snap packs appearing first.
|
|
234
|
+
|
|
235
|
+
### Examples
|
|
236
|
+
|
|
237
|
+
```ruby
|
|
238
|
+
require 'time'
|
|
239
|
+
require 'lob'
|
|
240
|
+
# setup authorization
|
|
241
|
+
Lob.configure do |config|
|
|
242
|
+
# Configure HTTP basic authorization: basicAuth
|
|
243
|
+
config.username = 'YOUR USERNAME'
|
|
244
|
+
config.password = 'YOUR PASSWORD'
|
|
245
|
+
end
|
|
246
|
+
|
|
247
|
+
api_instance = Lob::SnapPacksApi.new
|
|
248
|
+
opts = {
|
|
249
|
+
limit: 56, # Integer | How many results to return.
|
|
250
|
+
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.
|
|
251
|
+
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.
|
|
252
|
+
include: ['inner_example'], # Array<String> | Request that the response include the total count by specifying `include[]=total_count`.
|
|
253
|
+
date_created: { key: Time.now}, # Hash<String, Time> | Filter by date created.
|
|
254
|
+
metadata: { key: 'inner_example'}, # Hash<String, String> | Filter by metadata key-value pair`.
|
|
255
|
+
size: [Lob::SnapPackSize::N8_5X11], # Array<SnapPackSize> | The Snap Pack sizes to be returned.
|
|
256
|
+
scheduled: true, # Boolean | * `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`
|
|
257
|
+
send_date: { key: 'inner_example'}, # Hash<String, String> | Filter by date sent.
|
|
258
|
+
mail_type: Lob::MailType::FIRST_CLASS, # 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.
|
|
259
|
+
sort_by: Lob::SortBy4.new # SortBy4 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
260
|
+
}
|
|
261
|
+
|
|
262
|
+
begin
|
|
263
|
+
# list
|
|
264
|
+
result = api_instance.list(opts)
|
|
265
|
+
p result
|
|
266
|
+
rescue Lob::ApiError => e
|
|
267
|
+
puts "Error when calling SnapPacksApi->list: #{e}"
|
|
268
|
+
end
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
#### Using the snap_packs_list_with_http_info variant
|
|
272
|
+
|
|
273
|
+
This returns an Array which contains the response data, status code and headers.
|
|
274
|
+
|
|
275
|
+
> <Array(<SnapPackList>, Integer, Hash)> snap_packs_list_with_http_info(opts)
|
|
276
|
+
|
|
277
|
+
```ruby
|
|
278
|
+
begin
|
|
279
|
+
# list
|
|
280
|
+
data, status_code, headers = api_instance.snap_packs_list_with_http_info(opts)
|
|
281
|
+
p status_code # => 2xx
|
|
282
|
+
p headers # => { ... }
|
|
283
|
+
p data # => <SnapPackList>
|
|
284
|
+
rescue Lob::ApiError => e
|
|
285
|
+
puts "Error when calling SnapPacksApi->snap_packs_list_with_http_info: #{e}"
|
|
286
|
+
end
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
### Parameters
|
|
290
|
+
|
|
291
|
+
| Name | Type | Description | Notes |
|
|
292
|
+
| ---- | ---- | ----------- | ----- |
|
|
293
|
+
| **limit** | **Integer** | How many results to return. | [optional][default to 10] |
|
|
294
|
+
| **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] |
|
|
295
|
+
| **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] |
|
|
296
|
+
| **include** | [**Array<String>**](String.md) | Request that the response include the total count by specifying `include[]=total_count`. | [optional] |
|
|
297
|
+
| **date_created** | [**Hash<String, Time>**](Time.md) | Filter by date created. | [optional] |
|
|
298
|
+
| **metadata** | [**Hash<String, String>**](String.md) | Filter by metadata key-value pair`. | [optional] |
|
|
299
|
+
| **size** | [**Array<SnapPackSize>**](SnapPackSize.md) | The Snap Pack sizes to be returned. | [optional] |
|
|
300
|
+
| **scheduled** | **Boolean** | * `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] |
|
|
301
|
+
| **send_date** | [**Hash<String, String>**](String.md) | Filter by date sent. | [optional] |
|
|
302
|
+
| **mail_type** | [**MailType**](.md) | 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][default to 'usps_first_class'] |
|
|
303
|
+
| **sort_by** | [**SortBy4**](.md) | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. | [optional] |
|
|
304
|
+
|
|
305
|
+
### Return type
|
|
306
|
+
|
|
307
|
+
[**SnapPackList**](SnapPackList.md)
|
|
308
|
+
|
|
309
|
+
### Authorization
|
|
310
|
+
|
|
311
|
+
[basicAuth](../README.md#basicAuth)
|
|
312
|
+
|
|
313
|
+
### HTTP request headers
|
|
314
|
+
|
|
315
|
+
- **Content-Type**: Not defined
|
|
316
|
+
- **Accept**: application/json
|
|
317
|
+
|