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
@@ -1,36 +0,0 @@
|
|
1
|
-
name: Run tests from Forked Repo
|
2
|
-
|
3
|
-
on:
|
4
|
-
pull_request_target:
|
5
|
-
types: [labeled]
|
6
|
-
jobs:
|
7
|
-
ruby_tests:
|
8
|
-
runs-on: ubuntu-latest
|
9
|
-
if: contains(github.event.pull_request.labels.*.name, 'Approved')
|
10
|
-
|
11
|
-
strategy:
|
12
|
-
matrix:
|
13
|
-
ruby-version: ['jruby-9.2.9.0', '2.6', '2.7', '3.0']
|
14
|
-
steps:
|
15
|
-
- uses: actions/checkout@v2
|
16
|
-
- name: Setup
|
17
|
-
uses: ruby/setup-ruby@v1
|
18
|
-
with:
|
19
|
-
ruby-version: ${{ matrix.ruby-version }}
|
20
|
-
- name: Install Dependencies
|
21
|
-
run: bundle install
|
22
|
-
- name: Run Tests
|
23
|
-
env:
|
24
|
-
API_KEY: ${{ secrets.API_KEY }}
|
25
|
-
JRUBY_OPT: --2.0
|
26
|
-
run: bundle exec rake test
|
27
|
-
- name: Send coverage to Coveralls
|
28
|
-
uses: coverallsapp/github-action@master
|
29
|
-
with:
|
30
|
-
github-token: ${{ secrets.GITHUB_TOKEN }}
|
31
|
-
path-to-lcov: ./coverage/lcov/lcov.info
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
@@ -1,32 +0,0 @@
|
|
1
|
-
name: Run tests
|
2
|
-
|
3
|
-
on: [pull_request]
|
4
|
-
jobs:
|
5
|
-
ruby_tests:
|
6
|
-
runs-on: ubuntu-latest
|
7
|
-
strategy:
|
8
|
-
matrix:
|
9
|
-
ruby-version: ['jruby-9.2.9.0', '2.6', '2.7', '3.0']
|
10
|
-
steps:
|
11
|
-
- uses: actions/checkout@v2
|
12
|
-
- name: Setup
|
13
|
-
uses: ruby/setup-ruby@v1
|
14
|
-
with:
|
15
|
-
ruby-version: ${{ matrix.ruby-version }}
|
16
|
-
- name: Install Dependencies
|
17
|
-
run: bundle install
|
18
|
-
- name: Run Tests
|
19
|
-
env:
|
20
|
-
API_KEY: ${{ secrets.API_KEY }}
|
21
|
-
JRUBY_OPT: --2.0
|
22
|
-
run: bundle exec rake test
|
23
|
-
- name: Send coverage to Coveralls
|
24
|
-
uses: coverallsapp/github-action@master
|
25
|
-
with:
|
26
|
-
github-token: ${{ secrets.GITHUB_TOKEN }}
|
27
|
-
path-to-lcov: ./coverage/lcov/lcov.info
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
@@ -1,27 +0,0 @@
|
|
1
|
-
name: Publish Gem
|
2
|
-
|
3
|
-
on:
|
4
|
-
release:
|
5
|
-
types: [published]
|
6
|
-
|
7
|
-
jobs:
|
8
|
-
publish_gem:
|
9
|
-
runs-on: ubuntu-latest
|
10
|
-
steps:
|
11
|
-
- uses: actions/checkout@v2
|
12
|
-
- name: Setup
|
13
|
-
uses: ruby/setup-ruby@v1
|
14
|
-
with:
|
15
|
-
ruby-version: 2.7
|
16
|
-
- name: Install Dependencies
|
17
|
-
run: bundle install
|
18
|
-
- name: Publish Gem
|
19
|
-
run: |
|
20
|
-
mkdir -p $HOME/.gem
|
21
|
-
touch $HOME/.gem/credentials
|
22
|
-
chmod 0600 $HOME/.gem/credentials
|
23
|
-
printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
|
24
|
-
gem build *.gemspec
|
25
|
-
gem push *.gem
|
26
|
-
env:
|
27
|
-
GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
|
data/.gitignore
DELETED
data/CHANGELOG.md
DELETED
@@ -1,148 +0,0 @@
|
|
1
|
-
## [**5.4.6**](https://github.com/lob/lob-ruby/releases/tag/v5.4.6) (2022-01-25)
|
2
|
-
- [**206**](https://github/com/lob/lob-ruby/pull/206) added additional parsing to make sure we can pass hashes into bulk verify methods
|
3
|
-
## [**5.4.5**](https://github.com/lob/lob-ruby/releases/tag/v5.4.5) (2022-01-11)
|
4
|
-
- [**203**](https://github.com/lob/lob-ruby/pull/203) Pass through proxy to rest-client if supplied
|
5
|
-
## [**5.4.4**](https://github.com/lob/lob-ruby/releases/tag/v5.4.4) (2021-12-16)
|
6
|
-
- [**202**](https://github.com/lob/lob-ruby/pull/202) Fix for coveralls API for GH actions and fix for error in resource_base.rb
|
7
|
-
## [**5.4.3**](https://github.com/lob/lob-ruby/releases/tag/v5.4.3) (2021-12-15)
|
8
|
-
- [**199**](https://github.com/lob/lob-ruby/pull/199) Refactor ResourceBase to make the options sent to rest-client more configurable
|
9
|
-
## [**5.4.2**](https://github.com/lob/lob-ruby/releases/tag/v5.4.2) (2021-12-08)
|
10
|
-
- [**198**](https://github.com/lob/lob-ruby/pull/198) specified ruby version in publish action
|
11
|
-
- [**195**](https://github.com/lob/lob-ruby/pull/195) added links to example scripts in README file & gh actions to release
|
12
|
-
## [**5.4.1**](https://github.com/lob/lob-ruby/releases/tag/v5.4.1) (2021-09-28)
|
13
|
-
- [**193**](https://github.com/lob/lob-ruby/pull/193) Minor patches
|
14
|
-
## [**5.4.0**](https://github.com/lob/lob-ruby/releases/tag/v5.4.0) (2021-09-21)
|
15
|
-
- [**191**](https://github.com/lob/lob-ruby/pull/191) Add support for reverse geocoding endpoint
|
16
|
-
## [**5.3.0**](https://github.com/lob/lob-ruby/releases/tag/v5.3.0) (2021-08-25)
|
17
|
-
- [**190**](https://github.com/lob/lob-ruby/pull/190) Adds support for bulk AV endpoints
|
18
|
-
## [**5.2.0**](https://github.com/lob/lob-ruby/releases/tag/v5.2.0) (2021-05-03)
|
19
|
-
- [**188**](https://github.com/lob/lob-ruby/pull/188) Adds support for Self Mailers
|
20
|
-
## 5.1.2 (2021-02-18)
|
21
|
-
|
22
|
-
##### Chores and Bug Fixes
|
23
|
-
|
24
|
-
- [**185**](https://github.com/lob/lob-ruby/pull/185) Bumps rake to 12.3.3, adds Ruby 2.7, update example asset links, other cleanup.
|
25
|
-
## 5.1.1 (2020-05-21)
|
26
|
-
|
27
|
-
##### Chores
|
28
|
-
|
29
|
-
* **intl-verification:** update international verifications test mode fix ([#179](https://github.com/lob/lob-ruby/pull/179)) ([4ab7e7e2](https://github.com/lob/lob-ruby/commit/4ab7e7e2852706c37b00bd8f2df58207897bc0a3))
|
30
|
-
|
31
|
-
##### Bug Fixes
|
32
|
-
|
33
|
-
* **merge-variables:** convert to json ([fa93885f](https://github.com/lob/lob-ruby/commit/fa93885f2aab4537e100b82d8a9f53cdec042f2e))
|
34
|
-
|
35
|
-
## [**5.1.0**](https://github.com/lob/lob-ruby/releases/tag/v5.1.0)
|
36
|
-
- [**176**](https://github.com/lob/lob-ruby/pull/176) Adds support for Group Members (beta feature)
|
37
|
-
- [**175**](https://github.com/lob/lob-ruby/pull/175) Adds support for Groups (beta feature)
|
38
|
-
- [**174**](https://github.com/lob/lob-ruby/pull/174) Add Ruby 2.5-6, remove API keys, other cleanup
|
39
|
-
- [**173**](https://github.com/lob/lob-ruby/pull/173) Update example asset links
|
40
|
-
|
41
|
-
## 5.0.0
|
42
|
-
|
43
|
-
Version 5.0.0 introduces a breaking change. It removes support for the area mail resources (`Areas` and `Routes`).
|
44
|
-
|
45
|
-
* Removes `Lob.areas`.
|
46
|
-
* Removes `Lob.routes`.
|
47
|
-
|
48
|
-
## [**4.3.0**](https://github.com/lob/lob-ruby/releases/tag/v4.3.0)
|
49
|
-
- [**171**](https://github.com/lob/lob-ruby/pull/171) add USAutocompletions
|
50
|
-
- [**170**](https://github.com/lob/lob-ruby/pull/170) Fix test name
|
51
|
-
|
52
|
-
## [**4.2.0**](https://github.com/lob/lob-ruby/releases/tag/v4.2.0)
|
53
|
-
- [**169**](https://github.com/lob/lob-ruby/pull/169) Support 'case' param for us_verifications
|
54
|
-
- [**168**](https://github.com/lob/lob-ruby/pull/168) tweak wording around handling numbers with leading zeros
|
55
|
-
- [**167**](https://github.com/lob/lob-ruby/pull/167) remove duplicate test
|
56
|
-
- [**166**](https://github.com/lob/lob-ruby/pull/166) Fix commented check amount in checks.rb example
|
57
|
-
|
58
|
-
## [**4.1.2**](https://github.com/lob/lob-ruby/releases/tag/v4.1.2)
|
59
|
-
- [**#165**] (https://github.com/lob/lob-ruby/pull/165) Remove states and countries API resources. Also remove the ability to use postcard.message.
|
60
|
-
|
61
|
-
## [**4.1.1**](https://github.com/lob/lob-ruby/releases/tag/v4.1.1)
|
62
|
-
- [**#160**] (https://github.com/lob/lob-ruby/pull/160) adds capability to pass in idempotency headers
|
63
|
-
|
64
|
-
## [**4.1.0**](https://github.com/lob/lob-ruby/releases/tag/v4.1.0)
|
65
|
-
- [**#158**] (https://github.com/lob/lob-ruby/pull/158) add US Zip Lookups API endpoint to wrapper
|
66
|
-
|
67
|
-
## 4.0.0
|
68
|
-
|
69
|
-
Version 4.0.0 introduces a breaking change. It requires a minimum API version of `2017-05-17`, which introduces new US and International Verification APIs.
|
70
|
-
|
71
|
-
* Removes `Lob.addresses.verify()`. Please use `Lob.us_verifications.verify()` and `Lob.intl_verifications.verify() instead.
|
72
|
-
|
73
|
-
## 3.0.0
|
74
|
-
|
75
|
-
Version 3.0.0 introduces several breaking changes. It requires a minimum API version of `2015-04-11`.
|
76
|
-
|
77
|
-
* Ruby 1.9.3 is no longer supported. lob-ruby now supports Ruby versions at or above 2.0.0.
|
78
|
-
* Jobs and Objects resources have been deprecated from the gem.
|
79
|
-
* Resources have been moved from `Lob::V1` to the `Lob::Resources` namespace and have been refactored to contain the HTTP request/response logic..
|
80
|
-
* Configuration for the Lob Client has been changed. `Lob()`, `Lob.load`, and `Lob.configure` have all been deprecated and replaced with a single method of configuration: `Lob::Client.new(api_key: "your-api-key")`.
|
81
|
-
|
82
|
-
## [**2.5.1**](https://github.com/lob/lob-ruby/releases/tag/v2.5.1)
|
83
|
-
- [**#145**] (https://github.com/lob/lob-ruby/pull/145) More lenient rest-client version restriction
|
84
|
-
|
85
|
-
## [**2.5.0**](https://github.com/lob/lob-ruby/releases/tag/v2.5.0)
|
86
|
-
- [**#140**] (https://github.com/lob/lob-ruby/pull/140) Adds access to response and headers
|
87
|
-
|
88
|
-
## [**2.4.0**](https://github.com/lob/lob-ruby/releases/tag/v2.4.0)
|
89
|
-
- [**#136**] (https://github.com/lob/lob-ruby/pull/136) Adds find to routes
|
90
|
-
|
91
|
-
## [**2.3.0**](https://github.com/lob/lob-ruby/releases/tag/v2.3.0)
|
92
|
-
- [**#130**] (https://github.com/lob/lob-ruby/pull/130) Removed services endpoint support
|
93
|
-
|
94
|
-
## [**2.2.0**](https://github.com/lob/lob-ruby/releases/tag/v2.2.0)
|
95
|
-
- [**#129**] (https://github.com/lob/lob-ruby/pull/129) Adds support for API version 2015-11-06
|
96
|
-
|
97
|
-
## [**2.1.2**](https://github.com/lob/lob-ruby/releases/tag/v2.1.2)
|
98
|
-
- [**#127**] (https://github.com/lob/lob-ruby/pull/127) Ensure JSON.parse is never passes nil
|
99
|
-
|
100
|
-
## [**2.1.1**](https://github.com/lob/lob-ruby/releases/tag/v2.1.1)
|
101
|
-
- [**#124**] (https://github.com/lob/lob-ruby/pull/124) routes#find accepts single ZIP code
|
102
|
-
|
103
|
-
## [**2.1.0**](https://github.com/lob/lob-ruby/releases/tag/v2.1.0)
|
104
|
-
- [**#119**] (https://github.com/lob/lob-ruby/pull/119) better error messages
|
105
|
-
|
106
|
-
## [**2.0.1**](https://github.com/lob/lob-ruby/releases/tag/v2.0.1)
|
107
|
-
- [**#118**] (https://github.com/lob/lob-ruby/pull/118) removed prawn and fixed examples
|
108
|
-
|
109
|
-
## 2.0.0
|
110
|
-
|
111
|
-
Version 2.0.0 introduces several breaking changes. It requires a minimum API version of `2015-04-11`.
|
112
|
-
|
113
|
-
* The lob-ruby gem no longer converts `city`, `state`, etc. parameters into `address_city`, `address_state`, etc. This change was made to be more consistent with the API and other Lob wrappers, and to prevent confusion.
|
114
|
-
* The wrapper now returns the raw JSON from the API in all `list` endpoints rather than just the `data` field in the response. This will allow access to additional fields like `count` and `offset`.
|
115
|
-
* The `packagings` endpoint is not longer supporter in the API, and therefore has been taken out of lob-ruby.
|
116
|
-
|
117
|
-
In addition to these breaking changes, the test suite was cleaned up by removing the unnecessary VCR gem and committing sample upload files to the repository rather than downloading them in rake task.
|
118
|
-
|
119
|
-
## [**1.13.0**](https://github.com/lob/lob-ruby/releases/tag/v1.13.0)
|
120
|
-
- [**#112**] (https://github.com/lob/lob-ruby/pull/112) removes Rack dependency
|
121
|
-
|
122
|
-
## [**1.12.0**](https://github.com/lob/lob-ruby/releases/tag/v1.12.0)
|
123
|
-
- [**#110**] (https://github.com/lob/lob-ruby/pull/110) fixes metadata filter
|
124
|
-
|
125
|
-
## [**1.10.0**](https://github.com/lob/lob-ruby/releases/tag/v1.10.0)
|
126
|
-
- [**#100**] (https://github.com/lob/lob-ruby/pull/100) adds support for Simple Letter Service
|
127
|
-
|
128
|
-
## [**1.9.2**](https://github.com/lob/lob-ruby/releases/tag/v1.9.2)
|
129
|
-
- [**#94**] (https://github.com/lob/lob-ruby/pull/94) added bank account verify support
|
130
|
-
|
131
|
-
## [**1.9.1**](https://github.com/lob/lob-ruby/releases/tag/v1.9.1)
|
132
|
-
- [**#92**] (https://github.com/lob/lob-ruby/pull/92) don't fix prawn version
|
133
|
-
|
134
|
-
## [**1.9**](https://github.com/lob/lob-ruby/releases/tag/v1.9.0)
|
135
|
-
- [**#88**] (https://github.com/lob/lob-ruby/pull/88) default prawn to 1.3.0 for ruby 1.9.3
|
136
|
-
- [**#91**] (https://github.com/lob/lob-ruby/pull/91) reduce strictness of rest-client version
|
137
|
-
|
138
|
-
## [**1.8**](https://github.com/lob/lob-ruby/releases/tag/v1.8)
|
139
|
-
- [**#69**] (https://github.com/lob/lob-ruby/pull/69) fixed spelling in documentation
|
140
|
-
- [**#71**] (https://github.com/lob/lob-ruby/pull/71) fixed syntax in documentation
|
141
|
-
- [**#73**] (https://github.com/lob/lob-ruby/pull/73) fixed failing tests
|
142
|
-
- [**#74**] (https://github.com/lob/lob-ruby/pull/74) added support for setting api_version
|
143
|
-
- [**#75**] (https://github.com/lob/lob-ruby/pull/75) added version module
|
144
|
-
- [**#76**] (https://github.com/lob/lob-ruby/pull/76) better error handling
|
145
|
-
|
146
|
-
|
147
|
-
## [**1.7**](https://github.com/lob/lob-ruby/releases/tag/v1.7)
|
148
|
-
- [**#64**] (https://github.com/lob/lob-ruby/pull/64) changed asset URLs to use lob-assets bucket
|
data/CONTRIBUTING.md
DELETED
@@ -1,19 +0,0 @@
|
|
1
|
-
# How to contribute
|
2
|
-
|
3
|
-
We welcome contributions from the community and are pleased to have them. Please follow this guide when logging issues or making code changes.
|
4
|
-
|
5
|
-
Make sure you have Ruby 2.0 installed. Copy and paste the following commands in your projects directory.
|
6
|
-
|
7
|
-
git clone https://github.com/lob/lob-ruby.git
|
8
|
-
cd lob-ruby
|
9
|
-
bundle install
|
10
|
-
|
11
|
-
## Contributing Instructions
|
12
|
-
|
13
|
-
1. Fork it
|
14
|
-
2. Create your feature branch (`git checkout -b my-new-feature`)
|
15
|
-
3. Commit your changes (`git commit -am 'Add some feature'`)
|
16
|
-
4. Push to the branch (`git push origin my-new-feature`)
|
17
|
-
5. Make sure the tests pass
|
18
|
-
6. Open up coverage/index.html in your browser and add tests if required
|
19
|
-
7. Create new Pull Request
|
data/LICENSE.txt
DELETED
@@ -1,22 +0,0 @@
|
|
1
|
-
Copyright (c) 2013 Lob.com
|
2
|
-
|
3
|
-
MIT License
|
4
|
-
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
-
a copy of this software and associated documentation files (the
|
7
|
-
"Software"), to deal in the Software without restriction, including
|
8
|
-
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
-
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
-
permit persons to whom the Software is furnished to do so, subject to
|
11
|
-
the following conditions:
|
12
|
-
|
13
|
-
The above copyright notice and this permission notice shall be
|
14
|
-
included in all copies or substantial portions of the Software.
|
15
|
-
|
16
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
-
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
-
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
-
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
-
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/examples/README.md
DELETED
@@ -1,119 +0,0 @@
|
|
1
|
-
# Ruby Examples
|
2
|
-
|
3
|
-
Here we have put together a handful of ruby examples to help get you started. Please read through the official [API Documentation](https://docs.lob.com) to get a complete sense of what to expect from each endpoint. As always, feel free to [contact us](https://lob.com/support) directly if you have any questions on implementation. Thank you for using Lob!
|
4
|
-
|
5
|
-
To run these example commands, make sure you have a supported version of Ruby installed, including all the necessary gems.
|
6
|
-
|
7
|
-
## [/csv_checks/](./csv_checks/)
|
8
|
-
|
9
|
-
An example showing how to dynamically create checks from a CSV using HTML, merge variables, and Lob's [Checks API](https://lob.com/services/checks).
|
10
|
-
|
11
|
-
```
|
12
|
-
bundle exec ruby examples/csv_checks/create_checks.rb
|
13
|
-
```
|
14
|
-
|
15
|
-
## [/csv_letters/](./csv_letters/)
|
16
|
-
|
17
|
-
An example showing how to dynamically create letters from a CSV using HTML, a custom font, merge variables, and Lob's [Letters API](https://lob.com/services/letters).
|
18
|
-
|
19
|
-
```
|
20
|
-
bundle exec ruby examples/csv_letters/create_letters.rb
|
21
|
-
```
|
22
|
-
|
23
|
-
## [/csv_postcards/](./csv_postcards/)
|
24
|
-
|
25
|
-
An example showing how to dynamically create postcards from a CSV using HTML, a custom font, merge variables, and Lob's [Postcards API](https://lob.com/services/postcards).
|
26
|
-
|
27
|
-
```
|
28
|
-
bundle exec ruby examples/csv_postcards/create_postcards.rb
|
29
|
-
```
|
30
|
-
|
31
|
-
## [/csv_verify/](./csv_verify/)
|
32
|
-
|
33
|
-
An example showing how to validate and cleanse a CSV spreadsheet full of shipping addresses using Lob's [US Verification API](https://lob.com/services/verifications).
|
34
|
-
|
35
|
-
Please note that if you are running this with a Test API Key, the verification API will always return [a dummy address](https://docs.lob.com/#section/US-Verifications-Test-Env).
|
36
|
-
|
37
|
-
```
|
38
|
-
bundle exec ruby examples/csv_verify/verify.rb
|
39
|
-
```
|
40
|
-
|
41
|
-
## [/cards.rb](./cards.rb)
|
42
|
-
|
43
|
-
An example showing how to create a card using Lob's [Cards API](https://docs.lob.com/#tag/Cards).
|
44
|
-
|
45
|
-
```
|
46
|
-
bundle exec ruby examples/cards.rb
|
47
|
-
```
|
48
|
-
|
49
|
-
## [/checks.rb](./checks.rb)
|
50
|
-
|
51
|
-
An example showing how to create a check using Lob's [Checks API](https://lob.com/services/checks).
|
52
|
-
|
53
|
-
```
|
54
|
-
bundle exec ruby examples/checks.rb
|
55
|
-
```
|
56
|
-
|
57
|
-
## [/letters.rb](./letters.rb)
|
58
|
-
|
59
|
-
An example showing how to create a letter using Lob's [Letters API](https://lob.com/services/letters).
|
60
|
-
|
61
|
-
```
|
62
|
-
bundle exec ruby examples/letters.rb
|
63
|
-
```
|
64
|
-
|
65
|
-
## [/postcards.rb](./postcards.rb)
|
66
|
-
|
67
|
-
An example showing how to create a postcard using Lob's [Postcards API](https://lob.com/services/postcards).
|
68
|
-
|
69
|
-
```
|
70
|
-
bundle exec ruby examples/postcards.rb
|
71
|
-
```
|
72
|
-
|
73
|
-
## [/postcards_idempotent.rb](./postcards_idempotent.rb)
|
74
|
-
|
75
|
-
An example showing how to create an idempotent postcard request using Lob's [Postcards API](https://lob.com/services/postcards).
|
76
|
-
|
77
|
-
```
|
78
|
-
bundle exec ruby examples/postcards_idempotent.rb
|
79
|
-
```
|
80
|
-
|
81
|
-
## [/postcards_intl.rb](./postcards_intl.rb)
|
82
|
-
|
83
|
-
An example showing how to create an international postcard using Lob's [Postcards API](https://lob.com/services/postcards).
|
84
|
-
|
85
|
-
```
|
86
|
-
bundle exec ruby examples/postcards_intl.rb
|
87
|
-
```
|
88
|
-
|
89
|
-
## [/postcards_remote.rb](./postcards_remote.rb)
|
90
|
-
|
91
|
-
An example showing how to create a postcard with remote files, using Lob's [Postcards API](https://lob.com/services/postcards).
|
92
|
-
|
93
|
-
```
|
94
|
-
bundle exec ruby examples/postcards_remote.rb
|
95
|
-
```
|
96
|
-
|
97
|
-
## [/postcards_send_date.rb](./postcards_send_date.rb)
|
98
|
-
|
99
|
-
An example showing how to create a postcard with a specified send date, using Lob's [Postcards API](https://lob.com/services/postcards).
|
100
|
-
|
101
|
-
```
|
102
|
-
bundle exec ruby examples/postcards_send_date.rb
|
103
|
-
```
|
104
|
-
|
105
|
-
## [/postcards_template.rb](./postcards_template.rb)
|
106
|
-
|
107
|
-
An example showing how to create a postcard with a saved template, using Lob's [Postcards API](https://lob.com/services/postcards).
|
108
|
-
|
109
|
-
```
|
110
|
-
bundle exec ruby examples/postcards_template.rb
|
111
|
-
```
|
112
|
-
|
113
|
-
## [/self_mailers.rb](./self_mailers.rb)
|
114
|
-
|
115
|
-
An example showing how to create a self mailer using Lob's Self Mailers API.
|
116
|
-
|
117
|
-
```
|
118
|
-
bundle exec ruby examples/self_mailers.rb
|
119
|
-
```
|
data/examples/cards.rb
DELETED
@@ -1,51 +0,0 @@
|
|
1
|
-
$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
|
2
|
-
require 'lob.rb'
|
3
|
-
require 'pp'
|
4
|
-
|
5
|
-
# initialize Lob object
|
6
|
-
LOB_LIVE_API_KEY = ENV['LOB_LIVE_API_KEY']
|
7
|
-
lob = Lob::Client.new(api_key: LOB_LIVE_API_KEY)
|
8
|
-
|
9
|
-
front_template = 'https://s3-us-west-2.amazonaws.com/public.lob.com/assets/card_horizontal.pdf'
|
10
|
-
back_template = 'https://s3-us-west-2.amazonaws.com/public.lob.com/assets/card_horizontal.pdf'
|
11
|
-
|
12
|
-
# create a card
|
13
|
-
pp lob.cards.create(
|
14
|
-
front: front_template, # required
|
15
|
-
back: back_template, # optional; default: 'https://s3.us-west-2.amazonaws.com/public.lob.com/assets/card_blank_horizontal.pdf'
|
16
|
-
description: 'Test Card', # optional
|
17
|
-
size: '2.125x3.375' # optional, default: '2.125x3.375'
|
18
|
-
)
|
19
|
-
|
20
|
-
# find a card
|
21
|
-
card_id = 'YOUR_CARD_ID'
|
22
|
-
pp lob.cards.find(
|
23
|
-
card_id # required
|
24
|
-
)
|
25
|
-
|
26
|
-
# update a card
|
27
|
-
card_id = 'YOUR_CARD_ID'
|
28
|
-
pp lob.cards.update(
|
29
|
-
card_id, # required
|
30
|
-
{ description: 'Updated Test Card Desc' }
|
31
|
-
)
|
32
|
-
|
33
|
-
# delete a card
|
34
|
-
card_id = 'YOUR_CARD_ID'
|
35
|
-
pp lob.cards.destroy(
|
36
|
-
card_id # required
|
37
|
-
)
|
38
|
-
|
39
|
-
# create a card order
|
40
|
-
card_id = 'YOUR_CARD_ID'
|
41
|
-
pp lob.cards.create_order(
|
42
|
-
card_id, # required
|
43
|
-
{ quantity: 10000 } # required
|
44
|
-
)
|
45
|
-
|
46
|
-
# List orders for a given card a card order
|
47
|
-
card_id = 'YOUR_CARD_ID'
|
48
|
-
pp lob.cards.list_orders(
|
49
|
-
card_id # required
|
50
|
-
)
|
51
|
-
|
data/examples/checks.rb
DELETED
@@ -1,49 +0,0 @@
|
|
1
|
-
$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
|
2
|
-
require 'lob'
|
3
|
-
require 'pp'
|
4
|
-
|
5
|
-
# initialize Lob object
|
6
|
-
lob = Lob::Client.new(api_key: 'YOUR_API_KEY')
|
7
|
-
|
8
|
-
# create an address
|
9
|
-
to_address = lob.addresses.create(
|
10
|
-
name: "John Doe",
|
11
|
-
address_line1: "104 Printing Boulevard",
|
12
|
-
address_city: "Boston",
|
13
|
-
address_state: "MA",
|
14
|
-
address_country: "US",
|
15
|
-
address_zip: "12345"
|
16
|
-
)
|
17
|
-
|
18
|
-
# create a from address
|
19
|
-
from_address = lob.addresses.create(
|
20
|
-
name: "Jane Doe",
|
21
|
-
address_line1: "123 Hello Ave",
|
22
|
-
address_city: "Providence",
|
23
|
-
address_state: "RI",
|
24
|
-
address_country: "US",
|
25
|
-
address_zip: "02912"
|
26
|
-
)
|
27
|
-
|
28
|
-
# create a bank account
|
29
|
-
bank_account = lob.bank_accounts.create(
|
30
|
-
routing_number: "322271627",
|
31
|
-
account_number: "123456789",
|
32
|
-
account_type: "company",
|
33
|
-
signatory: "John Doe"
|
34
|
-
)
|
35
|
-
|
36
|
-
pp bank_account
|
37
|
-
lob.bank_accounts.verify(bank_account['id'], amounts: [23, 12])
|
38
|
-
|
39
|
-
# send a $100 check using an already created bank and address
|
40
|
-
pp lob.checks.create(
|
41
|
-
description: "Test Check",
|
42
|
-
check_number: "10000",
|
43
|
-
bank_account: bank_account["id"],
|
44
|
-
to: to_address["id"],
|
45
|
-
from: from_address["id"],
|
46
|
-
amount: 100,
|
47
|
-
memo: "This is my first Check",
|
48
|
-
message: "This check is for laundry"
|
49
|
-
)
|
@@ -1,48 +0,0 @@
|
|
1
|
-
$:.unshift File.expand_path("../../lib", File.dirname(__FILE__))
|
2
|
-
require 'lob'
|
3
|
-
require 'csv'
|
4
|
-
require 'pp'
|
5
|
-
|
6
|
-
# Initialize Lob object
|
7
|
-
lob = Lob::Client.new(api_key: 'YOUR_API_KEY')
|
8
|
-
|
9
|
-
# Create a bank account
|
10
|
-
bank_account = lob.bank_accounts.create(
|
11
|
-
routing_number: "322271627",
|
12
|
-
account_number: "123456789",
|
13
|
-
account_type: "company",
|
14
|
-
signatory: "John Doe"
|
15
|
-
)
|
16
|
-
|
17
|
-
puts bank_account
|
18
|
-
|
19
|
-
# Verify bank account
|
20
|
-
lob.bank_accounts.verify(bank_account['id'], amounts: [23, 12])
|
21
|
-
|
22
|
-
# Parse the CSV and create the checks
|
23
|
-
CSV.foreach(File.expand_path('../input.csv', __FILE__)) do |row|
|
24
|
-
check = lob.checks.create(
|
25
|
-
description: 'CSV Test',
|
26
|
-
bank_account: bank_account["id"],
|
27
|
-
to: {
|
28
|
-
name: row[0],
|
29
|
-
address_line1: row[1],
|
30
|
-
address_line2: row[2],
|
31
|
-
address_city: row[3],
|
32
|
-
address_state: row[4],
|
33
|
-
address_zip: row[5],
|
34
|
-
address_country: row[6]
|
35
|
-
},
|
36
|
-
from: {
|
37
|
-
name: 'Lob',
|
38
|
-
address_line1: '123 Main Street',
|
39
|
-
address_city: 'San Francisco',
|
40
|
-
address_state: 'CA',
|
41
|
-
address_zip: '94185',
|
42
|
-
address_country: 'US'
|
43
|
-
},
|
44
|
-
amount: row[7],
|
45
|
-
memo: "For travel reimbursement"
|
46
|
-
)
|
47
|
-
pp check['url']
|
48
|
-
end
|
@@ -1,6 +0,0 @@
|
|
1
|
-
Pallavi,353 King Street,Apt. 432,San Francisco,CA,94158,US,600.00
|
2
|
-
Dom,456 Oak Street,Apt. 102,San Francisco,CA,94185,US,500.00
|
3
|
-
Kyle,123 Test Street,Apt. 101,San Francisco,CA,94105,US,400.00
|
4
|
-
Kienan,789 Elm Street,Apt. 101,San Francisco,CA,94107,US,300.00
|
5
|
-
Sid,111 Washington Street,Apt. 101,San Francisco,CA,94112,US,200.00
|
6
|
-
Will,888 Jefferson Street,Apt. 101,San Francisco,CA,94197,US,100.00
|
@@ -1,41 +0,0 @@
|
|
1
|
-
$:.unshift File.expand_path("../../lib", File.dirname(__FILE__))
|
2
|
-
require 'lob'
|
3
|
-
require 'csv'
|
4
|
-
require 'pp'
|
5
|
-
|
6
|
-
# Initialize Lob object
|
7
|
-
lob = Lob::Client.new(api_key: 'YOUR_API_KEY')
|
8
|
-
|
9
|
-
# Load the HTML from letter_template.html
|
10
|
-
letter_html = File.open(File.expand_path('../letter_template.html', __FILE__)).read
|
11
|
-
|
12
|
-
# Parse the CSV and create the letters.
|
13
|
-
CSV.foreach(File.expand_path('../input.csv', __FILE__)) do |row|
|
14
|
-
letter = lob.letters.create(
|
15
|
-
description: 'CSV Test',
|
16
|
-
to: {
|
17
|
-
name: row[0],
|
18
|
-
address_line1: row[1],
|
19
|
-
address_line2: row[2],
|
20
|
-
address_city: row[3],
|
21
|
-
address_state: row[4],
|
22
|
-
address_zip: row[5],
|
23
|
-
address_country: row[6]
|
24
|
-
},
|
25
|
-
from: {
|
26
|
-
name: 'Lob',
|
27
|
-
address_line1: '123 Main Street',
|
28
|
-
address_city: 'San Francisco',
|
29
|
-
address_state: 'CA',
|
30
|
-
address_zip: '94185',
|
31
|
-
address_country: 'US'
|
32
|
-
},
|
33
|
-
file: letter_html,
|
34
|
-
merge_variables: {
|
35
|
-
name: row[0],
|
36
|
-
city: row[3]
|
37
|
-
},
|
38
|
-
color: false
|
39
|
-
)
|
40
|
-
pp letter['url']
|
41
|
-
end
|
@@ -1,6 +0,0 @@
|
|
1
|
-
Pallavi,353 King Street,Apt. 432,San Francisco,CA,94158,US
|
2
|
-
Dom,456 Oak Street ,Apt. 102,San Francisco,CA,94185,US
|
3
|
-
Kyle,123 Test Street,Apt. 101,San Francisco,CA,94105,US
|
4
|
-
Kienan,789 Elm Street,Apt. 101,San Francisco,CA,94107,US
|
5
|
-
Sid,111 Washington Street,Apt. 101,San Francisco,CA,94112,US
|
6
|
-
Will,888 Jefferson Street,Apt. 101,San Francisco,CA,94197,US
|
@@ -1,33 +0,0 @@
|
|
1
|
-
<html>
|
2
|
-
<head>
|
3
|
-
<style>
|
4
|
-
*, *:before, *:after {
|
5
|
-
-webkit-box-sizing: border-box;
|
6
|
-
-moz-box-sizing: border-box;
|
7
|
-
box-sizing: border-box;
|
8
|
-
}
|
9
|
-
|
10
|
-
@font-face {
|
11
|
-
font-family: 'Loved by the King';
|
12
|
-
font-style: normal;
|
13
|
-
font-weight: 400;
|
14
|
-
src: url('https://s3-us-west-2.amazonaws.com/public.lob.com/fonts/lovedByTheKing/LovedbytheKing.ttf') format('truetype');
|
15
|
-
}
|
16
|
-
|
17
|
-
.text {
|
18
|
-
margin-left: 75px;
|
19
|
-
padding-top: 250px;
|
20
|
-
width: 400px;
|
21
|
-
font-family: 'Loved by the King';
|
22
|
-
font-size: 50px;
|
23
|
-
font-weight: 700;
|
24
|
-
color: black;
|
25
|
-
}
|
26
|
-
</style>
|
27
|
-
</head>
|
28
|
-
|
29
|
-
<body>
|
30
|
-
<p class="text">Hello {{name}}!<br/><br/>Join us for this year's summer celebration in {{city}}!</p>
|
31
|
-
</body>
|
32
|
-
|
33
|
-
</html>
|