RubyGems - lob - Versions diffs - 5.4.6 → 6.0.5 - Mend

lob 5.4.6 → 6.0.5

Files changed (496) hide show

checksums.yaml +4 -4
data/CODE_SNIPPETS.md +1871 -0
data/Gemfile +6 -1
data/Gemfile.lock +72 -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/Require.unit.rb +21 -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 +46 -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 +70 -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/lob.rb +1 -7
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 +385 -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 +343 -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 +601 -0
data/lib/openapi_client/models/dpv_footnote.rb +54 -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 +788 -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 +450 -214
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/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

data/CODE_SNIPPETS.md ADDED Viewed

@@ -0,0 +1,1871 @@
+# Code Snippets
+## Address Api
+### Retrieve
+```bash
+curl https://api.lob.com/v1/addresses/adr_fa85158b26c3eb7c \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+addressApi = AddressesApi.new(config)
+begin
+  retrievedAddress = addressApi.get("adr_fa85158b26c3eb7c")
+rescue => err
+  p err.message
+end
+```
+### Delete
+```bash
+curl -X DELETE "https://api.lob.com/v1/addresses/adr_43769b47aed248c2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+addressApi = AddressesApi.new(config)
+begin
+  deletedAddress = addressApi.delete("adr_43769b47aed248c2")
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/addresses \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=Harry - Office" \
+  -d "name=Harry Zhang" \
+  -d "company=Lob" \
+  -d "email=harry@lob.com" \
+  -d "phone=5555555555" \
+  -d "address_line1=210 King St" \
+  -d "address_line2=# 6100" \
+  -d "address_city=San Francisco" \
+  -d "address_state=CA" \
+  -d "address_zip=94107" \
+  -d "address_country=US" \
+```
+```ruby
+addressCreate = AddressEditable.new({
+  description: "Harry - Office",
+  name: "Harry Zhang",
+  company: "Lob",
+  email: "harry@lob.com",
+  phone: "5555555555",
+  address_line1: "210 King St",
+  address_line2: "# 6100",
+  address_city: "San Francisco",
+  address_state: "CA",
+  address_zip: "94107",
+  address_country: "US",
+});
+addressApi = AddressesApi.new(config)
+begin
+  createdAddress = addressApi.create(addressCreate)
+rescue => err
+  p err.message
+end
+```
+### List
+```bash
+curl -X GET "https://api.lob.com/v1/addresses?limit=2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+addressesApi = AddressesApi.new(config)
+begin
+  addresses = addressesApi.list({ limit: 2 })
+rescue => err
+  p err.message
+end
+```
+## Postcards Api
+### Retrieve
+```bash
+curl https://api.lob.com/v1/postcards/psc_5c002b86ce47537a \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+postcardApi = PostcardsApi.new(config)
+begin
+  retrievedPostcard = postcardApi.get("psc_5c002b86ce47537a")
+rescue => err
+  p err.message
+end
+```
+### Delete
+```bash
+curl -X DELETE "https://api.lob.com/v1/postcards/psc_5c002b86ce47537a" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+postcardApi = PostcardsApi.new(config)
+begin
+  deletedPostcard = postcardApi.cancel("psc_5c002b86ce47537a")
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/postcards \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=Demo Postcard job" \
+  -d "from=adr_210a8d4b0b76d77b" \
+  --data-urlencode "front=<html style='padding: 1in; font-size: 50;'>Front HTML for {{name}}</html>" \
+  --data-urlencode "back=<html style='padding: 1in; font-size: 20;'>Back HTML for {{name}}</html>" \
+  -d "to[name]=Harry Zhang" \
+  -d "to[address_line1]=210 King St" \
+  -d "to[address_line2]=# 6100" \
+  -d "to[address_city]=San Francisco" \
+  -d "to[address_state]=CA" \
+  -d "to[address_zip]=94107" \
+  -d "merge_variables[name]=Harry" \
+```
+```ruby
+postcardCreate = PostcardEditable.new({
+  description: "Demo Postcard job",
+  from: "adr_210a8d4b0b76d77b",
+  front: "<html style='padding: 1in; font-size: 50;'>Front HTML for {{name}}</html>",
+  back: "<html style='padding: 1in; font-size: 20;'>Back HTML for {{name}}</html>",
+  to: AddressEditable.new({
+    name: "Harry Zhang",
+    address_line1: "210 King St",
+    address_line2: "# 6100",
+    address_city: "San Francisco",
+    address_state: "CA",
+    address_zip: "94107",
+  }),
+  merge_variables: {
+    name: "Harry"
+  },
+});
+postcardApi = PostcardsApi.new(config)
+begin
+  createdPostcard = postcardApi.create(postcardCreate)
+rescue => err
+  p err.message
+end
+```
+### List
+```bash
+curl -X GET "https://api.lob.com/v1/postcards?limit=2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+postcardsApi = PostcardsApi.new(config)
+begin
+  postcards = postcardsApi.list({ limit: 2 })
+rescue => err
+  p err.message
+end
+```
+## SelfMailers Api
+### Retrieve
+```bash
+curl https://api.lob.com/v1/self_mailers/sfm_8ffbe811dea49dcf \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+selfMailerApi = SelfMailersApi.new(config)
+begin
+  retrievedSelfMailer = selfMailerApi.get("sfm_8ffbe811dea49dcf")
+rescue => err
+  p err.message
+end
+```
+### Delete
+```bash
+curl -X DELETE "https://api.lob.com/v1/self_mailers/sfm_8ffbe811dea49dcf" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+selfMailerApi = SelfMailersApi.new(config)
+begin
+  deletedSelfMailer = selfMailerApi.delete("sfm_8ffbe811dea49dcf")
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/self_mailers \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=Demo Self Mailer job" \
+  -d "from=adr_210a8d4b0b76d77b" \
+  --data-urlencode "inside=<html style='padding: 1in; font-size: 50;'>Inside HTML for {{name}}</html>" \
+  --data-urlencode "outside=<html style='padding: 1in; font-size: 20;'>Outside HTML for {{name}}</html>" \
+  -d "to[name]=Harry Zhang" \
+  -d "to[address_line1]=210 King St" \
+  -d "to[address_line2]=# 6100" \
+  -d "to[address_city]=San Francisco" \
+  -d "to[address_state]=CA" \
+  -d "to[address_zip]=94107" \
+  -d "merge_variables[name]=Harry" \
+```
+```ruby
+selfMailerCreate = SelfMailerEditable.new({
+  description: "Demo Self Mailer job",
+  from: "adr_210a8d4b0b76d77b",
+  inside: "<html style='padding: 1in; font-size: 50;'>Inside HTML for {{name}}</html>",
+  outside: "<html style='padding: 1in; font-size: 20;'>Outside HTML for {{name}}</html>",
+  to: AddressEditable.new({
+    name: "Harry Zhang",
+    address_line1: "210 King St",
+    address_line2: "# 6100",
+    address_city: "San Francisco",
+    address_state: "CA",
+    address_zip: "94107",
+  }),
+  merge_variables: {
+    name: "Harry"
+  },
+});
+selfMailerApi = SelfMailersApi.new(config)
+begin
+  createdSelfMailer = selfMailerApi.create(selfMailerCreate)
+rescue => err
+  p err.message
+end
+```
+### List
+```bash
+curl -X GET "https://api.lob.com/v1/self_mailers?limit=2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+selfMailersApi = SelfMailersApi.new(config)
+begin
+  selfMailers = selfMailersApi.list({ limit: 2 })
+rescue => err
+  p err.message
+end
+```
+## Letters Api
+### Retrieve
+```bash
+curl https://api.lob.com/v1/letters/ltr_4868c3b754655f90 \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+letterApi = LettersApi.new(config)
+begin
+  retrievedLetter = letterApi.get("ltr_4868c3b754655f90")
+rescue => err
+  p err.message
+end
+```
+### Delete
+```bash
+curl -X DELETE "https://api.lob.com/v1/letters/ltr_4868c3b754655f90" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+letterApi = LettersApi.new(config)
+begin
+  deletedLetter = letterApi.cancel("ltr_4868c3b754655f90")
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/letters \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=Demo Letter" \
+  -d "from=adr_210a8d4b0b76d77b" \
+  --data-urlencode "file=<html style='padding-top: 3in; margin: .5in;'>HTML Letter for {{name}}</html>" \
+  -d "color=true" \
+  -d "to[name]=Harry Zhang" \
+  -d "to[address_line1]=210 King St" \
+  -d "to[address_line2]=# 6100" \
+  -d "to[address_city]=San Francisco" \
+  -d "to[address_state]=CA" \
+  -d "to[address_zip]=94107" \
+  -d "merge_variables[name]=Harry" \
+  -d "cards[]=card_c51ae96f5cebf3e"
+```
+```ruby
+letterCreate = LetterEditable.new({
+  description: "Demo Letter",
+  from: "adr_210a8d4b0b76d77b",
+  file: "<html style='padding-top: 3in; margin: .5in;'>HTML Letter for {{name}}</html>",
+  color: "true",
+  to: AddressEditable.new({
+    name: "Harry Zhang",
+    address_line1: "210 King St",
+    address_line2: "# 6100",
+    address_city: "San Francisco",
+    address_state: "CA",
+    address_zip: "94107",
+  }),
+  merge_variables: {
+    name: "Harry"
+  },
+  cards: [
+    "card_c51ae96f5cebf3e",
+  ],
+});
+letterApi = LettersApi.new(config)
+begin
+  createdLetter = letterApi.create(letterCreate)
+rescue => err
+  p err.message
+end
+```
+### List
+```bash
+curl -X GET "https://api.lob.com/v1/letters?limit=2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+lettersApi = LettersApi.new(config)
+begin
+  letters = lettersApi.list({ limit: 2 })
+rescue => err
+  p err.message
+end
+```
+## Checks Api
+### Retrieve
+```bash
+curl https://api.lob.com/v1/checks/chk_534f10783683daa0 \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+checkApi = ChecksApi.new(config)
+begin
+  retrievedCheck = checkApi.get("chk_534f10783683daa0")
+rescue => err
+  p err.message
+end
+```
+### Delete
+```bash
+curl -X DELETE "https://api.lob.com/v1/checks/chk_534f10783683daa0" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+checkApi = ChecksApi.new(config)
+begin
+  deletedCheck = checkApi.cancel("chk_534f10783683daa0")
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/checks \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=Demo Check" \
+  -d "bank_account=bank_8cad8df5354d33f" \
+  -d "amount=22.5" \
+  -d "memo=rent" \
+  --data-urlencode "logo=https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png" \
+  --data-urlencode "check_bottom=<h1 style='padding-top:4in;'>Demo Check for {{name}}</h1>" \
+  -d "from=adr_210a8d4b0b76d77b" \
+  -d "to[name]=Harry Zhang" \
+  -d "to[address_line1]=210 King St" \
+  -d "to[address_line2]=# 6100" \
+  -d "to[address_city]=San Francisco" \
+  -d "to[address_state]=CA" \
+  -d "to[address_zip]=94107" \
+  -d "merge_variables[name]=Harry" \
+```
+```ruby
+checkCreate = CheckEditable.new({
+  description: "Demo Check",
+  bank_account: "bank_8cad8df5354d33f",
+  amount: 22.5,
+  memo: "rent",
+  logo: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/check_logo.png",
+  check_bottom: "<h1 style='padding-top:4in;'>Demo Check for {{name}}</h1>",
+  from: "adr_210a8d4b0b76d77b",
+  to: AddressDomestic.new({
+    name: "Harry Zhang",
+    address_line1: "210 King St",
+    address_line2: "# 6100",
+    address_city: "San Francisco",
+    address_state: "CA",
+    address_zip: "94107",
+  }),
+  merge_variables: {
+    name: "Harry"
+  },
+});
+checkApi = ChecksApi.new(config)
+begin
+  createdCheck = checkApi.create(checkCreate)
+rescue => err
+  p err.message
+end
+```
+### List
+```bash
+curl -X GET "https://api.lob.com/v1/checks?limit=2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+checksApi = ChecksApi.new(config)
+begin
+  checks = checksApi.list({ limit: 2 })
+rescue => err
+  p err.message
+end
+```
+## BankAccounts Api
+### Retrieve
+```bash
+curl https://api.lob.com/v1/bank_accounts/bank_8cad8df5354d33f \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+bankAccountApi = BankAccountsApi.new(config)
+begin
+  retrievedBankAccount = bankAccountApi.get("bank_8cad8df5354d33f")
+rescue => err
+  p err.message
+end
+```
+### Delete
+```bash
+curl -X DELETE "https://api.lob.com/v1/bank_accounts/bank_3e64d9904356b20" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+bankAccountApi = BankAccountsApi.new(config)
+begin
+  deletedBankAccount = bankAccountApi.delete("bank_3e64d9904356b20")
+rescue => err
+  p err.message
+end
+```
+### List
+```bash
+curl -X GET "https://api.lob.com/v1/bank_accounts?limit=2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+bankAccountsApi = BankAccountsApi.new(config)
+begin
+  bankAccounts = bankAccountsApi.list({ limit: 2 })
+rescue => err
+  p err.message
+end
+```
+### Verify
+```bash
+curl https://api.lob.com/v1/bank_accounts/bank_dfceb4a2a05b57e/verify \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "amounts[]=25" \
+  -d "amounts[]=63" \
+```
+```ruby
+verificationData = BankAccountVerify.new({
+  amounts: [
+    25,
+    63,
+  ],
+})
+bankAccountsApi = BankAccountsApi.new(config)
+begin
+  verifiedAccount = bankAccountsApi.verify("bank_dfceb4a2a05b57e", verificationData)
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/bank_accounts \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=Test Bank Account" \
+  -d "routing_number=322271627" \
+  -d "account_number=123456789" \
+  -d "signatory=John Doe" \
+  -d "account_type=company" \
+```
+```ruby
+bankAccountCreate = BankAccountWritable.new({
+  description: "Test Bank Account",
+  routing_number: "322271627",
+  account_number: "123456789",
+  signatory: "John Doe",
+  account_type: BankTypeEnum::COMPANY,
+});
+bankAccountApi = BankAccountsApi.new(config)
+begin
+  createdBankAccount = bankAccountApi.create(bankAccountCreate)
+rescue => err
+  p err.message
+end
+```
+## Templates Api
+### Retrieve
+```bash
+curl https://api.lob.com/v1/templates/tmpl_c94e83ca2cd5121 \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+templateApi = TemplatesApi.new(config)
+begin
+  retrievedTemplate = templateApi.get("tmpl_c94e83ca2cd5121")
+rescue => err
+  p err.message
+end
+```
+### Delete
+```bash
+curl -X DELETE "https://api.lob.com/v1/templates/tmpl_df934eeda694203" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+templateApi = TemplatesApi.new(config)
+begin
+  deletedTemplate = templateApi.delete("tmpl_df934eeda694203")
+rescue => err
+  p err.message
+end
+```
+### Delete
+```bash
+curl -X DELETE "https://api.lob.com/v1/templates/tmpl_df934eeda694203" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+templateApi = TemplatesApi.new(config)
+begin
+  deletedTemplate = templateApi.delete("tmpl_df934eeda694203")
+rescue => err
+  p err.message
+end
+```
+### List
+```bash
+curl -X GET "https://api.lob.com/v1/templates?limit=2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+templatesApi = TemplatesApi.new(config)
+begin
+  templates = templatesApi.list({ limit: 2 })
+rescue => err
+  p err.message
+end
+```
+### Update
+```bash
+curl -X PATCH https://api.lob.com/v1/tmpl_c94e83ca2cd5121 \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=updated template" \
+  -d "published_version=vrsn_362184d96d9b0c9" \
+```
+```ruby
+templateUpdate = TemplateUpdate.new({
+  description: "updated template",
+  published_version: "vrsn_362184d96d9b0c9",
+})
+templateApi = TemplatesApi.new(config)
+begin
+  updatedTemplate = templateApi.update("tmpl_c94e83ca2cd5121", templateUpdate)
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/templates \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=Test Template" \
+  --data-urlencode "html=<html>HTML for {{name}}</html>" \
+```
+```ruby
+templateCreate = TemplateWritable.new({
+  description: "Test Template",
+  html: "<html>HTML for {{name}}</html>",
+});
+templateApi = TemplatesApi.new(config)
+begin
+  createdTemplate = templateApi.create(templateCreate)
+rescue => err
+  p err.message
+end
+```
+## TemplateVersions Api
+### Retrieve
+```bash
+curl https://api.lob.com/v1/templates/tmpl_c94e83ca2cd5121/versions/vrsn_534e339882d2282 \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+templateVersionApi = TemplateVersionsApi.new(config)
+begin
+  retrievedTemplateVersion = templateVersionApi.get("tmpl_c94e83ca2cd5121", "vrsn_534e339882d2282")
+rescue => err
+  p err.message
+end
+```
+### Delete
+```bash
+curl -X DELETE "https://api.lob.com/v1/templates/tmpl_4aa14648113e45b/versions/vrsn_534e339882d2282" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+templateVersionApi = TemplateVersionsApi.new(config)
+begin
+  deletedTemplateVersion = templateVersionApi.delete("tmpl_4aa14648113e45b", "vrsn_534e339882d2282")
+rescue => err
+  p err.message
+end
+```
+### List
+```bash
+curl -X GET "https://api.lob.com/v1/templates/tmpl_dadaaf7b76c9f25/versions?limit=2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+templateVersionsApi = TemplateVersionsApi.new(config)
+begin
+  templateVersions = templateVersionsApi.list("tmpl_dadaaf7b76c9f25", { limit: 2 })
+rescue => err
+  p err.message
+end
+```
+### Update
+```bash
+curl -X PATCH https://api.lob.com/v1/vrsn_534e339882d2282 \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=updated template version" \
+```
+```ruby
+templateVersionUpdatable = TemplateUpdate.new({
+  description: "updated template version",
+})
+templateVersionApi = TemplateVersionsApi.new(config)
+begin
+  updatedTemplateVersion = templateVersionApi.update("tmpl_c94e83ca2cd5121", "vrsn_534e339882d2282", templateVersionUpdatable)
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/templates/tmpl_4aa14648113e45b/versions \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=Second Version" \
+  --data-urlencode "html=<html>Second HTML for {{name}}</html>" \
+```
+```ruby
+templateVersionCreate = TemplateVersionWritable.new({
+  description: "Second Version",
+  html: "<html>Second HTML for {{name}}</html>",
+});
+templateVersionApi = TemplateVersionsApi.new(config)
+begin
+  createdTemplateVersion = templateVersionApi.create("tmpl_4aa14648113e45b", templateVersionCreate)
+rescue => err
+  p err.message
+end
+```
+## BillingGroups Api
+### Retrieve
+```bash
+curl https://api.lob.com/v1/billing_groups/bg_4bb02b527a72667d0 \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+billingGroupApi = BillingGroupsApi.new(config)
+begin
+  retrievedBillingGroup = billingGroupApi.get("bg_4bb02b527a72667d0")
+rescue => err
+  p err.message
+end
+```
+### Retrieve
+```bash
+curl https://api.lob.com/v1/billing_groups/bg_4bb02b527a72667d0 \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+billingGroupApi = BillingGroupsApi.new(config)
+begin
+  retrievedBillingGroup = billingGroupApi.get("bg_4bb02b527a72667d0")
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/billing_groups \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=Usage group used for the Marketing Department's resource sends" \
+  -d "name=Marketing Department" \
+```
+```ruby
+bgCreate = BillingGroupEditable.new({
+  description: "Usage group used for the Marketing Department's resource sends",
+  name: "Marketing Department",
+});
+bgApi = BillingGroupsApi.new(config)
+begin
+  createdBillingGroup = bgApi.create(bgCreate)
+rescue => err
+  p err.message
+end
+```
+### Update
+```bash
+curl -X PATCH https://api.lob.com/v1/bg_759954f540a1bfdb5 \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=demo replacement" \
+```
+```ruby
+billingGroupEditable = BillingGroupEditable.new({
+  description: "demo replacement",
+})
+bgApi = BillingGroupsApi.new(config)
+begin
+  updatedBillingGroup = bgApi.update("bg_759954f540a1bfdb5", billingGroupEditable)
+rescue => err
+  p err.message
+end
+```
+### List
+```bash
+curl -X GET "https://api.lob.com/v1/billing_groups?limit=2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+billingGroupsApi = BillingGroupsApi.new(config)
+begin
+  billingGroups = billingGroupsApi.list({ limit: 2 })
+rescue => err
+  p err.message
+end
+```
+## Cards Api
+### Retrieve
+```bash
+curl https://api.lob.com/v1/cards/card_7a6d73c5c8457fc \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+cardApi = CardsApi.new(config)
+begin
+  retrievedCard = cardApi.get("card_7a6d73c5c8457fc")
+rescue => err
+  p err.message
+end
+```
+### Delete
+```bash
+curl -X DELETE "https://api.lob.com/v1/cards/card_6afffd19045076c" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+cardApi = CardsApi.new(config)
+begin
+  deletedCard = cardApi.delete("card_6afffd19045076c")
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/cards \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "front=https://s3-us-west-2.amazonaws.com/public.lob.com/assets/card_horizontal.pdf" \
+  -d "back=https://s3-us-west-2.amazonaws.com/public.lob.com/assets/card_horizontal.pdf" \
+  -d "size=2.125x3.375" \
+  -d "description=Test Card" \
+```
+```ruby
+cardCreate = CardEditable.new({
+  front: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/card_horizontal.pdf",
+  back: "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/card_horizontal.pdf",
+  size: "2.125x3.375",
+  description: "Test Card",
+});
+cardApi = CardsApi.new(config)
+begin
+  createdCard = cardApi.create(cardCreate)
+rescue => err
+  p err.message
+end
+```
+### List
+```bash
+curl -X GET "https://api.lob.com/v1/cards?limit=2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+cardsApi = CardsApi.new(config)
+begin
+  cards = cardsApi.list({ limit: 2 })
+rescue => err
+  p err.message
+end
+```
+### Update
+```bash
+curl -X PATCH https://api.lob.com/v1/card_6afffd19045076c \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=Awesome card" \
+  -d "auto_reorder=true" \
+  -d "reorder_quantity=10000" \
+```
+```ruby
+cardUpdatable = CardUpdatable.new({
+  description: "Awesome card",
+  auto_reorder: "true",
+  reorder_quantity: 10000,
+})
+cardApi = CardsApi.new(config)
+begin
+  updatedCard = cardApi.update("card_6afffd19045076c", cardUpdatable)
+rescue => err
+  p err.message
+end
+```
+## CardOrders Api
+### Retrieve
+```bash
+curl https://api.lob.com/v1/cards/card_6afffd19045076c/orders/ \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+cardOrderApi = CardOrdersApi.new(config)
+begin
+  retrievedCardOrderList = cardOrderApi.get("card_6afffd19045076c", { limit: 2, offset: 1 })
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/cards/card_6afffd19045076c/orders \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "quantity=10000" \
+```
+```ruby
+cardOrderCreate = CardOrderEditable.new({
+  quantity: 10000,
+});
+cardOrderApi = CardOrdersApi.new(config)
+begin
+  createdCardOrder = cardOrderApi.create("card_6afffd19045076c", cardOrderCreate)
+rescue => err
+  p err.message
+end
+```
+## Campaigns Api
+### Retrieve
+```bash
+curl https://api.lob.com/v1/campaigns/cmp_e05ee61ff80764b \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+campaignApi = CampaignsApi.new(config)
+begin
+  retrievedCampaign = campaignApi.get("cmp_e05ee61ff80764b")
+rescue => err
+  p err.message
+end
+```
+### Delete
+```bash
+curl -X DELETE "https://api.lob.com/v1/campaigns/cmp_e05ee61ff80764b" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+campaignApi = CampaignsApi.new(config)
+begin
+  deletedCampaign = campaignApi.delete("cmp_e05ee61ff80764b")
+rescue => err
+  p err.message
+end
+```
+### Update
+```bash
+curl -X PATCH https://api.lob.com/v1/cmp_e05ee61ff80764b \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=Awesome campaign" \
+```
+```ruby
+campaignUpdatable = CampaignUpdatable.new({
+  description: "Awesome campaign",
+})
+campaignApi = CampaignsApi.new(config)
+begin
+  updatedCampaign = campaignApi.update("cmp_e05ee61ff80764b", campaignUpdatable)
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/campaigns \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "name=My First Campaign" \
+  -d "schedule_type=immediate" \
+```
+```ruby
+campaignCreate = CampaignWritable.new({
+  name: "My First Campaign",
+  schedule_type: "immediate",
+});
+campaignApi = CampaignsApi.new(config)
+begin
+  createdCampaign = campaignApi.create(campaignCreate)
+rescue => err
+  p err.message
+end
+```
+### List
+```bash
+curl -X GET "https://api.lob.com/v1/campaigns?limit=2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+campaignsApi = CampaignsApi.new(config)
+begin
+  campaigns = campaignsApi.list({ limit: 2 })
+rescue => err
+  p err.message
+end
+```
+## Creatives Api
+### Update
+```bash
+curl -X PATCH https://api.lob.com/v1/crv_2a3b096c409b32c \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "description=Our updated 4x6 postcard creative" \
+```
+```ruby
+creativePatch = CreativePatch.new({
+  description: "Our updated 4x6 postcard creative",
+})
+creativeApi = CreativesApi.new(config)
+begin
+  updatedCreative = creativeApi.update("crv_2a3b096c409b32c", creativePatch)
+rescue => err
+  p err.message
+end
+```
+### Retrieve
+```bash
+curl https://api.lob.com/v1/creatives/crv_2a3b096c409b32c \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+creativeApi = CreativesApi.new(config)
+begin
+  retrievedCreative = creativeApi.get("crv_2a3b096c409b32c")
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/creatives \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "campaign_id=cmp_e05ee61ff80764b" \
+  -d "resource_type=postcard" \
+  -d "description=Our 4x6 postcard creative" \
+  -d "from=adr_210a8d4b0b76d77b" \
+  -d "front=tmpl_4aa14648113e45b" \
+  -d "back=tmpl_4aa14648113e45b" \
+  -d "details[mail_type]=usps_first_class" \
+```
+```ruby
+creativeCreate = CreativeWritable.new({
+  campaign_id: "cmp_e05ee61ff80764b",
+  resource_type: "postcard",
+  description: "Our 4x6 postcard creative",
+  from: "adr_210a8d4b0b76d77b",
+  front: "tmpl_4aa14648113e45b",
+  back: "tmpl_4aa14648113e45b",
+  details: PostcardDetailsWritable.new({
+    mail_type: "usps_first_class",
+  }),
+});
+creativeApi = CreativesApi.new(config)
+begin
+  createdCreative = creativeApi.create(creativeCreate)
+rescue => err
+  p err.message
+end
+```
+## Uploads Api
+### List
+```bash
+curl -X GET "https://api.lob.com/v1/?limit=2" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+uploadsApi = UploadsApi.new(config)
+begin
+  uploads = uploadsApi.list_upload({ campaign_id: "cmp_e05ee61ff80764b" })
+rescue => err
+  p err.message
+end
+```
+### Retrieve Export
+```bash
+curl https://api.lob.com/v1/uploads/upl_71be866e430b11e9/exports/ex_6a94fe68fd151e0f8 \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "type=failures"
+```
+```ruby
+uploadsApi = UploadsApi.new(config)
+begin
+  retrievedExport = uploadsApi.get_export("upl_71be866e430b11e9", "ex_6a94fe68fd151e0f8")
+rescue => err
+  p err.message
+end
+```
+### Upload File
+```bash
+curl -X POST https://api.lob.com/v1/uploads/upl_71be866e430b11e9/file \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -F file=@<YOUR_FILE_NAME_HERE>
+```
+```ruby
+# to come
+```
+### Retrieve
+```bash
+curl https://api.lob.com/v1/uploads/upl_71be866e430b11e9 \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+uploadApi = UploadsApi.new(config)
+begin
+  retrievedUpload = uploadApi.get_upload("upl_71be866e430b11e9")
+rescue => err
+  p err.message
+end
+```
+### Create Export
+```bash
+curl https://api.lob.com/v1/uploads/upl_71be866e430b11e9/exports \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "type=failures"
+```
+```ruby
+exportModel = ExportModel.new({
+  type: "all"
+})
+uploadsApi = UploadsApi.new(config)
+begin
+  createdExport = uploadsApi.create_export("upl_71be866e430b11e9", exportModel)
+rescue => err
+  p err.message
+end
+```
+### Update
+```bash
+curl -X PATCH https://api.lob.com/v1/upl_71be866e430b11e9 \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+```
+```ruby
+uploadUpdatable = UploadUpdatable.new({
+  required_address_column_mapping: RequiredAddressColumnMapping.new({
+    name: "recipient",
+    address_line1: "primary line",
+    address_city: "city",
+    address_state: "state",
+    address_zip: "zip_code",
+  }),
+})
+uploadApi = UploadsApi.new(config)
+begin
+  updatedUpload = uploadApi.update_upload("upl_71be866e430b11e9", uploadUpdatable)
+rescue => err
+  p err.message
+end
+```
+### Create
+```bash
+curl https://api.lob.com/v1/uploads \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "campaignId=cmp_e05ee61ff80764b" \
+```
+```ruby
+uploadCreate = UploadWritable.new({
+  campaign_id: "cmp_e05ee61ff80764b",
+});
+uploadApi = UploadsApi.new(config)
+begin
+  createdUpload = uploadApi.create_upload(uploadCreate)
+rescue => err
+  p err.message
+end
+```
+### Delete
+```bash
+curl -X DELETE "https://api.lob.com/v1/uploads/upl_71be866e430b11e9" \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc:
+```
+```ruby
+uploadApi = UploadsApi.new(config)
+begin
+  deletedUpload = uploadApi.delete_upload("upl_71be866e430b11e9")
+rescue => err
+  p err.message
+end
+```
+## ZipLookups Api
+### ZipLookup
+```bash
+curl https://api.lob.com/v1/us_zip_lookups \
+  -u test_0dc8d51e0acffcb1880e0f19c79b2f5b0cc: \
+  -d "zip_code=94107"
+```
+```ruby
+zipLookupsApi = ZipLookupsApi.new(config)
+zipRequest = ZipEditable.new({
+  zip_code: "94107"
+})
+begin
+  zipLookup = zipLookupsApi.lookup(zipRequest)
+rescue => err
+  p err.message
+end
+```
+## Reverse Geocode Lookups Api
+### Reverse Geocode Lookup
+```bash
+curl https://api.lob.com/v1/us_reverse_geocode_lookups \
+  -u <YOUR_LIVE_API_KEY>: \
+```
+```ruby
+reverseGeocodeLookupsApi = ReverseGeocodeLookupsApi.new(config)
+coordinates = Location.new({
+  latitude: 37.777456,
+  longitude: -122.393039,
+})
+begin
+  geocode = reverseGeocodeLookupsApi.lookup(coordinates)
+rescue => err
+  p err.message
+end
+```
+## USAutoCompletions Api
+### Autocomplete
+```bash
+curl https://api.lob.com/v1/us_autocompletions \
+  -u <YOUR_LIVE_API_KEY>: \
+  -d "address_prefix=185 B" \
+  -d "city=San Francisco" \
+  -d "state=CA" \
+  -d "zip_code=94017" \
+```
+```ruby
+usAutocompletionsApi = UsAutocompletionsApi.new(config)
+autocompletionData = UsAutocompletionsWritable.new({
+  address_prefix: "185 B",
+  city: "San Francisco",
+  state: "CA",
+  zip_code: "94017",
+})
+begin
+  autocompletedAddress = usAutocompletionsApi.autocomplete(autocompletionData)
+rescue => err
+  p err.message
+end
+```
+## UsVerifications Api
+### Bulk Verify
+```bash
+curl https://api.lob.com/v1/bulk/us_verifications \
+  -u <YOUR LIVE API KEY>: \
+  --header "Content-Type: application/x-www-form-urlencoded" \
+  --data-urlencode "addresses[0][primary_line]=210 King Street" \
+  --data-urlencode "addresses[0][city]=San Francisco" \
+  --data-urlencode "addresses[0][state]=CA" \
+  --data-urlencode "addresses[0][zip_code]=94017" \
+  --data-urlencode "addresses[1][primary_line]=185 BERRY ST STE 6600" \
+  --data-urlencode "addresses[1][city]=SAN FRANCISCO" \
+  --data-urlencode "addresses[1][state]=CA" \
+  --data-urlencode "addresses[1][zip_code]=94017" \
+```
+```ruby
+usVerificationsApi = UsVerificationsApi.new(config)
+verificationData0 = MultipleComponents.new({
+  primary_line: "210 King Street",
+  city: "San Francisco",
+  state: "CA",
+  zip_code: "94017",
+})
+verificationData1 = MultipleComponents.new({
+  primary_line: "185 BERRY ST STE 6600",
+  city: "SAN FRANCISCO",
+  state: "CA",
+  zip_code: "94017",
+})
+addressList = MultipleComponentsList.new({
+  addresses: [
+    verificationData0,
+    verificationData1,
+  ],
+})
+begin
+  bulkVerifiedAddrs = usVerificationsApi.verifyBulk(addressList)
+rescue => err
+  p err.message
+end
+```
+### Single Verify
+```bash
+curl https://api.lob.com/v1/us_verifications \
+  -u <YOUR_LIVE_API_KEY>: \
+  -d "primary_line=210 King Street" \
+  -d "city=San Francisco" \
+  -d "state=CA" \
+  -d "zip_code=94017" \
+```
+```ruby
+usVerificationsApi = UsVerificationsApi.new(config)
+verificationData = UsVerificationsWritable.new({
+  primary_line: "210 King Street",
+  city: "San Francisco",
+  state: "CA",
+  zip_code: "94017",
+})
+begin
+  singleVerifiedAddr = usVerificationsApi.verifySingle(verificationData)
+rescue => err
+  p err.message
+end
+```
+## IntlAutocompletion Api
+### IntlAutocompletion
+```bash
+curl https://api.lob.com/v1/intl_autocompletions \
+  -u <YOUR_LIVE_API_KEY>: \
+  -d "address_prefix=340 Wat" \
+  -d "city=Summerside" \
+  -d "state=Prince Edward Island" \
+  -d "zip_code=C1N 1C4" \
+  -d "country=CA" \
+```
+```ruby
+intlAutocompletionsApi = IntlAutocompletionsApi.new(config)
+autocompletionData = IntlAutocompletionsWritable.new({
+  address_prefix: "340 Wat",
+  city: "Summerside",
+  state: "Prince Edward Island",
+  zip_code: "C1N 1C4",
+  country: CountryExtended::CA,
+})
+begin
+  autocompletedAddr = intlAutocompletionsApi.autocomplete(autocompletionData)
+rescue => err
+  p err.message
+end
+```
+## IntlVerifications Api
+### Single Verify
+```bash
+curl https://api.lob.com/v1/intl_verifications \
+  -u <YOUR_LIVE_API_KEY>: \
+  -d "primary_line=370 Water St" \
+  -d "city=Summerside" \
+  -d "state=Prince Edward Island" \
+  -d "postal_code=C1N 1C4" \
+  -d "country=CA" \
+```
+```ruby
+intlVerificationsApi = IntlVerificationsApi.new(config)
+verificationData = IntlVerificationWritable.new({
+  primary_line: "370 Water St",
+  city: "Summerside",
+  state: "Prince Edward Island",
+  postal_code: "C1N 1C4",
+  country: CountryExtended::CA,
+})
+begin
+  verifiedAddr = intlVerificationsApi.verifySingle(verificationData)
+rescue => err
+  p err.message
+end
+```
+### Bulk Verify
+```bash
+curl https://api.lob.com/v1/bulk/intl_verifications \
+  -u <YOUR LIVE API KEY>: \
+  --header 'Content-Type: application/x-www-form-urlencoded' \
+  --data-urlencode 'addresses[0][primary_line]=35 Tower Hill' \
+  --data-urlencode 'addresses[0][city]=London' \
+  --data-urlencode 'addresses[0][postal_code]=EC3N 4DR' \
+  --data-urlencode 'addresses[0][country]=GB' \
+  --data-urlencode 'addresses[1][primary_line]=370 Water St' \
+  --data-urlencode 'addresses[1][city]=Summerside' \
+  --data-urlencode 'addresses[1][state]=Prince Edward Island' \
+  --data-urlencode 'addresses[1][postal_code]=C1N 1C4' \
+  --data-urlencode 'addresses[1][country]=CA' \
+```
+```ruby
+intlVerificationsApi = IntlVerificationsApi.new(config)
+verificationData0 = MultipleComponentsIntl.new({
+  primary_line: "35 Tower Hill",
+  city: "London",
+  postal_code: "EC3N 4DR",
+  country: "GB",
+})
+verificationData1 = MultipleComponentsIntl.new({
+  primary_line: "370 Water St",
+  city: "Summerside",
+  state: "Prince Edward Island",
+  postal_code: "C1N 1C4",
+  country: "CA",
+})
+addressList = IntlVerificationsPayload.new({
+  addresses: [
+    verificationData0,
+    verificationData1,
+  ],
+})
+begin
+  bulkVerifiedAddrs = intlVerificationsApi.verifyBulk(addressList)
+rescue => err
+  p err.message
+end
+```