lob 6.0.8 → 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 +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/Zip.md
CHANGED
data/docs/ZipCodeType.md
CHANGED
data/docs/ZipEditable.md
CHANGED
data/docs/ZipLookupCity.md
CHANGED
data/docs/ZipLookupsApi.md
CHANGED
data/git_push.sh
CHANGED
|
File without changes
|
|
@@ -242,7 +242,7 @@ module Lob
|
|
|
242
242
|
# @option opts [Boolean] :scheduled * `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`
|
|
243
243
|
# @option opts [Hash<String, String>] :send_date Filter by date sent.
|
|
244
244
|
# @option opts [MailType] :mail_type 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. (default to 'usps_first_class')
|
|
245
|
-
# @option opts [
|
|
245
|
+
# @option opts [SortBy4] :sort_by Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
246
246
|
# @return [CheckList]
|
|
247
247
|
def list(opts = {})
|
|
248
248
|
data, _status_code, _headers = checks_list_with_http_info(opts)
|
|
@@ -261,7 +261,7 @@ module Lob
|
|
|
261
261
|
# @option opts [Boolean] :scheduled * `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`
|
|
262
262
|
# @option opts [Hash<String, String>] :send_date Filter by date sent.
|
|
263
263
|
# @option opts [MailType] :mail_type 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. (default to 'usps_first_class')
|
|
264
|
-
# @option opts [
|
|
264
|
+
# @option opts [SortBy4] :sort_by Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
265
265
|
# @return [Array<(CheckList, Integer, Hash)>] CheckList data, response status code and response headers
|
|
266
266
|
def checks_list_with_http_info(opts = {})
|
|
267
267
|
if @api_client.config.debugging
|
|
@@ -246,7 +246,7 @@ module Lob
|
|
|
246
246
|
# @option opts [Boolean] :scheduled * `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`
|
|
247
247
|
# @option opts [Hash<String, String>] :send_date Filter by date sent.
|
|
248
248
|
# @option opts [MailType] :mail_type 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. (default to 'usps_first_class')
|
|
249
|
-
# @option opts [
|
|
249
|
+
# @option opts [SortBy4] :sort_by Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
250
250
|
# @return [LetterList]
|
|
251
251
|
def list(opts = {})
|
|
252
252
|
data, _status_code, _headers = letters_list_with_http_info(opts)
|
|
@@ -266,7 +266,7 @@ module Lob
|
|
|
266
266
|
# @option opts [Boolean] :scheduled * `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`
|
|
267
267
|
# @option opts [Hash<String, String>] :send_date Filter by date sent.
|
|
268
268
|
# @option opts [MailType] :mail_type 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. (default to 'usps_first_class')
|
|
269
|
-
# @option opts [
|
|
269
|
+
# @option opts [SortBy4] :sort_by Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
270
270
|
# @return [Array<(LetterList, Integer, Hash)>] LetterList data, response status code and response headers
|
|
271
271
|
def letters_list_with_http_info(opts = {})
|
|
272
272
|
if @api_client.config.debugging
|
|
@@ -243,7 +243,7 @@ module Lob
|
|
|
243
243
|
# @option opts [Boolean] :scheduled * `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`
|
|
244
244
|
# @option opts [Hash<String, String>] :send_date Filter by date sent.
|
|
245
245
|
# @option opts [MailType] :mail_type 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. (default to 'usps_first_class')
|
|
246
|
-
# @option opts [
|
|
246
|
+
# @option opts [SortBy4] :sort_by Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
247
247
|
# @return [PostcardList]
|
|
248
248
|
def list(opts = {})
|
|
249
249
|
data, _status_code, _headers = postcards_list_with_http_info(opts)
|
|
@@ -263,7 +263,7 @@ module Lob
|
|
|
263
263
|
# @option opts [Boolean] :scheduled * `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`
|
|
264
264
|
# @option opts [Hash<String, String>] :send_date Filter by date sent.
|
|
265
265
|
# @option opts [MailType] :mail_type 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. (default to 'usps_first_class')
|
|
266
|
-
# @option opts [
|
|
266
|
+
# @option opts [SortBy4] :sort_by Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
267
267
|
# @return [Array<(PostcardList, Integer, Hash)>] PostcardList data, response status code and response headers
|
|
268
268
|
def postcards_list_with_http_info(opts = {})
|
|
269
269
|
if @api_client.config.debugging
|
|
@@ -243,7 +243,7 @@ module Lob
|
|
|
243
243
|
# @option opts [Boolean] :scheduled * `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`
|
|
244
244
|
# @option opts [Hash<String, String>] :send_date Filter by date sent.
|
|
245
245
|
# @option opts [MailType] :mail_type 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. (default to 'usps_first_class')
|
|
246
|
-
# @option opts [
|
|
246
|
+
# @option opts [SortBy4] :sort_by Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
247
247
|
# @return [SelfMailerList]
|
|
248
248
|
def list(opts = {})
|
|
249
249
|
data, _status_code, _headers = self_mailers_list_with_http_info(opts)
|
|
@@ -263,7 +263,7 @@ module Lob
|
|
|
263
263
|
# @option opts [Boolean] :scheduled * `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`
|
|
264
264
|
# @option opts [Hash<String, String>] :send_date Filter by date sent.
|
|
265
265
|
# @option opts [MailType] :mail_type 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. (default to 'usps_first_class')
|
|
266
|
-
# @option opts [
|
|
266
|
+
# @option opts [SortBy4] :sort_by Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
267
267
|
# @return [Array<(SelfMailerList, Integer, Hash)>] SelfMailerList data, response status code and response headers
|
|
268
268
|
def self_mailers_list_with_http_info(opts = {})
|
|
269
269
|
if @api_client.config.debugging
|
|
@@ -0,0 +1,340 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Lob
|
|
3
|
+
|
|
4
|
+
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.3.0
|
|
7
|
+
Contact: lob-openapi@lob.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
OpenAPI Generator version: 5.2.1
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module Lob
|
|
16
|
+
class SnapPacksApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# create
|
|
23
|
+
# Creates a new snap_pack given information
|
|
24
|
+
# @param snap_pack_editable [SnapPackEditable]
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @option opts [String] :idempotency_key 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).
|
|
27
|
+
# @return [SnapPack]
|
|
28
|
+
def create(snap_pack_editable, opts = {})
|
|
29
|
+
data, _status_code, _headers = snap_pack_create_with_http_info(snap_pack_editable, opts)
|
|
30
|
+
data
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# create
|
|
34
|
+
# Creates a new snap_pack given information
|
|
35
|
+
# @param snap_pack_editable [SnapPackEditable]
|
|
36
|
+
# @param [Hash] opts the optional parameters
|
|
37
|
+
# @option opts [String] :idempotency_key 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).
|
|
38
|
+
# @return [Array<(SnapPack, Integer, Hash)>] SnapPack data, response status code and response headers
|
|
39
|
+
def snap_pack_create_with_http_info(snap_pack_editable, opts = {})
|
|
40
|
+
if @api_client.config.debugging
|
|
41
|
+
@api_client.config.logger.debug 'Calling API: SnapPacksApi.snap_pack_create ...'
|
|
42
|
+
end
|
|
43
|
+
# verify the required parameter 'snap_pack_editable' is set
|
|
44
|
+
if @api_client.config.client_side_validation && snap_pack_editable.nil?
|
|
45
|
+
fail ArgumentError, "Missing the required parameter 'snap_pack_editable' when calling SnapPacksApi.snap_pack_create"
|
|
46
|
+
end
|
|
47
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 256
|
|
48
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SnapPacksApi.snap_pack_create, the character length must be smaller than or equal to 256.'
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# resource path
|
|
52
|
+
local_var_path = '/snap_packs'
|
|
53
|
+
|
|
54
|
+
# query parameters
|
|
55
|
+
query_params = opts[:query_params] || {}
|
|
56
|
+
|
|
57
|
+
# header parameters
|
|
58
|
+
header_params = opts[:header_params] || {}
|
|
59
|
+
# HTTP header 'Accept' (if needed)
|
|
60
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
61
|
+
# HTTP header 'Content-Type'
|
|
62
|
+
content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
|
|
63
|
+
if !content_type.nil?
|
|
64
|
+
header_params['Content-Type'] = content_type
|
|
65
|
+
end
|
|
66
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
67
|
+
|
|
68
|
+
# form parameters
|
|
69
|
+
form_params = opts[:form_params] || {}
|
|
70
|
+
|
|
71
|
+
# http body (model)
|
|
72
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(snap_pack_editable)
|
|
73
|
+
|
|
74
|
+
# return_type
|
|
75
|
+
return_type = opts[:debug_return_type] || 'SnapPack'
|
|
76
|
+
|
|
77
|
+
# auth_names
|
|
78
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
79
|
+
|
|
80
|
+
new_options = opts.merge(
|
|
81
|
+
:operation => :"SnapPacksApi.snap_pack_create",
|
|
82
|
+
:header_params => header_params,
|
|
83
|
+
:query_params => query_params,
|
|
84
|
+
:form_params => form_params,
|
|
85
|
+
:body => post_body,
|
|
86
|
+
:auth_names => auth_names,
|
|
87
|
+
:return_type => return_type
|
|
88
|
+
)
|
|
89
|
+
|
|
90
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
91
|
+
if @api_client.config.debugging
|
|
92
|
+
@api_client.config.logger.debug "API called: SnapPacksApi#snap_pack_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
93
|
+
end
|
|
94
|
+
return data, status_code, headers
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# delete
|
|
98
|
+
# Completely removes a snap pack from production. This can only be done if the snap pack's `send_date` has not yet passed.
|
|
99
|
+
# @param snp_id [String] id of the snap_pack
|
|
100
|
+
# @param [Hash] opts the optional parameters
|
|
101
|
+
# @return [SnapPackDeletion]
|
|
102
|
+
def delete(snp_id, opts = {})
|
|
103
|
+
data, _status_code, _headers = snap_pack_delete_with_http_info(snp_id, opts)
|
|
104
|
+
data
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# delete
|
|
108
|
+
# Completely removes a snap pack from production. This can only be done if the snap pack's `send_date` has not yet passed.
|
|
109
|
+
# @param snp_id [String] id of the snap_pack
|
|
110
|
+
# @param [Hash] opts the optional parameters
|
|
111
|
+
# @return [Array<(SnapPackDeletion, Integer, Hash)>] SnapPackDeletion data, response status code and response headers
|
|
112
|
+
def snap_pack_delete_with_http_info(snp_id, opts = {})
|
|
113
|
+
if @api_client.config.debugging
|
|
114
|
+
@api_client.config.logger.debug 'Calling API: SnapPacksApi.snap_pack_delete ...'
|
|
115
|
+
end
|
|
116
|
+
# verify the required parameter 'snp_id' is set
|
|
117
|
+
if @api_client.config.client_side_validation && snp_id.nil?
|
|
118
|
+
fail ArgumentError, "Missing the required parameter 'snp_id' when calling SnapPacksApi.snap_pack_delete"
|
|
119
|
+
end
|
|
120
|
+
pattern = Regexp.new(/^ord_[a-zA-Z0-9]+$/)
|
|
121
|
+
if @api_client.config.client_side_validation && snp_id !~ pattern
|
|
122
|
+
fail ArgumentError, "invalid value for 'snp_id' when calling SnapPacksApi.snap_pack_delete, must conform to the pattern #{pattern}."
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
# resource path
|
|
126
|
+
local_var_path = '/snap_packs/{snp_id}'.sub('{' + 'snp_id' + '}', CGI.escape(snp_id.to_s))
|
|
127
|
+
|
|
128
|
+
# query parameters
|
|
129
|
+
query_params = opts[:query_params] || {}
|
|
130
|
+
|
|
131
|
+
# header parameters
|
|
132
|
+
header_params = opts[:header_params] || {}
|
|
133
|
+
# HTTP header 'Accept' (if needed)
|
|
134
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
135
|
+
|
|
136
|
+
# form parameters
|
|
137
|
+
form_params = opts[:form_params] || {}
|
|
138
|
+
|
|
139
|
+
# http body (model)
|
|
140
|
+
post_body = opts[:debug_body]
|
|
141
|
+
|
|
142
|
+
# return_type
|
|
143
|
+
return_type = opts[:debug_return_type] || 'SnapPackDeletion'
|
|
144
|
+
|
|
145
|
+
# auth_names
|
|
146
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
147
|
+
|
|
148
|
+
new_options = opts.merge(
|
|
149
|
+
:operation => :"SnapPacksApi.snap_pack_delete",
|
|
150
|
+
:header_params => header_params,
|
|
151
|
+
:query_params => query_params,
|
|
152
|
+
:form_params => form_params,
|
|
153
|
+
:body => post_body,
|
|
154
|
+
:auth_names => auth_names,
|
|
155
|
+
:return_type => return_type
|
|
156
|
+
)
|
|
157
|
+
|
|
158
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
159
|
+
if @api_client.config.debugging
|
|
160
|
+
@api_client.config.logger.debug "API called: SnapPacksApi#snap_pack_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
161
|
+
end
|
|
162
|
+
return data, status_code, headers
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# get
|
|
166
|
+
# Retrieves the details of an existing snap_pack. You need only supply the unique snap_pack identifier that was returned upon snap_pack creation.
|
|
167
|
+
# @param snp_id [String] id of the snap_pack
|
|
168
|
+
# @param [Hash] opts the optional parameters
|
|
169
|
+
# @return [SnapPack]
|
|
170
|
+
def get(snp_id, opts = {})
|
|
171
|
+
data, _status_code, _headers = snap_pack_retrieve_with_http_info(snp_id, opts)
|
|
172
|
+
data
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
# get
|
|
176
|
+
# Retrieves the details of an existing snap_pack. You need only supply the unique snap_pack identifier that was returned upon snap_pack creation.
|
|
177
|
+
# @param snp_id [String] id of the snap_pack
|
|
178
|
+
# @param [Hash] opts the optional parameters
|
|
179
|
+
# @return [Array<(SnapPack, Integer, Hash)>] SnapPack data, response status code and response headers
|
|
180
|
+
def snap_pack_retrieve_with_http_info(snp_id, opts = {})
|
|
181
|
+
if @api_client.config.debugging
|
|
182
|
+
@api_client.config.logger.debug 'Calling API: SnapPacksApi.snap_pack_retrieve ...'
|
|
183
|
+
end
|
|
184
|
+
# verify the required parameter 'snp_id' is set
|
|
185
|
+
if @api_client.config.client_side_validation && snp_id.nil?
|
|
186
|
+
fail ArgumentError, "Missing the required parameter 'snp_id' when calling SnapPacksApi.snap_pack_retrieve"
|
|
187
|
+
end
|
|
188
|
+
pattern = Regexp.new(/^ord_[a-zA-Z0-9]+$/)
|
|
189
|
+
if @api_client.config.client_side_validation && snp_id !~ pattern
|
|
190
|
+
fail ArgumentError, "invalid value for 'snp_id' when calling SnapPacksApi.snap_pack_retrieve, must conform to the pattern #{pattern}."
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
# resource path
|
|
194
|
+
local_var_path = '/snap_packs/{snp_id}'.sub('{' + 'snp_id' + '}', CGI.escape(snp_id.to_s))
|
|
195
|
+
|
|
196
|
+
# query parameters
|
|
197
|
+
query_params = opts[:query_params] || {}
|
|
198
|
+
|
|
199
|
+
# header parameters
|
|
200
|
+
header_params = opts[:header_params] || {}
|
|
201
|
+
# HTTP header 'Accept' (if needed)
|
|
202
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
203
|
+
|
|
204
|
+
# form parameters
|
|
205
|
+
form_params = opts[:form_params] || {}
|
|
206
|
+
|
|
207
|
+
# http body (model)
|
|
208
|
+
post_body = opts[:debug_body]
|
|
209
|
+
|
|
210
|
+
# return_type
|
|
211
|
+
return_type = opts[:debug_return_type] || 'SnapPack'
|
|
212
|
+
|
|
213
|
+
# auth_names
|
|
214
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
215
|
+
|
|
216
|
+
new_options = opts.merge(
|
|
217
|
+
:operation => :"SnapPacksApi.snap_pack_retrieve",
|
|
218
|
+
:header_params => header_params,
|
|
219
|
+
:query_params => query_params,
|
|
220
|
+
:form_params => form_params,
|
|
221
|
+
:body => post_body,
|
|
222
|
+
:auth_names => auth_names,
|
|
223
|
+
:return_type => return_type
|
|
224
|
+
)
|
|
225
|
+
|
|
226
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
227
|
+
if @api_client.config.debugging
|
|
228
|
+
@api_client.config.logger.debug "API called: SnapPacksApi#snap_pack_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
229
|
+
end
|
|
230
|
+
return data, status_code, headers
|
|
231
|
+
end
|
|
232
|
+
|
|
233
|
+
# list
|
|
234
|
+
# 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.
|
|
235
|
+
# @param [Hash] opts the optional parameters
|
|
236
|
+
# @option opts [Integer] :limit How many results to return. (default to 10)
|
|
237
|
+
# @option opts [String] :before 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.
|
|
238
|
+
# @option opts [String] :after 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.
|
|
239
|
+
# @option opts [Array<String>] :include Request that the response include the total count by specifying `include[]=total_count`.
|
|
240
|
+
# @option opts [Hash<String, Time>] :date_created Filter by date created.
|
|
241
|
+
# @option opts [Hash<String, String>] :metadata Filter by metadata key-value pair`.
|
|
242
|
+
# @option opts [Array<SnapPackSize>] :size The Snap Pack sizes to be returned.
|
|
243
|
+
# @option opts [Boolean] :scheduled * `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`
|
|
244
|
+
# @option opts [Hash<String, String>] :send_date Filter by date sent.
|
|
245
|
+
# @option opts [MailType] :mail_type 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. (default to 'usps_first_class')
|
|
246
|
+
# @option opts [SortBy4] :sort_by Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
247
|
+
# @return [SnapPackList]
|
|
248
|
+
def list(opts = {})
|
|
249
|
+
data, _status_code, _headers = snap_packs_list_with_http_info(opts)
|
|
250
|
+
data
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
# list
|
|
254
|
+
# 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.
|
|
255
|
+
# @param [Hash] opts the optional parameters
|
|
256
|
+
# @option opts [Integer] :limit How many results to return. (default to 10)
|
|
257
|
+
# @option opts [String] :before 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.
|
|
258
|
+
# @option opts [String] :after 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.
|
|
259
|
+
# @option opts [Array<String>] :include Request that the response include the total count by specifying `include[]=total_count`.
|
|
260
|
+
# @option opts [Hash<String, Time>] :date_created Filter by date created.
|
|
261
|
+
# @option opts [Hash<String, String>] :metadata Filter by metadata key-value pair`.
|
|
262
|
+
# @option opts [Array<SnapPackSize>] :size The Snap Pack sizes to be returned.
|
|
263
|
+
# @option opts [Boolean] :scheduled * `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`
|
|
264
|
+
# @option opts [Hash<String, String>] :send_date Filter by date sent.
|
|
265
|
+
# @option opts [MailType] :mail_type 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. (default to 'usps_first_class')
|
|
266
|
+
# @option opts [SortBy4] :sort_by Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
267
|
+
# @return [Array<(SnapPackList, Integer, Hash)>] SnapPackList data, response status code and response headers
|
|
268
|
+
def snap_packs_list_with_http_info(opts = {})
|
|
269
|
+
if @api_client.config.debugging
|
|
270
|
+
@api_client.config.logger.debug 'Calling API: SnapPacksApi.snap_packs_list ...'
|
|
271
|
+
end
|
|
272
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
|
273
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SnapPacksApi.snap_packs_list, must be smaller than or equal to 100.'
|
|
274
|
+
end
|
|
275
|
+
|
|
276
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
277
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SnapPacksApi.snap_packs_list, must be greater than or equal to 1.'
|
|
278
|
+
end
|
|
279
|
+
|
|
280
|
+
if @api_client.config.client_side_validation && !opts[:'metadata'].nil? && opts[:'metadata'].to_s.length > 500
|
|
281
|
+
fail ArgumentError, 'invalid value for "opts[:"metadata"]" when calling SnapPacksApi.snap_packs_list, the character length must be smaller than or equal to 500.'
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
pattern = Regexp.new(/[^"\\]{0,500}/)
|
|
285
|
+
if @api_client.config.client_side_validation && !opts[:'metadata'].nil? && opts[:'metadata'] !~ pattern
|
|
286
|
+
fail ArgumentError, "invalid value for 'opts[:\"metadata\"]' when calling SnapPacksApi.snap_packs_list, must conform to the pattern #{pattern}."
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
# resource path
|
|
290
|
+
local_var_path = '/snap_packs'
|
|
291
|
+
|
|
292
|
+
# query parameters
|
|
293
|
+
query_params = opts[:query_params] || {}
|
|
294
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
295
|
+
query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
|
|
296
|
+
query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
|
|
297
|
+
query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if !opts[:'include'].nil?
|
|
298
|
+
query_params[:'date_created'] = opts[:'date_created'] if !opts[:'date_created'].nil?
|
|
299
|
+
query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?
|
|
300
|
+
query_params[:'size'] = @api_client.build_collection_param(opts[:'size'], :multi) if !opts[:'size'].nil?
|
|
301
|
+
query_params[:'scheduled'] = opts[:'scheduled'] if !opts[:'scheduled'].nil?
|
|
302
|
+
query_params[:'send_date'] = opts[:'send_date'] if !opts[:'send_date'].nil?
|
|
303
|
+
query_params[:'mail_type'] = opts[:'mail_type'] if !opts[:'mail_type'].nil?
|
|
304
|
+
query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
|
|
305
|
+
|
|
306
|
+
# header parameters
|
|
307
|
+
header_params = opts[:header_params] || {}
|
|
308
|
+
# HTTP header 'Accept' (if needed)
|
|
309
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
310
|
+
|
|
311
|
+
# form parameters
|
|
312
|
+
form_params = opts[:form_params] || {}
|
|
313
|
+
|
|
314
|
+
# http body (model)
|
|
315
|
+
post_body = opts[:debug_body]
|
|
316
|
+
|
|
317
|
+
# return_type
|
|
318
|
+
return_type = opts[:debug_return_type] || 'SnapPackList'
|
|
319
|
+
|
|
320
|
+
# auth_names
|
|
321
|
+
auth_names = opts[:debug_auth_names] || ['basicAuth']
|
|
322
|
+
|
|
323
|
+
new_options = opts.merge(
|
|
324
|
+
:operation => :"SnapPacksApi.snap_packs_list",
|
|
325
|
+
:header_params => header_params,
|
|
326
|
+
:query_params => query_params,
|
|
327
|
+
:form_params => form_params,
|
|
328
|
+
:body => post_body,
|
|
329
|
+
:auth_names => auth_names,
|
|
330
|
+
:return_type => return_type
|
|
331
|
+
)
|
|
332
|
+
|
|
333
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
334
|
+
if @api_client.config.debugging
|
|
335
|
+
@api_client.config.logger.debug "API called: SnapPacksApi#snap_packs_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
336
|
+
end
|
|
337
|
+
return data, status_code, headers
|
|
338
|
+
end
|
|
339
|
+
end
|
|
340
|
+
end
|