lob 5.4.6 → 6.0.0
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 +1871 -0
- data/Gemfile +6 -1
- data/Gemfile.lock +70 -0
- data/LICENSE +21 -0
- data/MIGRATION.md +174 -0
- data/README.md +70 -97
- data/Rakefile +7 -5
- data/__tests__/Api/Address.unit.rb +210 -0
- data/__tests__/Api/BankAccount.unit.rb +244 -0
- data/__tests__/Api/BillingGroup.unit.rb +170 -0
- data/__tests__/Api/Card.unit.rb +183 -0
- data/__tests__/Api/CardOrder.unit.rb +89 -0
- data/__tests__/Api/Check.unit.rb +185 -0
- data/__tests__/Api/IntlAutocompletion.unit.rb +43 -0
- data/__tests__/Api/IntlVerification.unit.rb +71 -0
- data/__tests__/Api/Letter.unit.rb +191 -0
- data/__tests__/Api/Postcard.unit.rb +189 -0
- data/__tests__/Api/ReverseGeocodeLookup.unit.rb +43 -0
- data/__tests__/Api/SelfMailer.unit.rb +190 -0
- data/__tests__/Api/Template.unit.rb +165 -0
- data/__tests__/Api/TemplateVersion.unit.rb +165 -0
- data/__tests__/Api/UsAutocompletion.unit.rb +42 -0
- data/__tests__/Api/UsVerification.unit.rb +71 -0
- data/__tests__/Api/ZipLookup.unit.rb +42 -0
- data/__tests__/Integration/Address.spec.rb +200 -0
- data/__tests__/Integration/BankAccount.spec.rb +243 -0
- data/__tests__/Integration/BillingGroup.spec.rb +163 -0
- data/__tests__/Integration/Card.spec.rb +198 -0
- data/__tests__/Integration/CardOrder.spec.rb +122 -0
- data/__tests__/Integration/Check.spec.rb +361 -0
- data/__tests__/Integration/IntlAutocompletion.spec.rb +54 -0
- data/__tests__/Integration/IntlVerification.spec.rb +90 -0
- data/__tests__/Integration/Letter.spec.rb +286 -0
- data/__tests__/Integration/Postcard.spec.rb +214 -0
- data/__tests__/Integration/ReverseGeocodeLookup.spec.rb +30 -0
- data/__tests__/Integration/SelfMailer.spec.rb +270 -0
- data/__tests__/Integration/Template.spec.rb +221 -0
- data/__tests__/Integration/TemplateVersion.spec.rb +275 -0
- data/__tests__/Integration/UsAutocompletion.spec.rb +54 -0
- data/__tests__/Integration/UsVerification.spec.rb +102 -0
- data/__tests__/Integration/ZipLookup.spec.rb +29 -0
- data/__tests__/TestFixtures.rb +36 -0
- data/docs/Address.md +52 -0
- data/docs/AddressDeletion.md +22 -0
- data/docs/AddressDomestic.md +40 -0
- data/docs/AddressDomesticExpanded.md +40 -0
- data/docs/AddressEditable.md +40 -0
- data/docs/AddressList.md +28 -0
- data/docs/AddressesApi.md +303 -0
- data/docs/BankAccount.md +44 -0
- data/docs/BankAccountDeletion.md +22 -0
- data/docs/BankAccountList.md +28 -0
- data/docs/BankAccountVerify.md +18 -0
- data/docs/BankAccountWritable.md +28 -0
- data/docs/BankAccountsApi.md +376 -0
- data/docs/BankTypeEnum.md +15 -0
- data/docs/BillingGroup.md +28 -0
- data/docs/BillingGroupEditable.md +20 -0
- data/docs/BillingGroupList.md +26 -0
- data/docs/BillingGroupsApi.md +305 -0
- data/docs/Buckslip.md +60 -0
- data/docs/BuckslipDeletion.md +20 -0
- data/docs/BuckslipEditable.md +24 -0
- data/docs/BuckslipOrder.md +42 -0
- data/docs/BuckslipOrderEditable.md +18 -0
- data/docs/BuckslipOrdersApi.md +157 -0
- data/docs/BuckslipOrdersList.md +26 -0
- data/docs/BuckslipUpdatable.md +22 -0
- data/docs/BuckslipsApi.md +372 -0
- data/docs/BuckslipsList.md +28 -0
- data/docs/BulkError.md +18 -0
- data/docs/BulkErrorProperties.md +20 -0
- data/docs/Campaign.md +52 -0
- data/docs/CampaignCreative.md +42 -0
- data/docs/CampaignDeletion.md +20 -0
- data/docs/CampaignUpdatable.md +36 -0
- data/docs/CampaignWritable.md +36 -0
- data/docs/CampaignsApi.md +376 -0
- data/docs/CampaignsList.md +28 -0
- data/docs/Card.md +54 -0
- data/docs/CardDeletion.md +22 -0
- data/docs/CardEditable.md +24 -0
- data/docs/CardList.md +28 -0
- data/docs/CardOrder.md +42 -0
- data/docs/CardOrderEditable.md +18 -0
- data/docs/CardOrderList.md +26 -0
- data/docs/CardOrdersApi.md +157 -0
- data/docs/CardUpdatable.md +22 -0
- data/docs/CardsApi.md +372 -0
- data/docs/Check.md +68 -0
- data/docs/CheckDeletion.md +22 -0
- data/docs/CheckEditable.md +48 -0
- data/docs/CheckList.md +28 -0
- data/docs/ChecksApi.md +315 -0
- data/docs/CmpScheduleType.md +15 -0
- data/docs/CmpUseType.md +15 -0
- data/docs/CountryExtended.md +15 -0
- data/docs/CountryExtendedExpanded.md +15 -0
- data/docs/CreativePatch.md +22 -0
- data/docs/CreativeResponse.md +42 -0
- data/docs/CreativeWritable.md +34 -0
- data/docs/CreativesApi.md +226 -0
- data/docs/CustomEnvelopeReturned.md +22 -0
- data/docs/DefaultApi.md +75 -0
- data/docs/DeliverabilityAnalysis.md +34 -0
- data/docs/DpvFootnote.md +15 -0
- data/docs/EngineHtml.md +15 -0
- data/docs/EventType.md +24 -0
- data/docs/Events.md +28 -0
- data/docs/Export.md +32 -0
- data/docs/ExportModel.md +18 -0
- data/docs/GeocodeAddresses.md +20 -0
- data/docs/GeocodeComponents.md +20 -0
- data/docs/HTTPValidationError.md +18 -0
- data/docs/IdentityValidation.md +34 -0
- data/docs/IdentityValidationApi.md +78 -0
- data/docs/InlineObject.md +18 -0
- data/docs/IntlAutocompletions.md +20 -0
- data/docs/IntlAutocompletionsApi.md +82 -0
- data/docs/IntlAutocompletionsWritable.md +26 -0
- data/docs/IntlComponents.md +26 -0
- data/docs/IntlSuggestions.md +30 -0
- data/docs/IntlVerification.md +38 -0
- data/docs/IntlVerificationOrError.md +40 -0
- data/docs/IntlVerificationWritable.md +32 -0
- data/docs/IntlVerifications.md +20 -0
- data/docs/IntlVerificationsApi.md +153 -0
- data/docs/IntlVerificationsPayload.md +18 -0
- data/docs/Letter.md +72 -0
- data/docs/LetterCustomEnvelope.md +22 -0
- data/docs/LetterDeletion.md +22 -0
- data/docs/LetterDetailsReturned.md +36 -0
- data/docs/LetterDetailsWritable.md +32 -0
- data/docs/LetterEditable.md +52 -0
- data/docs/LetterList.md +28 -0
- data/docs/LettersApi.md +317 -0
- data/docs/LobConfidenceScore.md +20 -0
- data/docs/LobError.md +22 -0
- data/docs/Location.md +20 -0
- data/docs/LocationAnalysis.md +22 -0
- data/docs/MailType.md +15 -0
- data/docs/MultiLineAddress.md +32 -0
- data/docs/MultipleComponents.md +30 -0
- data/docs/MultipleComponentsIntl.md +30 -0
- data/docs/MultipleComponentsList.md +18 -0
- data/docs/PlaceholderModel.md +28 -0
- data/docs/Postcard.md +60 -0
- data/docs/PostcardDeletion.md +22 -0
- data/docs/PostcardDetailsReturned.md +26 -0
- data/docs/PostcardDetailsWritable.md +20 -0
- data/docs/PostcardEditable.md +40 -0
- data/docs/PostcardList.md +28 -0
- data/docs/PostcardSize.md +15 -0
- data/docs/PostcardsApi.md +317 -0
- data/docs/QrCode.md +30 -0
- data/docs/ReturnEnvelope.md +24 -0
- data/docs/ReverseGeocode.md +22 -0
- data/docs/ReverseGeocodeLookupsApi.md +82 -0
- data/docs/SelfMailer.md +48 -0
- data/docs/SelfMailerDeletion.md +22 -0
- data/docs/SelfMailerEditable.md +38 -0
- data/docs/SelfMailerList.md +28 -0
- data/docs/SelfMailerSize.md +15 -0
- data/docs/SelfMailersApi.md +317 -0
- data/docs/SortBy.md +20 -0
- data/docs/SortBy1.md +20 -0
- data/docs/SortBy2.md +20 -0
- data/docs/SortBy3.md +20 -0
- data/docs/SortByDateModified.md +20 -0
- data/docs/Suggestions.md +26 -0
- data/docs/Template.md +34 -0
- data/docs/TemplateDeletion.md +22 -0
- data/docs/TemplateList.md +28 -0
- data/docs/TemplateUpdate.md +20 -0
- data/docs/TemplateVersion.md +36 -0
- data/docs/TemplateVersionDeletion.md +22 -0
- data/docs/TemplateVersionList.md +28 -0
- data/docs/TemplateVersionUpdatable.md +20 -0
- data/docs/TemplateVersionWritable.md +22 -0
- data/docs/TemplateVersionsApi.md +384 -0
- data/docs/TemplateWritable.md +24 -0
- data/docs/TemplatesApi.md +376 -0
- data/docs/Thumbnail.md +22 -0
- data/docs/TrackingEventCertified.md +34 -0
- data/docs/TrackingEventDetails.md +24 -0
- data/docs/TrackingEventNormal.md +34 -0
- data/docs/Upload.md +44 -0
- data/docs/UploadCreateExport.md +20 -0
- data/docs/UploadFile.md +20 -0
- data/docs/UploadState.md +15 -0
- data/docs/UploadUpdatable.md +20 -0
- data/docs/UploadWritable.md +18 -0
- data/docs/UploadsApi.md +584 -0
- data/docs/UsAutocompletions.md +22 -0
- data/docs/UsAutocompletionsApi.md +78 -0
- data/docs/UsAutocompletionsWritable.md +26 -0
- data/docs/UsComponents.md +68 -0
- data/docs/UsVerification.md +38 -0
- data/docs/UsVerificationOrError.md +40 -0
- data/docs/UsVerifications.md +20 -0
- data/docs/UsVerificationsApi.md +157 -0
- data/docs/UsVerificationsWritable.md +32 -0
- data/docs/ValidationError.md +22 -0
- data/docs/Zip.md +26 -0
- data/docs/ZipCodeType.md +15 -0
- data/docs/ZipEditable.md +18 -0
- data/docs/ZipLookupCity.md +26 -0
- data/docs/ZipLookupsApi.md +78 -0
- data/git_push.sh +57 -0
- data/lib/openapi_client/api/addresses_api.rb +318 -0
- data/lib/openapi_client/api/bank_accounts_api.rb +397 -0
- data/lib/openapi_client/api/billing_groups_api.rb +320 -0
- data/lib/openapi_client/api/buckslip_orders_api.rb +183 -0
- data/lib/openapi_client/api/buckslips_api.rb +382 -0
- data/lib/openapi_client/api/campaigns_api.rb +389 -0
- data/lib/openapi_client/api/card_orders_api.rb +183 -0
- data/lib/openapi_client/api/cards_api.rb +382 -0
- data/lib/openapi_client/api/checks_api.rb +337 -0
- data/lib/openapi_client/api/creatives_api.rb +244 -0
- data/lib/openapi_client/api/default_api.rb +79 -0
- data/lib/openapi_client/api/identity_validation_api.rb +90 -0
- data/lib/openapi_client/api/intl_autocompletions_api.rb +97 -0
- data/lib/openapi_client/api/intl_verifications_api.rb +165 -0
- data/lib/openapi_client/api/letters_api.rb +340 -0
- data/lib/openapi_client/api/postcards_api.rb +340 -0
- data/lib/openapi_client/api/reverse_geocode_lookups_api.rb +101 -0
- data/lib/openapi_client/api/self_mailers_api.rb +340 -0
- data/lib/openapi_client/api/template_versions_api.rb +440 -0
- data/lib/openapi_client/api/templates_api.rb +397 -0
- data/lib/openapi_client/api/uploads_api.rb +604 -0
- data/lib/openapi_client/api/us_autocompletions_api.rb +90 -0
- data/lib/openapi_client/api/us_verifications_api.rb +172 -0
- data/lib/openapi_client/api/zip_lookups_api.rb +90 -0
- data/lib/openapi_client/api_client.rb +392 -0
- data/lib/openapi_client/api_error.rb +57 -0
- data/lib/openapi_client/configuration.rb +279 -0
- data/lib/openapi_client/models/address.rb +616 -0
- data/lib/openapi_client/models/address_deletion.rb +303 -0
- data/lib/openapi_client/models/address_domestic.rb +522 -0
- data/lib/openapi_client/models/address_domestic_expanded.rb +521 -0
- data/lib/openapi_client/models/address_editable.rb +503 -0
- data/lib/openapi_client/models/address_list.rb +324 -0
- data/lib/openapi_client/models/bank_account.rb +576 -0
- data/lib/openapi_client/models/bank_account_deletion.rb +303 -0
- data/lib/openapi_client/models/bank_account_list.rb +324 -0
- data/lib/openapi_client/models/bank_account_verify.rb +264 -0
- data/lib/openapi_client/models/bank_account_writable.rb +387 -0
- data/lib/openapi_client/models/bank_type_enum.rb +37 -0
- data/lib/openapi_client/models/billing_group.rb +395 -0
- data/lib/openapi_client/models/billing_group_editable.rb +278 -0
- data/lib/openapi_client/models/billing_group_list.rb +314 -0
- data/lib/openapi_client/models/buckslip.rb +814 -0
- data/lib/openapi_client/models/buckslip_deletion.rb +257 -0
- data/lib/openapi_client/models/buckslip_editable.rb +316 -0
- data/lib/openapi_client/models/buckslip_order.rb +438 -0
- data/lib/openapi_client/models/buckslip_order_editable.rb +262 -0
- data/lib/openapi_client/models/buckslip_orders_list.rb +312 -0
- data/lib/openapi_client/models/buckslip_updatable.rb +289 -0
- data/lib/openapi_client/models/buckslips_list.rb +324 -0
- data/lib/openapi_client/models/bulk_error.rb +229 -0
- data/lib/openapi_client/models/bulk_error_properties.rb +274 -0
- data/lib/openapi_client/models/campaign.rb +549 -0
- data/lib/openapi_client/models/campaign_creative.rb +467 -0
- data/lib/openapi_client/models/campaign_deletion.rb +257 -0
- data/lib/openapi_client/models/campaign_updatable.rb +341 -0
- data/lib/openapi_client/models/campaign_writable.rb +373 -0
- data/lib/openapi_client/models/campaigns_list.rb +324 -0
- data/lib/openapi_client/models/card.rb +681 -0
- data/lib/openapi_client/models/card_deletion.rb +303 -0
- data/lib/openapi_client/models/card_editable.rb +318 -0
- data/lib/openapi_client/models/card_list.rb +324 -0
- data/lib/openapi_client/models/card_order.rb +438 -0
- data/lib/openapi_client/models/card_order_editable.rb +261 -0
- data/lib/openapi_client/models/card_order_list.rb +273 -0
- data/lib/openapi_client/models/card_updatable.rb +289 -0
- data/lib/openapi_client/models/check.rb +812 -0
- data/lib/openapi_client/models/check_deletion.rb +303 -0
- data/lib/openapi_client/models/check_editable.rb +537 -0
- data/lib/openapi_client/models/check_list.rb +324 -0
- data/lib/openapi_client/models/chk_use_type.rb +38 -0
- data/lib/openapi_client/models/cmp_schedule_type.rb +36 -0
- data/lib/openapi_client/models/cmp_use_type.rb +38 -0
- data/lib/openapi_client/models/country_extended.rb +254 -0
- data/lib/openapi_client/models/country_extended_expanded.rb +255 -0
- data/lib/openapi_client/models/creative_patch.rb +274 -0
- data/lib/openapi_client/models/creative_response.rb +444 -0
- data/lib/openapi_client/models/creative_writable.rb +400 -0
- data/lib/openapi_client/models/custom_envelope_returned.rb +319 -0
- data/lib/openapi_client/models/deliverability_analysis.rb +451 -0
- data/lib/openapi_client/models/dpv_footnote.rb +50 -0
- data/lib/openapi_client/models/engine_html.rb +37 -0
- data/lib/openapi_client/models/event_type.rb +325 -0
- data/lib/openapi_client/models/events.rb +365 -0
- data/lib/openapi_client/models/export.rb +422 -0
- data/lib/openapi_client/models/export_model.rb +262 -0
- data/lib/openapi_client/models/geocode_addresses.rb +237 -0
- data/lib/openapi_client/models/geocode_components.rb +291 -0
- data/lib/openapi_client/models/http_validation_error.rb +230 -0
- data/lib/openapi_client/models/identity_validation.rb +460 -0
- data/lib/openapi_client/models/inline_object.rb +229 -0
- data/lib/openapi_client/models/intl_autocompletions.rb +282 -0
- data/lib/openapi_client/models/intl_autocompletions_writable.rb +278 -0
- data/lib/openapi_client/models/intl_components.rb +314 -0
- data/lib/openapi_client/models/intl_suggestions.rb +372 -0
- data/lib/openapi_client/models/intl_verification.rb +463 -0
- data/lib/openapi_client/models/intl_verification_or_error.rb +466 -0
- data/lib/openapi_client/models/intl_verification_writable.rb +388 -0
- data/lib/openapi_client/models/intl_verifications.rb +250 -0
- data/lib/openapi_client/models/intl_verifications_payload.rb +263 -0
- data/lib/openapi_client/models/letter.rb +737 -0
- data/lib/openapi_client/models/letter_custom_envelope.rb +300 -0
- data/lib/openapi_client/models/letter_deletion.rb +303 -0
- data/lib/openapi_client/models/letter_details_returned.rb +393 -0
- data/lib/openapi_client/models/letter_details_writable.rb +390 -0
- data/lib/openapi_client/models/letter_editable.rb +532 -0
- data/lib/openapi_client/models/letter_list.rb +324 -0
- data/lib/openapi_client/models/lob_confidence_score.rb +299 -0
- data/lib/openapi_client/models/lob_error.rb +296 -0
- data/lib/openapi_client/models/location.rb +289 -0
- data/lib/openapi_client/models/location_analysis.rb +305 -0
- data/lib/openapi_client/models/ltr_use_type.rb +38 -0
- data/lib/openapi_client/models/mail_type.rb +37 -0
- data/lib/openapi_client/models/multi_line_address.rb +431 -0
- data/lib/openapi_client/models/multiple_components.rb +405 -0
- data/lib/openapi_client/models/multiple_components_intl.rb +377 -0
- data/lib/openapi_client/models/multiple_components_list.rb +263 -0
- data/lib/openapi_client/models/optional_address_column_mapping.rb +259 -0
- data/lib/openapi_client/models/placeholder_model.rb +273 -0
- data/lib/openapi_client/models/postcard.rb +656 -0
- data/lib/openapi_client/models/postcard_deletion.rb +303 -0
- data/lib/openapi_client/models/postcard_details_returned.rb +321 -0
- data/lib/openapi_client/models/postcard_details_writable.rb +242 -0
- data/lib/openapi_client/models/postcard_editable.rb +393 -0
- data/lib/openapi_client/models/postcard_list.rb +324 -0
- data/lib/openapi_client/models/postcard_size.rb +38 -0
- data/lib/openapi_client/models/psc_use_type.rb +38 -0
- data/lib/openapi_client/models/qr_code.rb +339 -0
- data/lib/openapi_client/models/required_address_column_mapping.rb +285 -0
- data/lib/openapi_client/models/return_envelope.rb +258 -0
- data/lib/openapi_client/models/reverse_geocode.rb +304 -0
- data/lib/openapi_client/models/self_mailer.rb +584 -0
- data/lib/openapi_client/models/self_mailer_deletion.rb +303 -0
- data/lib/openapi_client/models/self_mailer_editable.rb +384 -0
- data/lib/openapi_client/models/self_mailer_list.rb +324 -0
- data/lib/openapi_client/models/self_mailer_size.rb +38 -0
- data/lib/openapi_client/models/sfm_use_type.rb +38 -0
- data/lib/openapi_client/models/sort_by.rb +283 -0
- data/lib/openapi_client/models/sort_by1.rb +283 -0
- data/lib/openapi_client/models/sort_by2.rb +283 -0
- data/lib/openapi_client/models/sort_by3.rb +283 -0
- data/lib/openapi_client/models/sort_by_date_modified.rb +283 -0
- data/lib/openapi_client/models/suggestions.rb +343 -0
- data/lib/openapi_client/models/template.rb +406 -0
- data/lib/openapi_client/models/template_deletion.rb +303 -0
- data/lib/openapi_client/models/template_list.rb +324 -0
- data/lib/openapi_client/models/template_update.rb +272 -0
- data/lib/openapi_client/models/template_version.rb +423 -0
- data/lib/openapi_client/models/template_version_deletion.rb +303 -0
- data/lib/openapi_client/models/template_version_list.rb +324 -0
- data/lib/openapi_client/models/template_version_updatable.rb +257 -0
- data/lib/openapi_client/models/template_version_writable.rb +291 -0
- data/lib/openapi_client/models/template_writable.rb +309 -0
- data/lib/openapi_client/models/thumbnail.rb +300 -0
- data/lib/openapi_client/models/tracking_event_certified.rb +419 -0
- data/lib/openapi_client/models/tracking_event_details.rb +308 -0
- data/lib/openapi_client/models/tracking_event_normal.rb +409 -0
- data/lib/openapi_client/models/upload.rb +498 -0
- data/lib/openapi_client/models/upload_create_export.rb +283 -0
- data/lib/openapi_client/models/upload_file.rb +283 -0
- data/lib/openapi_client/models/upload_state.rb +42 -0
- data/lib/openapi_client/models/upload_updatable.rb +267 -0
- data/lib/openapi_client/models/upload_writable.rb +271 -0
- data/lib/openapi_client/models/uploads_metadata.rb +237 -0
- data/lib/openapi_client/models/us_autocompletions.rb +328 -0
- data/lib/openapi_client/models/us_autocompletions_writable.rb +274 -0
- data/lib/openapi_client/models/us_components.rb +761 -0
- data/lib/openapi_client/models/us_verification.rb +461 -0
- data/lib/openapi_client/models/us_verification_or_error.rb +459 -0
- data/lib/openapi_client/models/us_verifications.rb +250 -0
- data/lib/openapi_client/models/us_verifications_writable.rb +421 -0
- data/lib/openapi_client/models/validation_error.rb +263 -0
- data/lib/openapi_client/models/zip.rb +363 -0
- data/lib/openapi_client/models/zip_code_type.rb +40 -0
- data/lib/openapi_client/models/zip_editable.rb +246 -0
- data/lib/openapi_client/models/zip_lookup_city.rb +331 -0
- data/lib/openapi_client/version.rb +15 -0
- data/lib/openapi_client.rb +212 -0
- data/openapi_client.gemspec +37 -0
- data/spec/api/addresses_api_spec.rb +88 -0
- data/spec/api/bank_accounts_api_spec.rb +101 -0
- data/spec/api/billing_groups_api_spec.rb +89 -0
- data/spec/api/campaigns_api_spec.rb +100 -0
- data/spec/api/card_orders_api_spec.rb +62 -0
- data/spec/api/cards_api_spec.rb +99 -0
- data/spec/api/checks_api_spec.rb +93 -0
- data/spec/api/creatives_api_spec.rb +73 -0
- data/spec/api/default_api_spec.rb +46 -0
- data/spec/api/identity_validation_api_spec.rb +47 -0
- data/spec/api/intl_autocompletions_api_spec.rb +48 -0
- data/spec/api/intl_verifications_api_spec.rb +60 -0
- data/spec/api/letters_api_spec.rb +94 -0
- data/spec/api/postcards_api_spec.rb +94 -0
- data/spec/api/reverse_geocode_lookups_api_spec.rb +48 -0
- data/spec/api/self_mailers_api_spec.rb +94 -0
- data/spec/api/template_versions_api_spec.rb +105 -0
- data/spec/api/templates_api_spec.rb +101 -0
- data/spec/api/uploads_api_spec.rb +135 -0
- data/spec/api/us_autocompletions_api_spec.rb +47 -0
- data/spec/api/us_verifications_api_spec.rb +61 -0
- data/spec/api/zip_lookups_api_spec.rb +47 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/spec_helper.rb +105 -13
- metadata +449 -215
- data/.github/workflows/forked_tests_job.yml +0 -36
- data/.github/workflows/run_tests_job.yml +0 -32
- data/.github/workflows/update_gem.yml +0 -27
- data/.gitignore +0 -19
- data/CHANGELOG.md +0 -148
- data/CONTRIBUTING.md +0 -19
- data/LICENSE.txt +0 -22
- data/examples/README.md +0 -119
- data/examples/cards.rb +0 -51
- data/examples/checks.rb +0 -49
- data/examples/csv_checks/create_checks.rb +0 -48
- data/examples/csv_checks/input.csv +0 -6
- data/examples/csv_letters/create_letters.rb +0 -41
- data/examples/csv_letters/input.csv +0 -6
- data/examples/csv_letters/letter_template.html +0 -33
- data/examples/csv_postcards/create_postcards.rb +0 -46
- data/examples/csv_postcards/input.csv +0 -7
- data/examples/csv_postcards/postcard_back.html +0 -38
- data/examples/csv_postcards/postcard_front.html +0 -25
- data/examples/csv_verify/input.csv +0 -7
- data/examples/csv_verify/verify.rb +0 -37
- data/examples/letters.rb +0 -73
- data/examples/list_postcards_metadata.rb +0 -94
- data/examples/postcards.rb +0 -87
- data/examples/postcards_idempotent.rb +0 -92
- data/examples/postcards_intl.rb +0 -87
- data/examples/postcards_remote.rb +0 -87
- data/examples/postcards_send_date.rb +0 -97
- data/examples/postcards_template.rb +0 -98
- data/examples/self_mailers.rb +0 -38
- data/lib/lob/client.rb +0 -96
- data/lib/lob/errors/invalid_request_error.rb +0 -4
- data/lib/lob/errors/lob_error.rb +0 -20
- data/lib/lob/resources/address.rb +0 -14
- data/lib/lob/resources/bank_account.rb +0 -30
- data/lib/lob/resources/bulk_intl_verifications.rb +0 -27
- data/lib/lob/resources/bulk_us_verifications.rb +0 -28
- data/lib/lob/resources/card.rb +0 -46
- data/lib/lob/resources/check.rb +0 -14
- data/lib/lob/resources/group.rb +0 -14
- data/lib/lob/resources/groups_member.rb +0 -66
- data/lib/lob/resources/intl_verifications.rb +0 -26
- data/lib/lob/resources/letter.rb +0 -14
- data/lib/lob/resources/postcard.rb +0 -14
- data/lib/lob/resources/resource_base.rb +0 -150
- data/lib/lob/resources/self_mailer.rb +0 -14
- data/lib/lob/resources/us_autocompletions.rb +0 -26
- data/lib/lob/resources/us_reverse_geocode_lookups.rb +0 -26
- data/lib/lob/resources/us_verifications.rb +0 -27
- data/lib/lob/resources/us_zip_lookups.rb +0 -26
- data/lib/lob/version.rb +0 -3
- data/lib/lob.rb +0 -7
- data/lob.gemspec +0 -31
- data/spec/lob/errors/lob_error_spec.rb +0 -19
- data/spec/lob/resources/address_spec.rb +0 -55
- data/spec/lob/resources/bank_account_spec.rb +0 -60
- data/spec/lob/resources/bulk_intl_verifications_spec.rb +0 -39
- data/spec/lob/resources/bulk_us_verifications_spec.rb +0 -51
- data/spec/lob/resources/card_spec.rb +0 -145
- data/spec/lob/resources/check_spec.rb +0 -119
- data/spec/lob/resources/group_spec.rb +0 -50
- data/spec/lob/resources/intl_verifications_spec.rb +0 -25
- data/spec/lob/resources/letter_spec.rb +0 -114
- data/spec/lob/resources/member_spec.rb +0 -65
- data/spec/lob/resources/postcard_spec.rb +0 -160
- data/spec/lob/resources/resource_base_spec.rb +0 -75
- data/spec/lob/resources/self_mailer_spec.rb +0 -177
- data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
- data/spec/lob/resources/us_reverse_geocode_lookups_spec.rb +0 -22
- data/spec/lob/resources/us_verifications_spec.rb +0 -31
- data/spec/lob/resources/us_zip_lookups_spec.rb +0 -23
- data/spec/lob_spec.rb +0 -48
- data/spec/samples/8.5x11.pdf +0 -0
- data/spec/samples/card.pdf +1 -743
- data/spec/samples/postcardback.pdf +2 -2287
- data/spec/samples/postcardfront.pdf +1 -1549
- data/spec/samples/sfm-12x9-inside.pdf +0 -0
- data/spec/samples/sfm-12x9-outside.pdf +0 -0
- data/spec/samples/sfm-6x18-inside.pdf +0 -0
- data/spec/samples/sfm-6x18-outside.pdf +0 -0
@@ -0,0 +1,20 @@
|
|
1
|
+
# Lob::SortByDateModified
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **date_created** | **String** | | [optional] |
|
8
|
+
| **date_modified** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'openapi_client'
|
14
|
+
|
15
|
+
instance = Lob::SortByDateModified.new(
|
16
|
+
date_created: null,
|
17
|
+
date_modified: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/Suggestions.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# Lob::Suggestions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **primary_line** | **String** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` | |
|
8
|
+
| **city** | **String** | | |
|
9
|
+
| **state** | **String** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. | |
|
10
|
+
| **zip_code** | **String** | A 5-digit zip code. Left empty if a test key is used. | |
|
11
|
+
| **object** | **String** | Value is resource type. | [optional][default to 'us_autocompletion'] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'openapi_client'
|
17
|
+
|
18
|
+
instance = Lob::Suggestions.new(
|
19
|
+
primary_line: null,
|
20
|
+
city: null,
|
21
|
+
state: null,
|
22
|
+
zip_code: null,
|
23
|
+
object: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/Template.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# Lob::Template
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
8
|
+
| **id** | **String** | Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). | |
|
9
|
+
| **versions** | [**Array<TemplateVersion>**](TemplateVersion.md) | An array of all non-deleted [version objects](#tag/Template-Versions) associated with the template. | |
|
10
|
+
| **published_version** | [**TemplateVersion**](TemplateVersion.md) | | |
|
11
|
+
| **object** | **String** | Value is resource type. | [optional][default to 'template'] |
|
12
|
+
| **metadata** | **Hash<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] |
|
13
|
+
| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] |
|
14
|
+
| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] |
|
15
|
+
| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'openapi_client'
|
21
|
+
|
22
|
+
instance = Lob::Template.new(
|
23
|
+
description: null,
|
24
|
+
id: null,
|
25
|
+
versions: null,
|
26
|
+
published_version: null,
|
27
|
+
object: null,
|
28
|
+
metadata: null,
|
29
|
+
date_created: null,
|
30
|
+
date_modified: null,
|
31
|
+
deleted: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Lob::TemplateDeletion
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). | [optional] |
|
8
|
+
| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
|
9
|
+
| **object** | **String** | Value is type of resource. | [optional][default to 'template_deleted'] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'openapi_client'
|
15
|
+
|
16
|
+
instance = Lob::TemplateDeletion.new(
|
17
|
+
id: null,
|
18
|
+
deleted: null,
|
19
|
+
object: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# Lob::TemplateList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<Template>**](Template.md) | list of templates | [optional] |
|
8
|
+
| **object** | **String** | Value is type of resource. | [optional] |
|
9
|
+
| **next_url** | **String** | url of next page of items in list. | [optional] |
|
10
|
+
| **previous_url** | **String** | url of previous page of items in list. | [optional] |
|
11
|
+
| **count** | **Integer** | number of resources in a set | [optional] |
|
12
|
+
| **total_count** | **Integer** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'openapi_client'
|
18
|
+
|
19
|
+
instance = Lob::TemplateList.new(
|
20
|
+
data: null,
|
21
|
+
object: null,
|
22
|
+
next_url: null,
|
23
|
+
previous_url: null,
|
24
|
+
count: null,
|
25
|
+
total_count: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Lob::TemplateUpdate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
8
|
+
| **published_version** | **String** | Unique identifier prefixed with `vrsn_`. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'openapi_client'
|
14
|
+
|
15
|
+
instance = Lob::TemplateUpdate.new(
|
16
|
+
description: null,
|
17
|
+
published_version: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# Lob::TemplateVersion
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Unique identifier prefixed with `vrsn_`. | |
|
8
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
9
|
+
| **html** | **String** | An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. | |
|
10
|
+
| **engine** | [**EngineHtml**](EngineHtml.md) | | [optional][default to 'legacy'] |
|
11
|
+
| **suggest_json_editor** | **Boolean** | Used by frontend, true if the template uses advanced features. | [optional] |
|
12
|
+
| **merge_variables** | **Object** | Used by frontend, an object representing the keys of every merge variable present in the template. It has one key named 'keys', and its value is an array of strings. | [optional] |
|
13
|
+
| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] |
|
14
|
+
| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] |
|
15
|
+
| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
|
16
|
+
| **object** | **String** | Value is resource type. | [optional][default to 'version'] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'openapi_client'
|
22
|
+
|
23
|
+
instance = Lob::TemplateVersion.new(
|
24
|
+
id: null,
|
25
|
+
description: null,
|
26
|
+
html: null,
|
27
|
+
engine: null,
|
28
|
+
suggest_json_editor: null,
|
29
|
+
merge_variables: null,
|
30
|
+
date_created: null,
|
31
|
+
date_modified: null,
|
32
|
+
deleted: null,
|
33
|
+
object: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Lob::TemplateVersionDeletion
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Unique identifier prefixed with `vrsn_`. | [optional] |
|
8
|
+
| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
|
9
|
+
| **object** | **String** | Value is type of resource. | [optional][default to 'template_version_deleted'] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'openapi_client'
|
15
|
+
|
16
|
+
instance = Lob::TemplateVersionDeletion.new(
|
17
|
+
id: null,
|
18
|
+
deleted: null,
|
19
|
+
object: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# Lob::TemplateVersionList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<TemplateVersion>**](TemplateVersion.md) | list of template versions | [optional] |
|
8
|
+
| **object** | **String** | Value is type of resource. | [optional] |
|
9
|
+
| **next_url** | **String** | url of next page of items in list. | [optional] |
|
10
|
+
| **previous_url** | **String** | url of previous page of items in list. | [optional] |
|
11
|
+
| **count** | **Integer** | number of resources in a set | [optional] |
|
12
|
+
| **total_count** | **Integer** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'openapi_client'
|
18
|
+
|
19
|
+
instance = Lob::TemplateVersionList.new(
|
20
|
+
data: null,
|
21
|
+
object: null,
|
22
|
+
next_url: null,
|
23
|
+
previous_url: null,
|
24
|
+
count: null,
|
25
|
+
total_count: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Lob::TemplateVersionUpdatable
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
8
|
+
| **engine** | [**EngineHtml**](EngineHtml.md) | | [optional][default to 'legacy'] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'openapi_client'
|
14
|
+
|
15
|
+
instance = Lob::TemplateVersionUpdatable.new(
|
16
|
+
description: null,
|
17
|
+
engine: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Lob::TemplateVersionWritable
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
8
|
+
| **html** | **String** | An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. | |
|
9
|
+
| **engine** | [**EngineHtml**](EngineHtml.md) | | [optional][default to 'legacy'] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'openapi_client'
|
15
|
+
|
16
|
+
instance = Lob::TemplateVersionWritable.new(
|
17
|
+
description: null,
|
18
|
+
html: null,
|
19
|
+
engine: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,384 @@
|
|
1
|
+
# Lob::TemplateVersionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.lob.com/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_template_version**](TemplateVersionsApi.md#create_template_version) | **POST** /templates/{tmpl_id}/versions | create |
|
8
|
+
| [**template_version_delete**](TemplateVersionsApi.md#template_version_delete) | **DELETE** /templates/{tmpl_id}/versions/{vrsn_id} | delete |
|
9
|
+
| [**template_version_retrieve**](TemplateVersionsApi.md#template_version_retrieve) | **GET** /templates/{tmpl_id}/versions/{vrsn_id} | get |
|
10
|
+
| [**template_version_update**](TemplateVersionsApi.md#template_version_update) | **POST** /templates/{tmpl_id}/versions/{vrsn_id} | update |
|
11
|
+
| [**template_versions_list**](TemplateVersionsApi.md#template_versions_list) | **GET** /templates/{tmpl_id}/versions | list |
|
12
|
+
|
13
|
+
|
14
|
+
## create_template_version
|
15
|
+
|
16
|
+
> <TemplateVersion> create_template_version(tmpl_id, template_version_writable)
|
17
|
+
|
18
|
+
create
|
19
|
+
|
20
|
+
Creates a new template version attached to the specified template.
|
21
|
+
|
22
|
+
### Examples
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'time'
|
26
|
+
require 'openapi_client'
|
27
|
+
# setup authorization
|
28
|
+
Lob.configure do |config|
|
29
|
+
# Configure HTTP basic authorization: basicAuth
|
30
|
+
config.username = 'YOUR USERNAME'
|
31
|
+
config.password = 'YOUR PASSWORD'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = Lob::TemplateVersionsApi.new
|
35
|
+
tmpl_id = 'tmpl_id_example' # String | The ID of the template the new version will be attached to
|
36
|
+
template_version_writable = Lob::TemplateVersionWritable.new({html: 'html_example'}) # TemplateVersionWritable |
|
37
|
+
|
38
|
+
begin
|
39
|
+
# create
|
40
|
+
result = api_instance.create(tmpl_id, template_version_writable)
|
41
|
+
p result
|
42
|
+
rescue Lob::ApiError => e
|
43
|
+
puts "Error when calling TemplateVersionsApi->create: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
#### Using the create_template_version_with_http_info variant
|
48
|
+
|
49
|
+
This returns an Array which contains the response data, status code and headers.
|
50
|
+
|
51
|
+
> <Array(<TemplateVersion>, Integer, Hash)> create_template_version_with_http_info(tmpl_id, template_version_writable)
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
begin
|
55
|
+
# create
|
56
|
+
data, status_code, headers = api_instance.create_template_version_with_http_info(tmpl_id, template_version_writable)
|
57
|
+
p status_code # => 2xx
|
58
|
+
p headers # => { ... }
|
59
|
+
p data # => <TemplateVersion>
|
60
|
+
rescue Lob::ApiError => e
|
61
|
+
puts "Error when calling TemplateVersionsApi->create_template_version_with_http_info: #{e}"
|
62
|
+
end
|
63
|
+
```
|
64
|
+
|
65
|
+
### Parameters
|
66
|
+
|
67
|
+
| Name | Type | Description | Notes |
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
69
|
+
| **tmpl_id** | **String** | The ID of the template the new version will be attached to | |
|
70
|
+
| **template_version_writable** | [**TemplateVersionWritable**](TemplateVersionWritable.md) | | |
|
71
|
+
|
72
|
+
### Return type
|
73
|
+
|
74
|
+
[**TemplateVersion**](TemplateVersion.md)
|
75
|
+
|
76
|
+
### Authorization
|
77
|
+
|
78
|
+
[basicAuth](../README.md#basicAuth)
|
79
|
+
|
80
|
+
### HTTP request headers
|
81
|
+
|
82
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
83
|
+
- **Accept**: application/json
|
84
|
+
|
85
|
+
|
86
|
+
## template_version_delete
|
87
|
+
|
88
|
+
> <TemplateVersionDeletion> template_version_delete(tmpl_id, vrsn_id)
|
89
|
+
|
90
|
+
delete
|
91
|
+
|
92
|
+
Permanently deletes a template version. A template's `published_version` can not be deleted.
|
93
|
+
|
94
|
+
### Examples
|
95
|
+
|
96
|
+
```ruby
|
97
|
+
require 'time'
|
98
|
+
require 'openapi_client'
|
99
|
+
# setup authorization
|
100
|
+
Lob.configure do |config|
|
101
|
+
# Configure HTTP basic authorization: basicAuth
|
102
|
+
config.username = 'YOUR USERNAME'
|
103
|
+
config.password = 'YOUR PASSWORD'
|
104
|
+
end
|
105
|
+
|
106
|
+
api_instance = Lob::TemplateVersionsApi.new
|
107
|
+
tmpl_id = 'tmpl_id_example' # String | The ID of the template to which the version belongs.
|
108
|
+
vrsn_id = 'vrsn_id_example' # String | id of the template_version
|
109
|
+
|
110
|
+
begin
|
111
|
+
# delete
|
112
|
+
result = api_instance.delete(tmpl_id, vrsn_id)
|
113
|
+
p result
|
114
|
+
rescue Lob::ApiError => e
|
115
|
+
puts "Error when calling TemplateVersionsApi->delete: #{e}"
|
116
|
+
end
|
117
|
+
```
|
118
|
+
|
119
|
+
#### Using the template_version_delete_with_http_info variant
|
120
|
+
|
121
|
+
This returns an Array which contains the response data, status code and headers.
|
122
|
+
|
123
|
+
> <Array(<TemplateVersionDeletion>, Integer, Hash)> template_version_delete_with_http_info(tmpl_id, vrsn_id)
|
124
|
+
|
125
|
+
```ruby
|
126
|
+
begin
|
127
|
+
# delete
|
128
|
+
data, status_code, headers = api_instance.template_version_delete_with_http_info(tmpl_id, vrsn_id)
|
129
|
+
p status_code # => 2xx
|
130
|
+
p headers # => { ... }
|
131
|
+
p data # => <TemplateVersionDeletion>
|
132
|
+
rescue Lob::ApiError => e
|
133
|
+
puts "Error when calling TemplateVersionsApi->template_version_delete_with_http_info: #{e}"
|
134
|
+
end
|
135
|
+
```
|
136
|
+
|
137
|
+
### Parameters
|
138
|
+
|
139
|
+
| Name | Type | Description | Notes |
|
140
|
+
| ---- | ---- | ----------- | ----- |
|
141
|
+
| **tmpl_id** | **String** | The ID of the template to which the version belongs. | |
|
142
|
+
| **vrsn_id** | **String** | id of the template_version | |
|
143
|
+
|
144
|
+
### Return type
|
145
|
+
|
146
|
+
[**TemplateVersionDeletion**](TemplateVersionDeletion.md)
|
147
|
+
|
148
|
+
### Authorization
|
149
|
+
|
150
|
+
[basicAuth](../README.md#basicAuth)
|
151
|
+
|
152
|
+
### HTTP request headers
|
153
|
+
|
154
|
+
- **Content-Type**: Not defined
|
155
|
+
- **Accept**: application/json
|
156
|
+
|
157
|
+
|
158
|
+
## template_version_retrieve
|
159
|
+
|
160
|
+
> <TemplateVersion> template_version_retrieve(tmpl_id, vrsn_id)
|
161
|
+
|
162
|
+
get
|
163
|
+
|
164
|
+
Retrieves the template version with the given template and version ids.
|
165
|
+
|
166
|
+
### Examples
|
167
|
+
|
168
|
+
```ruby
|
169
|
+
require 'time'
|
170
|
+
require 'openapi_client'
|
171
|
+
# setup authorization
|
172
|
+
Lob.configure do |config|
|
173
|
+
# Configure HTTP basic authorization: basicAuth
|
174
|
+
config.username = 'YOUR USERNAME'
|
175
|
+
config.password = 'YOUR PASSWORD'
|
176
|
+
end
|
177
|
+
|
178
|
+
api_instance = Lob::TemplateVersionsApi.new
|
179
|
+
tmpl_id = 'tmpl_id_example' # String | The ID of the template to which the version belongs.
|
180
|
+
vrsn_id = 'vrsn_id_example' # String | id of the template_version
|
181
|
+
|
182
|
+
begin
|
183
|
+
# get
|
184
|
+
result = api_instance.get(tmpl_id, vrsn_id)
|
185
|
+
p result
|
186
|
+
rescue Lob::ApiError => e
|
187
|
+
puts "Error when calling TemplateVersionsApi->get: #{e}"
|
188
|
+
end
|
189
|
+
```
|
190
|
+
|
191
|
+
#### Using the template_version_retrieve_with_http_info variant
|
192
|
+
|
193
|
+
This returns an Array which contains the response data, status code and headers.
|
194
|
+
|
195
|
+
> <Array(<TemplateVersion>, Integer, Hash)> template_version_retrieve_with_http_info(tmpl_id, vrsn_id)
|
196
|
+
|
197
|
+
```ruby
|
198
|
+
begin
|
199
|
+
# get
|
200
|
+
data, status_code, headers = api_instance.template_version_retrieve_with_http_info(tmpl_id, vrsn_id)
|
201
|
+
p status_code # => 2xx
|
202
|
+
p headers # => { ... }
|
203
|
+
p data # => <TemplateVersion>
|
204
|
+
rescue Lob::ApiError => e
|
205
|
+
puts "Error when calling TemplateVersionsApi->template_version_retrieve_with_http_info: #{e}"
|
206
|
+
end
|
207
|
+
```
|
208
|
+
|
209
|
+
### Parameters
|
210
|
+
|
211
|
+
| Name | Type | Description | Notes |
|
212
|
+
| ---- | ---- | ----------- | ----- |
|
213
|
+
| **tmpl_id** | **String** | The ID of the template to which the version belongs. | |
|
214
|
+
| **vrsn_id** | **String** | id of the template_version | |
|
215
|
+
|
216
|
+
### Return type
|
217
|
+
|
218
|
+
[**TemplateVersion**](TemplateVersion.md)
|
219
|
+
|
220
|
+
### Authorization
|
221
|
+
|
222
|
+
[basicAuth](../README.md#basicAuth)
|
223
|
+
|
224
|
+
### HTTP request headers
|
225
|
+
|
226
|
+
- **Content-Type**: Not defined
|
227
|
+
- **Accept**: application/json
|
228
|
+
|
229
|
+
|
230
|
+
## template_version_update
|
231
|
+
|
232
|
+
> <TemplateVersion> template_version_update(tmpl_id, vrsn_id, template_version_updatable)
|
233
|
+
|
234
|
+
update
|
235
|
+
|
236
|
+
Updates the template version with the given template and version ids.
|
237
|
+
|
238
|
+
### Examples
|
239
|
+
|
240
|
+
```ruby
|
241
|
+
require 'time'
|
242
|
+
require 'openapi_client'
|
243
|
+
# setup authorization
|
244
|
+
Lob.configure do |config|
|
245
|
+
# Configure HTTP basic authorization: basicAuth
|
246
|
+
config.username = 'YOUR USERNAME'
|
247
|
+
config.password = 'YOUR PASSWORD'
|
248
|
+
end
|
249
|
+
|
250
|
+
api_instance = Lob::TemplateVersionsApi.new
|
251
|
+
tmpl_id = 'tmpl_id_example' # String | The ID of the template to which the version belongs.
|
252
|
+
vrsn_id = 'vrsn_id_example' # String | id of the template_version
|
253
|
+
template_version_updatable = Lob::TemplateVersionUpdatable.new # TemplateVersionUpdatable |
|
254
|
+
|
255
|
+
begin
|
256
|
+
# update
|
257
|
+
result = api_instance.update(tmpl_id, vrsn_id, template_version_updatable)
|
258
|
+
p result
|
259
|
+
rescue Lob::ApiError => e
|
260
|
+
puts "Error when calling TemplateVersionsApi->update: #{e}"
|
261
|
+
end
|
262
|
+
```
|
263
|
+
|
264
|
+
#### Using the template_version_update_with_http_info variant
|
265
|
+
|
266
|
+
This returns an Array which contains the response data, status code and headers.
|
267
|
+
|
268
|
+
> <Array(<TemplateVersion>, Integer, Hash)> template_version_update_with_http_info(tmpl_id, vrsn_id, template_version_updatable)
|
269
|
+
|
270
|
+
```ruby
|
271
|
+
begin
|
272
|
+
# update
|
273
|
+
data, status_code, headers = api_instance.template_version_update_with_http_info(tmpl_id, vrsn_id, template_version_updatable)
|
274
|
+
p status_code # => 2xx
|
275
|
+
p headers # => { ... }
|
276
|
+
p data # => <TemplateVersion>
|
277
|
+
rescue Lob::ApiError => e
|
278
|
+
puts "Error when calling TemplateVersionsApi->template_version_update_with_http_info: #{e}"
|
279
|
+
end
|
280
|
+
```
|
281
|
+
|
282
|
+
### Parameters
|
283
|
+
|
284
|
+
| Name | Type | Description | Notes |
|
285
|
+
| ---- | ---- | ----------- | ----- |
|
286
|
+
| **tmpl_id** | **String** | The ID of the template to which the version belongs. | |
|
287
|
+
| **vrsn_id** | **String** | id of the template_version | |
|
288
|
+
| **template_version_updatable** | [**TemplateVersionUpdatable**](TemplateVersionUpdatable.md) | | |
|
289
|
+
|
290
|
+
### Return type
|
291
|
+
|
292
|
+
[**TemplateVersion**](TemplateVersion.md)
|
293
|
+
|
294
|
+
### Authorization
|
295
|
+
|
296
|
+
[basicAuth](../README.md#basicAuth)
|
297
|
+
|
298
|
+
### HTTP request headers
|
299
|
+
|
300
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
301
|
+
- **Accept**: application/json
|
302
|
+
|
303
|
+
|
304
|
+
## template_versions_list
|
305
|
+
|
306
|
+
> <TemplateVersionList> template_versions_list(tmpl_id, opts)
|
307
|
+
|
308
|
+
list
|
309
|
+
|
310
|
+
Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first.
|
311
|
+
|
312
|
+
### Examples
|
313
|
+
|
314
|
+
```ruby
|
315
|
+
require 'time'
|
316
|
+
require 'openapi_client'
|
317
|
+
# setup authorization
|
318
|
+
Lob.configure do |config|
|
319
|
+
# Configure HTTP basic authorization: basicAuth
|
320
|
+
config.username = 'YOUR USERNAME'
|
321
|
+
config.password = 'YOUR PASSWORD'
|
322
|
+
end
|
323
|
+
|
324
|
+
api_instance = Lob::TemplateVersionsApi.new
|
325
|
+
tmpl_id = 'tmpl_id_example' # String | The ID of the template associated with the retrieved versions
|
326
|
+
opts = {
|
327
|
+
limit: 56, # Integer | How many results to return.
|
328
|
+
before: 'before_example', # String | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response.
|
329
|
+
after: 'after_example', # String | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response.
|
330
|
+
include: ['inner_example'], # Array<String> | Request that the response include the total count by specifying `include[]=total_count`.
|
331
|
+
date_created: { key: Time.now} # Hash<String, Time> | Filter by date created.
|
332
|
+
}
|
333
|
+
|
334
|
+
begin
|
335
|
+
# list
|
336
|
+
result = api_instance.list(tmpl_id, opts)
|
337
|
+
p result
|
338
|
+
rescue Lob::ApiError => e
|
339
|
+
puts "Error when calling TemplateVersionsApi->list: #{e}"
|
340
|
+
end
|
341
|
+
```
|
342
|
+
|
343
|
+
#### Using the template_versions_list_with_http_info variant
|
344
|
+
|
345
|
+
This returns an Array which contains the response data, status code and headers.
|
346
|
+
|
347
|
+
> <Array(<TemplateVersionList>, Integer, Hash)> template_versions_list_with_http_info(tmpl_id, opts)
|
348
|
+
|
349
|
+
```ruby
|
350
|
+
begin
|
351
|
+
# list
|
352
|
+
data, status_code, headers = api_instance.template_versions_list_with_http_info(tmpl_id, opts)
|
353
|
+
p status_code # => 2xx
|
354
|
+
p headers # => { ... }
|
355
|
+
p data # => <TemplateVersionList>
|
356
|
+
rescue Lob::ApiError => e
|
357
|
+
puts "Error when calling TemplateVersionsApi->template_versions_list_with_http_info: #{e}"
|
358
|
+
end
|
359
|
+
```
|
360
|
+
|
361
|
+
### Parameters
|
362
|
+
|
363
|
+
| Name | Type | Description | Notes |
|
364
|
+
| ---- | ---- | ----------- | ----- |
|
365
|
+
| **tmpl_id** | **String** | The ID of the template associated with the retrieved versions | |
|
366
|
+
| **limit** | **Integer** | How many results to return. | [optional][default to 10] |
|
367
|
+
| **before** | **String** | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. | [optional] |
|
368
|
+
| **after** | **String** | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. | [optional] |
|
369
|
+
| **include** | [**Array<String>**](String.md) | Request that the response include the total count by specifying `include[]=total_count`. | [optional] |
|
370
|
+
| **date_created** | [**Hash<String, Time>**](Time.md) | Filter by date created. | [optional] |
|
371
|
+
|
372
|
+
### Return type
|
373
|
+
|
374
|
+
[**TemplateVersionList**](TemplateVersionList.md)
|
375
|
+
|
376
|
+
### Authorization
|
377
|
+
|
378
|
+
[basicAuth](../README.md#basicAuth)
|
379
|
+
|
380
|
+
### HTTP request headers
|
381
|
+
|
382
|
+
- **Content-Type**: Not defined
|
383
|
+
- **Accept**: application/json
|
384
|
+
|