lob 6.0.8 → 6.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CODE_SNIPPETS.md +10 -10
- data/Gemfile +0 -0
- data/Gemfile.lock +22 -18
- data/LICENSE +0 -0
- data/MIGRATION.md +0 -0
- data/Rakefile +0 -0
- data/__tests__/Api/Address.unit.rb +9 -9
- data/__tests__/Api/BankAccount.unit.rb +3 -3
- data/__tests__/Api/BillingGroup.unit.rb +1 -1
- data/__tests__/Api/Card.unit.rb +1 -1
- data/__tests__/Api/CardOrder.unit.rb +1 -1
- data/__tests__/Api/Check.unit.rb +1 -1
- data/__tests__/Api/IntlAutocompletion.unit.rb +1 -1
- data/__tests__/Api/IntlVerification.unit.rb +1 -1
- data/__tests__/Api/Letter.unit.rb +1 -1
- data/__tests__/Api/Postcard.unit.rb +1 -1
- data/__tests__/Api/Require.unit.rb +0 -1
- data/__tests__/Api/ReverseGeocodeLookup.unit.rb +1 -1
- data/__tests__/Api/SelfMailer.unit.rb +1 -1
- data/__tests__/Api/Template.unit.rb +1 -1
- data/__tests__/Api/TemplateVersion.unit.rb +1 -1
- data/__tests__/Api/UsAutocompletion.unit.rb +1 -1
- data/__tests__/Api/UsVerification.unit.rb +1 -1
- data/__tests__/Api/ZipLookup.unit.rb +1 -1
- data/__tests__/Integration/Address.spec.rb +4 -4
- data/__tests__/Integration/BankAccount.spec.rb +2 -2
- data/__tests__/Integration/BillingGroup.spec.rb +3 -3
- data/__tests__/Integration/Card.spec.rb +1 -1
- data/__tests__/Integration/CardOrder.spec.rb +1 -1
- data/__tests__/Integration/Check.spec.rb +10 -6
- data/__tests__/Integration/IntlAutocompletion.spec.rb +2 -2
- data/__tests__/Integration/IntlVerification.spec.rb +3 -3
- data/__tests__/Integration/Letter.spec.rb +16 -9
- data/__tests__/Integration/Postcard.spec.rb +40 -4
- data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +1 -1
- data/__tests__/Integration/SelfMailer.spec.rb +22 -2
- data/__tests__/Integration/Template.spec.rb +4 -3
- data/__tests__/Integration/TemplateVersion.spec.rb +1 -1
- data/__tests__/Integration/UsAutocompletion.spec.rb +1 -2
- data/__tests__/Integration/UsVerification.spec.rb +1 -1
- data/__tests__/Integration/ZipLookup.spec.rb +1 -1
- data/__tests__/TestFixtures.rb +0 -0
- data/docs/Address.md +44 -41
- data/docs/AddressDeletion.md +1 -1
- data/docs/AddressDomestic.md +1 -1
- data/docs/AddressDomesticExpanded.md +1 -1
- data/docs/AddressEditable.md +1 -1
- data/docs/AddressList.md +1 -1
- data/docs/AddressesApi.md +4 -4
- data/docs/BankAccount.md +1 -1
- data/docs/BankAccountDeletion.md +1 -1
- data/docs/BankAccountList.md +1 -1
- data/docs/BankAccountVerify.md +1 -1
- data/docs/BankAccountWritable.md +1 -1
- data/docs/BankAccountsApi.md +5 -5
- data/docs/BankTypeEnum.md +1 -1
- data/docs/BillingGroup.md +1 -1
- data/docs/BillingGroupEditable.md +1 -1
- data/docs/BillingGroupList.md +1 -1
- data/docs/BillingGroupsApi.md +4 -4
- data/docs/Buckslip.md +1 -1
- data/docs/BuckslipDeletion.md +1 -1
- data/docs/BuckslipEditable.md +1 -1
- data/docs/BuckslipOrder.md +1 -1
- data/docs/BuckslipOrderEditable.md +1 -1
- data/docs/BuckslipOrdersApi.md +2 -2
- data/docs/BuckslipOrdersList.md +1 -1
- data/docs/BuckslipUpdatable.md +1 -1
- data/docs/BuckslipsApi.md +13 -9
- data/docs/BuckslipsList.md +1 -1
- data/docs/BulkError.md +1 -1
- data/docs/BulkErrorProperties.md +1 -1
- data/docs/Campaign.md +2 -2
- data/docs/CampaignCreative.md +1 -1
- data/docs/CampaignDeletion.md +1 -1
- data/docs/CampaignUpdatable.md +1 -1
- data/docs/CampaignWritable.md +2 -2
- data/docs/CampaignsApi.md +6 -6
- data/docs/CampaignsList.md +1 -1
- data/docs/Card.md +1 -1
- data/docs/CardDeletion.md +1 -1
- data/docs/CardEditable.md +1 -1
- data/docs/CardList.md +1 -1
- data/docs/CardOrder.md +1 -1
- data/docs/CardOrderEditable.md +1 -1
- data/docs/CardOrderList.md +1 -1
- data/docs/CardOrdersApi.md +2 -2
- data/docs/CardUpdatable.md +1 -1
- data/docs/CardsApi.md +5 -5
- data/docs/Check.md +4 -2
- data/docs/CheckDeletion.md +1 -1
- data/docs/CheckEditable.md +4 -2
- data/docs/CheckList.md +1 -1
- data/docs/ChecksApi.md +7 -7
- data/docs/ChkUseType.md +15 -0
- data/docs/CmpScheduleType.md +1 -1
- data/docs/CmpUseType.md +1 -1
- data/docs/CountryExtended.md +1 -1
- data/docs/CountryExtendedExpanded.md +1 -1
- data/docs/CountryExtendedExpandedNoUs.md +0 -0
- data/docs/CreativePatch.md +1 -1
- data/docs/CreativeResponse.md +1 -1
- data/docs/CreativeWritable.md +1 -1
- data/docs/CreativesApi.md +3 -3
- data/docs/CustomEnvelopeReturned.md +1 -1
- data/docs/DefaultApi.md +1 -1
- data/docs/DeliverabilityAnalysis.md +16 -16
- data/docs/DpvFootnote.md +1 -1
- data/docs/EngineHtml.md +1 -1
- data/docs/EventType.md +1 -1
- data/docs/Events.md +1 -1
- data/docs/Export.md +1 -1
- data/docs/ExportModel.md +1 -1
- data/docs/GeocodeAddresses.md +1 -1
- data/docs/GeocodeComponents.md +1 -1
- data/docs/HTTPValidationError.md +1 -1
- data/docs/IdentityValidation.md +1 -1
- data/docs/IdentityValidationApi.md +1 -1
- data/docs/InlineObject.md +1 -1
- data/docs/IntlAddress.md +2 -2
- data/docs/IntlAutocompletions.md +1 -1
- data/docs/IntlAutocompletionsApi.md +2 -2
- data/docs/IntlAutocompletionsWritable.md +1 -1
- data/docs/IntlComponents.md +1 -1
- data/docs/IntlSuggestions.md +1 -1
- data/docs/IntlVerification.md +1 -1
- data/docs/IntlVerificationOrError.md +1 -1
- data/docs/IntlVerificationWritable.md +1 -1
- data/docs/IntlVerifications.md +1 -1
- data/docs/IntlVerificationsApi.md +3 -3
- data/docs/IntlVerificationsPayload.md +1 -1
- data/docs/Letter.md +6 -2
- data/docs/LetterCustomEnvelope.md +1 -1
- data/docs/LetterDeletion.md +1 -1
- data/docs/LetterDetailsReturned.md +1 -1
- data/docs/LetterDetailsWritable.md +1 -1
- data/docs/LetterEditable.md +4 -2
- data/docs/LetterList.md +1 -1
- data/docs/LettersApi.md +10 -8
- data/docs/LobConfidenceScore.md +1 -1
- data/docs/LobError.md +1 -1
- data/docs/Location.md +1 -1
- data/docs/LocationAnalysis.md +1 -1
- data/docs/LtrUseType.md +15 -0
- data/docs/MailType.md +1 -1
- data/docs/MultiLineAddress.md +1 -1
- data/docs/MultipleComponents.md +1 -1
- data/docs/MultipleComponentsIntl.md +1 -1
- data/docs/MultipleComponentsList.md +1 -1
- data/docs/OptionalAddressColumnMapping.md +22 -0
- data/docs/PlaceholderModel.md +1 -1
- data/docs/Postcard.md +4 -2
- data/docs/PostcardDeletion.md +1 -1
- data/docs/PostcardDetailsReturned.md +1 -1
- data/docs/PostcardDetailsWritable.md +1 -1
- data/docs/PostcardEditable.md +4 -2
- data/docs/PostcardList.md +1 -1
- data/docs/PostcardSize.md +1 -1
- data/docs/PostcardsApi.md +7 -7
- data/docs/PscUseType.md +15 -0
- data/docs/QrCode.md +1 -1
- data/docs/RequiredAddressColumnMapping.md +26 -0
- data/docs/ReturnEnvelope.md +1 -1
- data/docs/ReverseGeocode.md +1 -1
- data/docs/ReverseGeocodeLookupsApi.md +1 -1
- data/docs/SelfMailer.md +5 -3
- data/docs/SelfMailerDeletion.md +1 -1
- data/docs/SelfMailerEditable.md +4 -2
- data/docs/SelfMailerList.md +1 -1
- data/docs/SelfMailerSize.md +1 -1
- data/docs/SelfMailersApi.md +7 -7
- data/docs/SfmUseType.md +15 -0
- data/docs/SnapPack.md +50 -0
- data/docs/SnapPackDeletion.md +22 -0
- data/docs/SnapPackEditable.md +40 -0
- data/docs/SnapPackList.md +28 -0
- data/docs/SnapPackSize.md +15 -0
- data/docs/SnapPacksApi.md +317 -0
- data/docs/SnpUseType.md +15 -0
- data/docs/SortBy.md +1 -1
- data/docs/SortBy1.md +1 -1
- data/docs/SortBy2.md +1 -1
- data/docs/SortBy3.md +1 -1
- data/docs/SortBy4.md +20 -0
- data/docs/SortByDateModified.md +1 -1
- data/docs/Suggestions.md +1 -1
- data/docs/Template.md +1 -1
- data/docs/TemplateDeletion.md +1 -1
- data/docs/TemplateList.md +1 -1
- data/docs/TemplateUpdate.md +1 -1
- data/docs/TemplateVersion.md +1 -1
- data/docs/TemplateVersionDeletion.md +1 -1
- data/docs/TemplateVersionList.md +1 -1
- data/docs/TemplateVersionUpdatable.md +1 -1
- data/docs/TemplateVersionWritable.md +1 -1
- data/docs/TemplateVersionsApi.md +5 -5
- data/docs/TemplateWritable.md +1 -1
- data/docs/TemplatesApi.md +5 -5
- data/docs/Thumbnail.md +1 -1
- data/docs/TrackingEventCertified.md +1 -1
- data/docs/TrackingEventDetails.md +1 -1
- data/docs/TrackingEventNormal.md +2 -2
- data/docs/Upload.md +12 -6
- data/docs/UploadCreateExport.md +1 -1
- data/docs/UploadFile.md +1 -1
- data/docs/UploadState.md +1 -1
- data/docs/UploadUpdatable.md +10 -4
- data/docs/UploadWritable.md +11 -3
- data/docs/UploadsApi.md +102 -102
- data/docs/UploadsMetadata.md +18 -0
- data/docs/UsAddress.md +0 -0
- data/docs/UsAutocompletions.md +1 -1
- data/docs/UsAutocompletionsApi.md +1 -1
- data/docs/UsAutocompletionsWritable.md +1 -1
- data/docs/UsComponents.md +28 -28
- data/docs/UsVerification.md +1 -1
- data/docs/UsVerificationOrError.md +1 -1
- data/docs/UsVerifications.md +1 -1
- data/docs/UsVerificationsApi.md +2 -2
- data/docs/UsVerificationsWritable.md +1 -1
- data/docs/ValidationError.md +1 -1
- data/docs/Zip.md +1 -1
- data/docs/ZipCodeType.md +1 -1
- data/docs/ZipEditable.md +1 -1
- data/docs/ZipLookupCity.md +1 -1
- data/docs/ZipLookupsApi.md +1 -1
- data/git_push.sh +0 -0
- data/lib/{openapi_client → lob}/api/checks_api.rb +2 -2
- data/lib/{openapi_client → lob}/api/letters_api.rb +2 -2
- data/lib/{openapi_client → lob}/api/postcards_api.rb +2 -2
- data/lib/{openapi_client → lob}/api/self_mailers_api.rb +2 -2
- data/lib/lob/api/snap_packs_api.rb +340 -0
- data/lib/{openapi_client → lob}/models/address.rb +0 -0
- data/lib/{openapi_client → lob}/models/bank_account.rb +18 -7
- data/lib/{openapi_client → lob}/models/bank_account_verify.rb +69 -13
- data/lib/{openapi_client → lob}/models/check.rb +3 -3
- data/lib/{openapi_client → lob}/models/country_extended_expanded_no_us.rb +0 -0
- data/lib/{openapi_client → lob}/models/intl_address.rb +12 -14
- data/lib/{openapi_client → lob}/models/intl_components.rb +0 -0
- data/lib/{openapi_client → lob}/models/letter.rb +4 -19
- data/lib/{openapi_client → lob}/models/multiple_components.rb +5 -5
- data/lib/{openapi_client → lob}/models/postcard.rb +3 -3
- data/lib/{openapi_client → lob}/models/self_mailer.rb +3 -3
- data/lib/{openapi_client → lob}/models/self_mailer_size.rb +1 -0
- data/lib/lob/models/snap_pack.rb +584 -0
- data/lib/lob/models/snap_pack_deletion.rb +303 -0
- data/lib/lob/models/snap_pack_editable.rb +384 -0
- data/lib/lob/models/snap_pack_list.rb +324 -0
- data/lib/lob/models/snap_pack_size.rb +36 -0
- data/lib/lob/models/snp_use_type.rb +38 -0
- data/lib/lob/models/sort_by4.rb +283 -0
- data/lib/{openapi_client → lob}/models/thumbnail.rb +9 -9
- data/lib/{openapi_client → lob}/models/upload.rb +16 -1
- data/lib/{openapi_client → lob}/models/us_address.rb +0 -0
- data/lib/{openapi_client → lob}/models/us_verification.rb +8 -8
- data/lib/{openapi_client → lob}/models/us_verification_or_error.rb +6 -6
- data/lib/{openapi_client → lob}/models/us_verifications.rb +1 -1
- data/lib/{openapi_client → lob}/models/us_verifications_writable.rb +6 -6
- data/lib/{openapi_client → lob}/version.rb +1 -1
- data/lib/lob.rb +223 -1
- data/{openapi_client.gemspec → lob.gemspec} +8 -7
- data/spec/api/addresses_api_spec.rb +0 -0
- data/spec/api/bank_accounts_api_spec.rb +77 -44
- data/spec/api/billing_groups_api_spec.rb +0 -0
- data/spec/api/buckslip_orders_api_spec.rb +62 -0
- data/spec/api/buckslips_api_spec.rb +100 -0
- data/spec/api/campaigns_api_spec.rb +0 -0
- data/spec/api/card_orders_api_spec.rb +0 -0
- data/spec/api/cards_api_spec.rb +0 -0
- data/spec/api/checks_api_spec.rb +0 -0
- data/spec/api/creatives_api_spec.rb +0 -0
- data/spec/api/default_api_spec.rb +0 -0
- data/spec/api/identity_validation_api_spec.rb +0 -0
- data/spec/api/intl_autocompletions_api_spec.rb +0 -0
- data/spec/api/intl_verifications_api_spec.rb +0 -0
- data/spec/api/letters_api_spec.rb +0 -0
- data/spec/api/postcards_api_spec.rb +0 -0
- data/spec/api/reverse_geocode_lookups_api_spec.rb +0 -0
- data/spec/api/self_mailers_api_spec.rb +0 -0
- data/spec/api/snap_packs_api_spec.rb +94 -0
- data/spec/api/template_versions_api_spec.rb +0 -0
- data/spec/api/templates_api_spec.rb +0 -0
- data/spec/api/uploads_api_spec.rb +0 -0
- data/spec/api/us_autocompletions_api_spec.rb +0 -0
- data/spec/api/us_verifications_api_spec.rb +0 -0
- data/spec/api/zip_lookups_api_spec.rb +0 -0
- data/spec/api_client_spec.rb +0 -0
- data/spec/configuration_spec.rb +0 -0
- data/spec/spec_helper.rb +1 -1
- metadata +238 -208
- data/lib/openapi_client.rb +0 -212
- /data/lib/{openapi_client → lob}/api/addresses_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/bank_accounts_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/billing_groups_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/buckslip_orders_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/buckslips_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/campaigns_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/card_orders_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/cards_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/creatives_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/default_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/identity_validation_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/intl_autocompletions_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/intl_verifications_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/reverse_geocode_lookups_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/template_versions_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/templates_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/uploads_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/us_autocompletions_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/us_verifications_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api/zip_lookups_api.rb +0 -0
- /data/lib/{openapi_client → lob}/api_client.rb +0 -0
- /data/lib/{openapi_client → lob}/api_error.rb +0 -0
- /data/lib/{openapi_client → lob}/configuration.rb +0 -0
- /data/lib/{openapi_client → lob}/models/address_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/address_domestic.rb +0 -0
- /data/lib/{openapi_client → lob}/models/address_domestic_expanded.rb +0 -0
- /data/lib/{openapi_client → lob}/models/address_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/address_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/bank_account_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/bank_account_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/bank_account_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/bank_type_enum.rb +0 -0
- /data/lib/{openapi_client → lob}/models/billing_group.rb +0 -0
- /data/lib/{openapi_client → lob}/models/billing_group_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/billing_group_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip_order.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip_order_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip_orders_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslip_updatable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/buckslips_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/bulk_error.rb +0 -0
- /data/lib/{openapi_client → lob}/models/bulk_error_properties.rb +0 -0
- /data/lib/{openapi_client → lob}/models/campaign.rb +0 -0
- /data/lib/{openapi_client → lob}/models/campaign_creative.rb +0 -0
- /data/lib/{openapi_client → lob}/models/campaign_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/campaign_updatable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/campaign_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/campaigns_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_order.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_order_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_order_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/card_updatable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/check_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/check_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/check_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/chk_use_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/cmp_schedule_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/cmp_use_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/country_extended.rb +0 -0
- /data/lib/{openapi_client → lob}/models/country_extended_expanded.rb +0 -0
- /data/lib/{openapi_client → lob}/models/creative_patch.rb +0 -0
- /data/lib/{openapi_client → lob}/models/creative_response.rb +0 -0
- /data/lib/{openapi_client → lob}/models/creative_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/custom_envelope_returned.rb +0 -0
- /data/lib/{openapi_client → lob}/models/deliverability_analysis.rb +0 -0
- /data/lib/{openapi_client → lob}/models/dpv_footnote.rb +0 -0
- /data/lib/{openapi_client → lob}/models/engine_html.rb +0 -0
- /data/lib/{openapi_client → lob}/models/event_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/events.rb +0 -0
- /data/lib/{openapi_client → lob}/models/export.rb +0 -0
- /data/lib/{openapi_client → lob}/models/export_model.rb +0 -0
- /data/lib/{openapi_client → lob}/models/geocode_addresses.rb +0 -0
- /data/lib/{openapi_client → lob}/models/geocode_components.rb +0 -0
- /data/lib/{openapi_client → lob}/models/http_validation_error.rb +0 -0
- /data/lib/{openapi_client → lob}/models/identity_validation.rb +0 -0
- /data/lib/{openapi_client → lob}/models/inline_object.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_autocompletions.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_autocompletions_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_suggestions.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_verification.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_verification_or_error.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_verification_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_verifications.rb +0 -0
- /data/lib/{openapi_client → lob}/models/intl_verifications_payload.rb +0 -0
- /data/lib/{openapi_client → lob}/models/letter_custom_envelope.rb +0 -0
- /data/lib/{openapi_client → lob}/models/letter_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/letter_details_returned.rb +0 -0
- /data/lib/{openapi_client → lob}/models/letter_details_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/letter_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/letter_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/lob_confidence_score.rb +0 -0
- /data/lib/{openapi_client → lob}/models/lob_error.rb +0 -0
- /data/lib/{openapi_client → lob}/models/location.rb +0 -0
- /data/lib/{openapi_client → lob}/models/location_analysis.rb +0 -0
- /data/lib/{openapi_client → lob}/models/ltr_use_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/mail_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/multi_line_address.rb +0 -0
- /data/lib/{openapi_client → lob}/models/multiple_components_intl.rb +0 -0
- /data/lib/{openapi_client → lob}/models/multiple_components_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/optional_address_column_mapping.rb +0 -0
- /data/lib/{openapi_client → lob}/models/placeholder_model.rb +0 -0
- /data/lib/{openapi_client → lob}/models/postcard_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/postcard_details_returned.rb +0 -0
- /data/lib/{openapi_client → lob}/models/postcard_details_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/postcard_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/postcard_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/postcard_size.rb +0 -0
- /data/lib/{openapi_client → lob}/models/psc_use_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/qr_code.rb +0 -0
- /data/lib/{openapi_client → lob}/models/required_address_column_mapping.rb +0 -0
- /data/lib/{openapi_client → lob}/models/return_envelope.rb +0 -0
- /data/lib/{openapi_client → lob}/models/reverse_geocode.rb +0 -0
- /data/lib/{openapi_client → lob}/models/self_mailer_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/self_mailer_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/self_mailer_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/sfm_use_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/sort_by.rb +0 -0
- /data/lib/{openapi_client → lob}/models/sort_by1.rb +0 -0
- /data/lib/{openapi_client → lob}/models/sort_by2.rb +0 -0
- /data/lib/{openapi_client → lob}/models/sort_by3.rb +0 -0
- /data/lib/{openapi_client → lob}/models/sort_by_date_modified.rb +0 -0
- /data/lib/{openapi_client → lob}/models/suggestions.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_update.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_version.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_version_deletion.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_version_list.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_version_updatable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_version_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/template_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/tracking_event_certified.rb +0 -0
- /data/lib/{openapi_client → lob}/models/tracking_event_details.rb +0 -0
- /data/lib/{openapi_client → lob}/models/tracking_event_normal.rb +0 -0
- /data/lib/{openapi_client → lob}/models/upload_create_export.rb +0 -0
- /data/lib/{openapi_client → lob}/models/upload_file.rb +0 -0
- /data/lib/{openapi_client → lob}/models/upload_state.rb +0 -0
- /data/lib/{openapi_client → lob}/models/upload_updatable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/upload_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/uploads_metadata.rb +0 -0
- /data/lib/{openapi_client → lob}/models/us_autocompletions.rb +0 -0
- /data/lib/{openapi_client → lob}/models/us_autocompletions_writable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/us_components.rb +0 -0
- /data/lib/{openapi_client → lob}/models/validation_error.rb +0 -0
- /data/lib/{openapi_client → lob}/models/zip.rb +0 -0
- /data/lib/{openapi_client → lob}/models/zip_code_type.rb +0 -0
- /data/lib/{openapi_client → lob}/models/zip_editable.rb +0 -0
- /data/lib/{openapi_client → lob}/models/zip_lookup_city.rb +0 -0
data/docs/BillingGroupsApi.md
CHANGED
|
@@ -22,7 +22,7 @@ Creates a new billing_group with the provided properties.
|
|
|
22
22
|
|
|
23
23
|
```ruby
|
|
24
24
|
require 'time'
|
|
25
|
-
require '
|
|
25
|
+
require 'lob'
|
|
26
26
|
# setup authorization
|
|
27
27
|
Lob.configure do |config|
|
|
28
28
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -92,7 +92,7 @@ Retrieves the details of an existing billing_group. You need only supply the uni
|
|
|
92
92
|
|
|
93
93
|
```ruby
|
|
94
94
|
require 'time'
|
|
95
|
-
require '
|
|
95
|
+
require 'lob'
|
|
96
96
|
# setup authorization
|
|
97
97
|
Lob.configure do |config|
|
|
98
98
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -162,7 +162,7 @@ Updates all editable attributes of the billing_group with the given id.
|
|
|
162
162
|
|
|
163
163
|
```ruby
|
|
164
164
|
require 'time'
|
|
165
|
-
require '
|
|
165
|
+
require 'lob'
|
|
166
166
|
# setup authorization
|
|
167
167
|
Lob.configure do |config|
|
|
168
168
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -234,7 +234,7 @@ Returns a list of your billing_groups. The billing_groups are returned sorted by
|
|
|
234
234
|
|
|
235
235
|
```ruby
|
|
236
236
|
require 'time'
|
|
237
|
-
require '
|
|
237
|
+
require 'lob'
|
|
238
238
|
# setup authorization
|
|
239
239
|
Lob.configure do |config|
|
|
240
240
|
# Configure HTTP basic authorization: basicAuth
|
data/docs/Buckslip.md
CHANGED
data/docs/BuckslipDeletion.md
CHANGED
data/docs/BuckslipEditable.md
CHANGED
data/docs/BuckslipOrder.md
CHANGED
data/docs/BuckslipOrdersApi.md
CHANGED
|
@@ -20,7 +20,7 @@ Creates a new buckslip order given information
|
|
|
20
20
|
|
|
21
21
|
```ruby
|
|
22
22
|
require 'time'
|
|
23
|
-
require '
|
|
23
|
+
require 'lob'
|
|
24
24
|
# setup authorization
|
|
25
25
|
Lob.configure do |config|
|
|
26
26
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -92,7 +92,7 @@ Retrieves the buckslip orders associated with the given buckslip id.
|
|
|
92
92
|
|
|
93
93
|
```ruby
|
|
94
94
|
require 'time'
|
|
95
|
-
require '
|
|
95
|
+
require 'lob'
|
|
96
96
|
# setup authorization
|
|
97
97
|
Lob.configure do |config|
|
|
98
98
|
# Configure HTTP basic authorization: basicAuth
|
data/docs/BuckslipOrdersList.md
CHANGED
data/docs/BuckslipUpdatable.md
CHANGED
data/docs/BuckslipsApi.md
CHANGED
|
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.lob.com/v1*
|
|
|
13
13
|
|
|
14
14
|
## buckslip_create
|
|
15
15
|
|
|
16
|
-
> <Buckslip> buckslip_create(buckslip_editable)
|
|
16
|
+
> <Buckslip> buckslip_create(buckslip_editable, opts)
|
|
17
17
|
|
|
18
18
|
create
|
|
19
19
|
|
|
@@ -23,7 +23,7 @@ Creates a new buckslip given information
|
|
|
23
23
|
|
|
24
24
|
```ruby
|
|
25
25
|
require 'time'
|
|
26
|
-
require '
|
|
26
|
+
require 'lob'
|
|
27
27
|
# setup authorization
|
|
28
28
|
Lob.configure do |config|
|
|
29
29
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -33,10 +33,13 @@ end
|
|
|
33
33
|
|
|
34
34
|
api_instance = Lob::BuckslipsApi.new
|
|
35
35
|
buckslip_editable = Lob::BuckslipEditable.new({front: 'front_example'}) # BuckslipEditable |
|
|
36
|
+
opts = {
|
|
37
|
+
front: TODO # Object | An optional file upload as either a byte array or file type.
|
|
38
|
+
}
|
|
36
39
|
|
|
37
40
|
begin
|
|
38
41
|
# create
|
|
39
|
-
result = api_instance.create(buckslip_editable)
|
|
42
|
+
result = api_instance.create(buckslip_editable, opts)
|
|
40
43
|
p result
|
|
41
44
|
rescue Lob::ApiError => e
|
|
42
45
|
puts "Error when calling BuckslipsApi->create: #{e}"
|
|
@@ -47,12 +50,12 @@ end
|
|
|
47
50
|
|
|
48
51
|
This returns an Array which contains the response data, status code and headers.
|
|
49
52
|
|
|
50
|
-
> <Array(<Buckslip>, Integer, Hash)> buckslip_create_with_http_info(buckslip_editable)
|
|
53
|
+
> <Array(<Buckslip>, Integer, Hash)> buckslip_create_with_http_info(buckslip_editable, opts)
|
|
51
54
|
|
|
52
55
|
```ruby
|
|
53
56
|
begin
|
|
54
57
|
# create
|
|
55
|
-
data, status_code, headers = api_instance.buckslip_create_with_http_info(buckslip_editable)
|
|
58
|
+
data, status_code, headers = api_instance.buckslip_create_with_http_info(buckslip_editable, opts)
|
|
56
59
|
p status_code # => 2xx
|
|
57
60
|
p headers # => { ... }
|
|
58
61
|
p data # => <Buckslip>
|
|
@@ -66,6 +69,7 @@ end
|
|
|
66
69
|
| Name | Type | Description | Notes |
|
|
67
70
|
| ---- | ---- | ----------- | ----- |
|
|
68
71
|
| **buckslip_editable** | [**BuckslipEditable**](BuckslipEditable.md) | | |
|
|
72
|
+
| **front** | [**Object**](.md) | An optional file upload as either a byte array or file type. | [optional] |
|
|
69
73
|
|
|
70
74
|
### Return type
|
|
71
75
|
|
|
@@ -93,7 +97,7 @@ Delete an existing buckslip. You need only supply the unique identifier that was
|
|
|
93
97
|
|
|
94
98
|
```ruby
|
|
95
99
|
require 'time'
|
|
96
|
-
require '
|
|
100
|
+
require 'lob'
|
|
97
101
|
# setup authorization
|
|
98
102
|
Lob.configure do |config|
|
|
99
103
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -163,7 +167,7 @@ Retrieves the details of an existing buckslip. You need only supply the unique c
|
|
|
163
167
|
|
|
164
168
|
```ruby
|
|
165
169
|
require 'time'
|
|
166
|
-
require '
|
|
170
|
+
require 'lob'
|
|
167
171
|
# setup authorization
|
|
168
172
|
Lob.configure do |config|
|
|
169
173
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -233,7 +237,7 @@ Update the details of an existing buckslip. You need only supply the unique iden
|
|
|
233
237
|
|
|
234
238
|
```ruby
|
|
235
239
|
require 'time'
|
|
236
|
-
require '
|
|
240
|
+
require 'lob'
|
|
237
241
|
# setup authorization
|
|
238
242
|
Lob.configure do |config|
|
|
239
243
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -305,7 +309,7 @@ Returns a list of your buckslips. The buckslips are returned sorted by creation
|
|
|
305
309
|
|
|
306
310
|
```ruby
|
|
307
311
|
require 'time'
|
|
308
|
-
require '
|
|
312
|
+
require 'lob'
|
|
309
313
|
# setup authorization
|
|
310
314
|
Lob.configure do |config|
|
|
311
315
|
# Configure HTTP basic authorization: basicAuth
|
data/docs/BuckslipsList.md
CHANGED
data/docs/BulkError.md
CHANGED
data/docs/BulkErrorProperties.md
CHANGED
data/docs/Campaign.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
| **send_date** | **Time** | If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign. | [optional] |
|
|
13
13
|
| **cancel_window_campaign_minutes** | **Integer** | A window, in minutes, within which the campaign can be canceled. | [optional] |
|
|
14
14
|
| **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] |
|
|
15
|
-
| **use_type** | [**CmpUseType**](CmpUseType.md) | |
|
|
15
|
+
| **use_type** | [**CmpUseType**](CmpUseType.md) | | |
|
|
16
16
|
| **auto_cancel_if_ncoa** | **Boolean** | Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA. | |
|
|
17
17
|
| **id** | **String** | Unique identifier prefixed with `cmp_`. | |
|
|
18
18
|
| **account_id** | **String** | Account ID that this campaign is associated with. | [optional] |
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
## Example
|
|
27
27
|
|
|
28
28
|
```ruby
|
|
29
|
-
require '
|
|
29
|
+
require 'lob'
|
|
30
30
|
|
|
31
31
|
instance = Lob::Campaign.new(
|
|
32
32
|
billing_group_id: null,
|
data/docs/CampaignCreative.md
CHANGED
data/docs/CampaignDeletion.md
CHANGED
data/docs/CampaignUpdatable.md
CHANGED
data/docs/CampaignWritable.md
CHANGED
|
@@ -12,13 +12,13 @@
|
|
|
12
12
|
| **send_date** | **Time** | If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign. | [optional] |
|
|
13
13
|
| **cancel_window_campaign_minutes** | **Integer** | A window, in minutes, within which the campaign can be canceled. | [optional] |
|
|
14
14
|
| **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] |
|
|
15
|
-
| **use_type** | [**CmpUseType**](CmpUseType.md) | |
|
|
15
|
+
| **use_type** | [**CmpUseType**](CmpUseType.md) | | |
|
|
16
16
|
| **auto_cancel_if_ncoa** | **Boolean** | Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA. | [optional] |
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
20
20
|
```ruby
|
|
21
|
-
require '
|
|
21
|
+
require 'lob'
|
|
22
22
|
|
|
23
23
|
instance = Lob::CampaignWritable.new(
|
|
24
24
|
billing_group_id: null,
|
data/docs/CampaignsApi.md
CHANGED
|
@@ -23,7 +23,7 @@ Creates a new campaign with the provided properties. See how to launch your firs
|
|
|
23
23
|
|
|
24
24
|
```ruby
|
|
25
25
|
require 'time'
|
|
26
|
-
require '
|
|
26
|
+
require 'lob'
|
|
27
27
|
# setup authorization
|
|
28
28
|
Lob.configure do |config|
|
|
29
29
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -32,7 +32,7 @@ Lob.configure do |config|
|
|
|
32
32
|
end
|
|
33
33
|
|
|
34
34
|
api_instance = Lob::CampaignsApi.new
|
|
35
|
-
campaign_writable = Lob::CampaignWritable.new({name: 'name_example', schedule_type: Lob::CmpScheduleType::IMMEDIATE}) # CampaignWritable |
|
|
35
|
+
campaign_writable = Lob::CampaignWritable.new({name: 'name_example', schedule_type: Lob::CmpScheduleType::IMMEDIATE, use_type: Lob::CmpUseType::MARKETING}) # CampaignWritable |
|
|
36
36
|
opts = {
|
|
37
37
|
x_lang_output: 'native' # String | * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English.
|
|
38
38
|
}
|
|
@@ -97,7 +97,7 @@ Delete an existing campaign. You need only supply the unique identifier that was
|
|
|
97
97
|
|
|
98
98
|
```ruby
|
|
99
99
|
require 'time'
|
|
100
|
-
require '
|
|
100
|
+
require 'lob'
|
|
101
101
|
# setup authorization
|
|
102
102
|
Lob.configure do |config|
|
|
103
103
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -167,7 +167,7 @@ Retrieves the details of an existing campaign. You need only supply the unique c
|
|
|
167
167
|
|
|
168
168
|
```ruby
|
|
169
169
|
require 'time'
|
|
170
|
-
require '
|
|
170
|
+
require 'lob'
|
|
171
171
|
# setup authorization
|
|
172
172
|
Lob.configure do |config|
|
|
173
173
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -237,7 +237,7 @@ Update the details of an existing campaign. You need only supply the unique iden
|
|
|
237
237
|
|
|
238
238
|
```ruby
|
|
239
239
|
require 'time'
|
|
240
|
-
require '
|
|
240
|
+
require 'lob'
|
|
241
241
|
# setup authorization
|
|
242
242
|
Lob.configure do |config|
|
|
243
243
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -309,7 +309,7 @@ Returns a list of your campaigns. The campaigns are returned sorted by creation
|
|
|
309
309
|
|
|
310
310
|
```ruby
|
|
311
311
|
require 'time'
|
|
312
|
-
require '
|
|
312
|
+
require 'lob'
|
|
313
313
|
# setup authorization
|
|
314
314
|
Lob.configure do |config|
|
|
315
315
|
# Configure HTTP basic authorization: basicAuth
|
data/docs/CampaignsList.md
CHANGED
data/docs/Card.md
CHANGED
data/docs/CardDeletion.md
CHANGED
data/docs/CardEditable.md
CHANGED
data/docs/CardList.md
CHANGED
data/docs/CardOrder.md
CHANGED
data/docs/CardOrderEditable.md
CHANGED
data/docs/CardOrderList.md
CHANGED
data/docs/CardOrdersApi.md
CHANGED
|
@@ -20,7 +20,7 @@ Creates a new card order given information
|
|
|
20
20
|
|
|
21
21
|
```ruby
|
|
22
22
|
require 'time'
|
|
23
|
-
require '
|
|
23
|
+
require 'lob'
|
|
24
24
|
# setup authorization
|
|
25
25
|
Lob.configure do |config|
|
|
26
26
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -92,7 +92,7 @@ Retrieves the card orders associated with the given card id.
|
|
|
92
92
|
|
|
93
93
|
```ruby
|
|
94
94
|
require 'time'
|
|
95
|
-
require '
|
|
95
|
+
require 'lob'
|
|
96
96
|
# setup authorization
|
|
97
97
|
Lob.configure do |config|
|
|
98
98
|
# Configure HTTP basic authorization: basicAuth
|
data/docs/CardUpdatable.md
CHANGED
data/docs/CardsApi.md
CHANGED
|
@@ -23,7 +23,7 @@ Creates a new card given information
|
|
|
23
23
|
|
|
24
24
|
```ruby
|
|
25
25
|
require 'time'
|
|
26
|
-
require '
|
|
26
|
+
require 'lob'
|
|
27
27
|
# setup authorization
|
|
28
28
|
Lob.configure do |config|
|
|
29
29
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -93,7 +93,7 @@ Delete an existing card. You need only supply the unique identifier that was ret
|
|
|
93
93
|
|
|
94
94
|
```ruby
|
|
95
95
|
require 'time'
|
|
96
|
-
require '
|
|
96
|
+
require 'lob'
|
|
97
97
|
# setup authorization
|
|
98
98
|
Lob.configure do |config|
|
|
99
99
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -163,7 +163,7 @@ Retrieves the details of an existing card. You need only supply the unique custo
|
|
|
163
163
|
|
|
164
164
|
```ruby
|
|
165
165
|
require 'time'
|
|
166
|
-
require '
|
|
166
|
+
require 'lob'
|
|
167
167
|
# setup authorization
|
|
168
168
|
Lob.configure do |config|
|
|
169
169
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -233,7 +233,7 @@ Update the details of an existing card. You need only supply the unique identifi
|
|
|
233
233
|
|
|
234
234
|
```ruby
|
|
235
235
|
require 'time'
|
|
236
|
-
require '
|
|
236
|
+
require 'lob'
|
|
237
237
|
# setup authorization
|
|
238
238
|
Lob.configure do |config|
|
|
239
239
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -305,7 +305,7 @@ Returns a list of your cards. The cards are returned sorted by creation date, wi
|
|
|
305
305
|
|
|
306
306
|
```ruby
|
|
307
307
|
require 'time'
|
|
308
|
-
require '
|
|
308
|
+
require 'lob'
|
|
309
309
|
# setup authorization
|
|
310
310
|
Lob.configure do |config|
|
|
311
311
|
# Configure HTTP basic authorization: basicAuth
|
data/docs/Check.md
CHANGED
|
@@ -30,11 +30,12 @@
|
|
|
30
30
|
| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. | |
|
|
31
31
|
| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the resource was last modified. | |
|
|
32
32
|
| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
|
|
33
|
+
| **use_type** | [**ChkUseType**](ChkUseType.md) | | |
|
|
33
34
|
|
|
34
35
|
## Example
|
|
35
36
|
|
|
36
37
|
```ruby
|
|
37
|
-
require '
|
|
38
|
+
require 'lob'
|
|
38
39
|
|
|
39
40
|
instance = Lob::Check.new(
|
|
40
41
|
id: null,
|
|
@@ -62,7 +63,8 @@ instance = Lob::Check.new(
|
|
|
62
63
|
object: null,
|
|
63
64
|
date_created: null,
|
|
64
65
|
date_modified: null,
|
|
65
|
-
deleted: null
|
|
66
|
+
deleted: null,
|
|
67
|
+
use_type: null
|
|
66
68
|
)
|
|
67
69
|
```
|
|
68
70
|
|
data/docs/CheckDeletion.md
CHANGED
data/docs/CheckEditable.md
CHANGED
|
@@ -20,11 +20,12 @@
|
|
|
20
20
|
| **check_number** | **Integer** | An integer that designates the check number. | [optional] |
|
|
21
21
|
| **message** | **String** | Max of 400 characters to be included at the bottom of the check page. | [optional] |
|
|
22
22
|
| **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] |
|
|
23
|
+
| **use_type** | [**ChkUseType**](ChkUseType.md) | | |
|
|
23
24
|
|
|
24
25
|
## Example
|
|
25
26
|
|
|
26
27
|
```ruby
|
|
27
|
-
require '
|
|
28
|
+
require 'lob'
|
|
28
29
|
|
|
29
30
|
instance = Lob::CheckEditable.new(
|
|
30
31
|
from: null,
|
|
@@ -42,7 +43,8 @@ instance = Lob::CheckEditable.new(
|
|
|
42
43
|
memo: null,
|
|
43
44
|
check_number: null,
|
|
44
45
|
message: null,
|
|
45
|
-
billing_group_id: null
|
|
46
|
+
billing_group_id: null,
|
|
47
|
+
use_type: null
|
|
46
48
|
)
|
|
47
49
|
```
|
|
48
50
|
|
data/docs/CheckList.md
CHANGED
data/docs/ChecksApi.md
CHANGED
|
@@ -22,7 +22,7 @@ Completely removes a check from production. This can only be done if the check h
|
|
|
22
22
|
|
|
23
23
|
```ruby
|
|
24
24
|
require 'time'
|
|
25
|
-
require '
|
|
25
|
+
require 'lob'
|
|
26
26
|
# setup authorization
|
|
27
27
|
Lob.configure do |config|
|
|
28
28
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -92,7 +92,7 @@ Creates a new check with the provided properties.
|
|
|
92
92
|
|
|
93
93
|
```ruby
|
|
94
94
|
require 'time'
|
|
95
|
-
require '
|
|
95
|
+
require 'lob'
|
|
96
96
|
# setup authorization
|
|
97
97
|
Lob.configure do |config|
|
|
98
98
|
# Configure HTTP basic authorization: basicAuth
|
|
@@ -101,7 +101,7 @@ Lob.configure do |config|
|
|
|
101
101
|
end
|
|
102
102
|
|
|
103
103
|
api_instance = Lob::ChecksApi.new
|
|
104
|
-
check_editable = Lob::CheckEditable.new({from: TODO, to: TODO, bank_account: 'bank_account_example', amount: 3.56}) # CheckEditable |
|
|
104
|
+
check_editable = Lob::CheckEditable.new({from: TODO, to: TODO, bank_account: 'bank_account_example', amount: 3.56, use_type: Lob::ChkUseType::MARKETING}) # CheckEditable |
|
|
105
105
|
opts = {
|
|
106
106
|
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).
|
|
107
107
|
}
|
|
@@ -166,7 +166,7 @@ Retrieves the details of an existing check. You need only supply the unique chec
|
|
|
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 checks. The checks are returned sorted by creation date,
|
|
|
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
|
|
@@ -255,7 +255,7 @@ opts = {
|
|
|
255
255
|
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`
|
|
256
256
|
send_date: { key: 'inner_example'}, # Hash<String, String> | Filter by date sent.
|
|
257
257
|
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.
|
|
258
|
-
sort_by: Lob::
|
|
258
|
+
sort_by: Lob::SortBy4.new # SortBy4 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both.
|
|
259
259
|
}
|
|
260
260
|
|
|
261
261
|
begin
|
|
@@ -298,7 +298,7 @@ end
|
|
|
298
298
|
| **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] |
|
|
299
299
|
| **send_date** | [**Hash<String, String>**](String.md) | Filter by date sent. | [optional] |
|
|
300
300
|
| **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'] |
|
|
301
|
-
| **sort_by** | [**
|
|
301
|
+
| **sort_by** | [**SortBy4**](.md) | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. | [optional] |
|
|
302
302
|
|
|
303
303
|
### Return type
|
|
304
304
|
|