lob 5.1.0 → 6.0.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- 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 -154
- 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 +107 -13
- metadata +452 -140
- data/.gitignore +0 -18
- data/.travis.yml +0 -16
- data/CHANGELOG.md +0 -114
- data/CONTRIBUTING.md +0 -19
- data/LICENSE.txt +0 -22
- data/examples/README.md +0 -33
- data/examples/checks.rb +0 -48
- data/examples/csv_checks/create_checks.rb +0 -47
- data/examples/csv_checks/input.csv +0 -6
- data/examples/csv_letters/create_letters.rb +0 -40
- 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 -45
- 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 -36
- data/examples/letters.rb +0 -72
- data/examples/postcards.rb +0 -86
- data/lib/lob/client.rb +0 -71
- 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/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 -139
- data/lib/lob/resources/us_autocompletions.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 -28
- 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/check_spec.rb +0 -98
- data/spec/lob/resources/group_spec.rb +0 -50
- data/spec/lob/resources/intl_verifications_spec.rb +0 -28
- data/spec/lob/resources/letter_spec.rb +0 -94
- data/spec/lob/resources/member_spec.rb +0 -65
- data/spec/lob/resources/postcard_spec.rb +0 -135
- data/spec/lob/resources/resource_base_spec.rb +0 -75
- data/spec/lob/resources/us_autocompletions_spec.rb +0 -24
- 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/postcardback.pdf +2 -2287
- data/spec/samples/postcardfront.pdf +1 -1549
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
# TemplateVersion.spec.rb
|
|
2
|
+
require_relative '../TestFixtures'
|
|
3
|
+
include Lob
|
|
4
|
+
$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
|
|
5
|
+
require 'uri'
|
|
6
|
+
|
|
7
|
+
RSpec.describe "TemplateVersionsApi" do
|
|
8
|
+
it "can be instantiated" do
|
|
9
|
+
templateVersionApi = TemplateVersionsApi.new()
|
|
10
|
+
|
|
11
|
+
expect(templateVersionApi).not_to be_nil
|
|
12
|
+
expect(templateVersionApi).to be_a_kind_of(TemplateVersionsApi)
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
describe "Create" do
|
|
16
|
+
before(:all) do
|
|
17
|
+
api = TestFixtures.api_client_with_test_key()
|
|
18
|
+
@templateVersionApi = TemplateVersionsApi.new(api)
|
|
19
|
+
@templateApi = TemplatesApi.new(api)
|
|
20
|
+
|
|
21
|
+
templateWritable = TemplateWritable.new({
|
|
22
|
+
description: "Ruby Integration Test",
|
|
23
|
+
html: "<html>Updated HTML for Ruby Integration Test</html>"
|
|
24
|
+
})
|
|
25
|
+
|
|
26
|
+
createdTemplate = @templateApi.create(templateWritable)
|
|
27
|
+
@tmplId = createdTemplate.id
|
|
28
|
+
|
|
29
|
+
@templateVersionWritable = TemplateVersionWritable.new({
|
|
30
|
+
description: "Ruby Integration Test Template Version 1",
|
|
31
|
+
html: "<html>Updated HTML for Ruby Integration Test template version 1</html>"
|
|
32
|
+
})
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
it "creates a new template version" do
|
|
36
|
+
createdTemplateVersion = @templateVersionApi.create(@tmplId, @templateVersionWritable)
|
|
37
|
+
expect(createdTemplateVersion.id).not_to be_nil
|
|
38
|
+
|
|
39
|
+
# delete it in the end
|
|
40
|
+
@templateVersionApi.delete(@tmplId, createdTemplateVersion.id)
|
|
41
|
+
@templateApi.delete(@tmplId)
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
it "handles errors returned by the api" do
|
|
45
|
+
templateVersionWritable = TemplateVersionWritable.new()
|
|
46
|
+
begin
|
|
47
|
+
response = @templateVersionApi.create(@tmplId, templateVersionWritable)
|
|
48
|
+
rescue => err
|
|
49
|
+
expect(err.message.include? "html is required").to be(true)
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
it "does not allow creation with invalid key" do
|
|
54
|
+
config = Lob::Configuration.default
|
|
55
|
+
config.username = "fake key"
|
|
56
|
+
badapi = Lob::ApiClient.new(config)
|
|
57
|
+
|
|
58
|
+
templateVersionApi = TemplateVersionsApi.new(badapi)
|
|
59
|
+
|
|
60
|
+
begin
|
|
61
|
+
response = templateVersionApi.create(@tmplId, @templateVersionWritable)
|
|
62
|
+
rescue => err
|
|
63
|
+
expect(err.message.include? "Your API key is not valid.").to be(true)
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
describe "Get" do
|
|
69
|
+
before(:all) do
|
|
70
|
+
api = TestFixtures.api_client_with_test_key()
|
|
71
|
+
@templateVersionApi = TemplateVersionsApi.new(api)
|
|
72
|
+
|
|
73
|
+
@templateApi = TemplatesApi.new(api)
|
|
74
|
+
|
|
75
|
+
templateWritable = TemplateWritable.new({
|
|
76
|
+
description: "Ruby Integration Test",
|
|
77
|
+
html: "<html>Updated HTML for Ruby Integration Test</html>"
|
|
78
|
+
})
|
|
79
|
+
|
|
80
|
+
createdTemplate = @templateApi.create(templateWritable)
|
|
81
|
+
@tmplId = createdTemplate.id
|
|
82
|
+
|
|
83
|
+
templateVersionWritable = TemplateVersionWritable.new({
|
|
84
|
+
description: "Ruby Integration Test Template Version 1",
|
|
85
|
+
html: "<html>Updated HTML for Ruby Integration Test template version 1</html>"
|
|
86
|
+
})
|
|
87
|
+
|
|
88
|
+
response = @templateVersionApi.create(@tmplId, templateVersionWritable)
|
|
89
|
+
@vrsnId = response.id
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
it "retrieves a template version" do
|
|
93
|
+
response = @templateVersionApi.get(@tmplId, @vrsnId)
|
|
94
|
+
|
|
95
|
+
expect(response).not_to be_nil()
|
|
96
|
+
expect(response.id).to eq(@vrsnId)
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
after(:all) do
|
|
100
|
+
@templateVersionApi.delete(@tmplId, @vrsnId)
|
|
101
|
+
@templateApi.delete(@tmplId)
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
describe "List" do
|
|
106
|
+
before(:all) do
|
|
107
|
+
api = TestFixtures.api_client_with_test_key()
|
|
108
|
+
@templateVersionApi = TemplateVersionsApi.new(api)
|
|
109
|
+
|
|
110
|
+
@templateApi = TemplatesApi.new(api)
|
|
111
|
+
|
|
112
|
+
templateWritable = TemplateWritable.new({
|
|
113
|
+
description: "Ruby Integration Test",
|
|
114
|
+
html: "<html>Updated HTML for Ruby Integration Test</html>"
|
|
115
|
+
})
|
|
116
|
+
|
|
117
|
+
createdTemplate = @templateApi.create(templateWritable)
|
|
118
|
+
@tmplId = createdTemplate.id
|
|
119
|
+
|
|
120
|
+
templateVersionWritable1 = TemplateVersionWritable.new({
|
|
121
|
+
description: "Ruby Integration Test Template Version 1",
|
|
122
|
+
html: "<html>Updated HTML for Ruby Integration Test template version 1</html>"
|
|
123
|
+
})
|
|
124
|
+
|
|
125
|
+
templateVersionWritable2 = TemplateVersionWritable.new({
|
|
126
|
+
description: "Ruby Integration Test Template Version 2",
|
|
127
|
+
html: "<html>Updated HTML for Ruby Integration Test template version 2</html>"
|
|
128
|
+
})
|
|
129
|
+
|
|
130
|
+
templateVersionWritable3 = TemplateVersionWritable.new({
|
|
131
|
+
description: "Ruby Integration Test Template Version 3",
|
|
132
|
+
html: "<html>Updated HTML for Ruby Integration Test template version 3</html>"
|
|
133
|
+
})
|
|
134
|
+
|
|
135
|
+
response1 = @templateVersionApi.create(@tmplId, templateVersionWritable1)
|
|
136
|
+
response2 = @templateVersionApi.create(@tmplId, templateVersionWritable2)
|
|
137
|
+
response3 = @templateVersionApi.create(@tmplId, templateVersionWritable3)
|
|
138
|
+
|
|
139
|
+
@vrsnId1 = response1.id
|
|
140
|
+
@vrsnId2 = response2.id
|
|
141
|
+
@vrsnId3 = response3.id
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
it "lists templates with limit, before, and after params" do
|
|
145
|
+
response = @templateVersionApi.list(@tmplId, { :"limit" => 2 })
|
|
146
|
+
|
|
147
|
+
expect(response.data.length()).to be == 2
|
|
148
|
+
first_tmpl_id = response.data[0].id
|
|
149
|
+
|
|
150
|
+
uri = URI.parse(response.next_url)
|
|
151
|
+
params = CGI.parse(uri.query)
|
|
152
|
+
|
|
153
|
+
response = @templateVersionApi.list(@tmplId, { :"limit" => 2, :"after" => params["after"][0] })
|
|
154
|
+
|
|
155
|
+
expect(response.data[0].id).not_to eq(first_tmpl_id)
|
|
156
|
+
|
|
157
|
+
uri = URI.parse(response.previous_url)
|
|
158
|
+
params = CGI.parse(uri.query)
|
|
159
|
+
|
|
160
|
+
response = @templateVersionApi.list(@tmplId, { :"limit" => 2, :"before" => params["before"][0] })
|
|
161
|
+
expect(response.data[0].id).to eq(first_tmpl_id)
|
|
162
|
+
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
[
|
|
166
|
+
[nil, nil, nil],
|
|
167
|
+
["include", Array.new(1, "total_count"), nil],
|
|
168
|
+
["date_created", nil, { "gt" => "2020-01-01" }],
|
|
169
|
+
].each do |which_param, include_param, date_created|
|
|
170
|
+
it "lists templates #{which_param && ("with " + which_param + " param")}" do
|
|
171
|
+
args = {}
|
|
172
|
+
|
|
173
|
+
if include_param then
|
|
174
|
+
args[:"include"] = include_param
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
if date_created then
|
|
178
|
+
args[:"date_created"] = date_created
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
response = @templateVersionApi.list(@tmplId, args)
|
|
182
|
+
|
|
183
|
+
expect(response.data.length()).to be > 0
|
|
184
|
+
|
|
185
|
+
if include_param
|
|
186
|
+
expect(response.total_count).to be
|
|
187
|
+
end
|
|
188
|
+
end
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
after(:all) do
|
|
192
|
+
@templateVersionApi.delete(@tmplId, @vrsnId1)
|
|
193
|
+
@templateVersionApi.delete(@tmplId, @vrsnId2)
|
|
194
|
+
@templateVersionApi.delete(@tmplId, @vrsnId3)
|
|
195
|
+
@templateApi.delete(@tmplId)
|
|
196
|
+
end
|
|
197
|
+
end
|
|
198
|
+
|
|
199
|
+
describe "Update" do
|
|
200
|
+
before(:all) do
|
|
201
|
+
api = TestFixtures.api_client_with_test_key()
|
|
202
|
+
@templateVersionApi = TemplateVersionsApi.new(api)
|
|
203
|
+
|
|
204
|
+
@templateApi = TemplatesApi.new(api)
|
|
205
|
+
|
|
206
|
+
templateWritable = TemplateWritable.new({
|
|
207
|
+
description: "Ruby Integration Test",
|
|
208
|
+
html: "<html>Updated HTML for Ruby Integration Test</html>"
|
|
209
|
+
})
|
|
210
|
+
|
|
211
|
+
createdTemplate = @templateApi.create(templateWritable)
|
|
212
|
+
@tmplId = createdTemplate.id
|
|
213
|
+
|
|
214
|
+
templateVersionWritable = TemplateVersionWritable.new({
|
|
215
|
+
description: "Ruby Integration Test",
|
|
216
|
+
html: "<html>Updated HTML for Ruby Integration Test</html>"
|
|
217
|
+
})
|
|
218
|
+
|
|
219
|
+
response = @templateVersionApi.create(@tmplId, templateVersionWritable)
|
|
220
|
+
@vrsnId = response.id
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
it "updates a template version" do
|
|
224
|
+
updatableTemplateVersion = TemplateVersionUpdatable.new({
|
|
225
|
+
description: "Updated template version for Ruby Integration Test"
|
|
226
|
+
})
|
|
227
|
+
|
|
228
|
+
updatedTemplateVersion = @templateVersionApi.update(@tmplId, @vrsnId, updatableTemplateVersion)
|
|
229
|
+
expect(updatedTemplateVersion.id).not_to be_nil
|
|
230
|
+
expect(updatedTemplateVersion.description).to eq("Updated template version for Ruby Integration Test")
|
|
231
|
+
|
|
232
|
+
# delete it in the end
|
|
233
|
+
@templateVersionApi.delete(@tmplId, @vrsnId)
|
|
234
|
+
@templateApi.delete(@tmplId)
|
|
235
|
+
end
|
|
236
|
+
end
|
|
237
|
+
|
|
238
|
+
describe "Delete" do
|
|
239
|
+
before(:all) do
|
|
240
|
+
api = TestFixtures.api_client_with_test_key()
|
|
241
|
+
@templateVersionApi = TemplateVersionsApi.new(api)
|
|
242
|
+
|
|
243
|
+
@templateApi = TemplatesApi.new(api)
|
|
244
|
+
|
|
245
|
+
templateWritable = TemplateWritable.new({
|
|
246
|
+
description: "Ruby Integration Test",
|
|
247
|
+
html: "<html>Updated HTML for Ruby Integration Test</html>"
|
|
248
|
+
})
|
|
249
|
+
|
|
250
|
+
createdTemplate = @templateApi.create(templateWritable)
|
|
251
|
+
@tmplId = createdTemplate.id
|
|
252
|
+
|
|
253
|
+
templateVersionWritable = TemplateVersionWritable.new({
|
|
254
|
+
description: "Ruby Integration Test",
|
|
255
|
+
html: "<html>Updated HTML for Ruby Integration Test</html>"
|
|
256
|
+
})
|
|
257
|
+
|
|
258
|
+
response = @templateVersionApi.create(@tmplId, templateVersionWritable)
|
|
259
|
+
@vrsnId = response.id
|
|
260
|
+
end
|
|
261
|
+
|
|
262
|
+
it "deletes a template version" do
|
|
263
|
+
response = @templateVersionApi.delete(@tmplId, @vrsnId)
|
|
264
|
+
|
|
265
|
+
expect(response.id).to eq(@vrsnId)
|
|
266
|
+
expect(response.deleted).to eq(true)
|
|
267
|
+
end
|
|
268
|
+
|
|
269
|
+
after(:all) do
|
|
270
|
+
api = TestFixtures.api_client_with_test_key()
|
|
271
|
+
templateApi = TemplatesApi.new(api)
|
|
272
|
+
templateApi.delete(@tmplId)
|
|
273
|
+
end
|
|
274
|
+
end
|
|
275
|
+
end
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# UsAutocompletion.spec.rb
|
|
2
|
+
require_relative '../TestFixtures'
|
|
3
|
+
include Lob
|
|
4
|
+
$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
|
|
5
|
+
|
|
6
|
+
RSpec.describe "UsAutocompletionsApi" do
|
|
7
|
+
it "can be instantiated" do
|
|
8
|
+
usAutocompletionApi = UsAutocompletionsApi.new()
|
|
9
|
+
|
|
10
|
+
expect(usAutocompletionApi).not_to be_nil
|
|
11
|
+
expect(usAutocompletionApi).to be_a_kind_of(UsAutocompletionsApi)
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
describe "Autocomplete" do
|
|
15
|
+
before(:all) do
|
|
16
|
+
api = TestFixtures.api_client_with_test_key()
|
|
17
|
+
@usAutocompletionApi = UsAutocompletionsApi.new(api)
|
|
18
|
+
|
|
19
|
+
@validAddress = UsAutocompletionsWritable.new({
|
|
20
|
+
address_prefix: "1 suggestion",
|
|
21
|
+
city: "SAN FRANCISCO",
|
|
22
|
+
})
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
it "Autocompletes US address (with test key)" do
|
|
26
|
+
autocompletedAddr = @usAutocompletionApi.autocomplete(@validAddress)
|
|
27
|
+
puts autocompletedAddr.suggestions[0].primary_line
|
|
28
|
+
expect(autocompletedAddr.suggestions[0].primary_line).to eq("1 TELEGRAPH HILL BLVD")
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
it "handles errors returned by the api" do
|
|
32
|
+
validAddress = UsAutocompletionsWritable.new()
|
|
33
|
+
begin
|
|
34
|
+
response = @usAutocompletionApi.autocomplete(validAddress)
|
|
35
|
+
rescue => err
|
|
36
|
+
expect(err.message.include? "address_prefix is required").to be(true)
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
it "does not allow creation with invalid key" do
|
|
41
|
+
config = Lob::Configuration.default
|
|
42
|
+
config.username = "fake key"
|
|
43
|
+
badapi = Lob::ApiClient.new(config)
|
|
44
|
+
|
|
45
|
+
usAutocompletionApi = UsAutocompletionsApi.new(badapi)
|
|
46
|
+
|
|
47
|
+
begin
|
|
48
|
+
response = usAutocompletionApi.autocomplete(@validAddress)
|
|
49
|
+
rescue => err
|
|
50
|
+
expect(err.message.include? "Your API key is not valid.").to be(true)
|
|
51
|
+
end
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
end
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# UsVerification.spec.rb
|
|
2
|
+
require_relative '../TestFixtures'
|
|
3
|
+
include Lob
|
|
4
|
+
$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
|
|
5
|
+
|
|
6
|
+
RSpec.describe "UsVerificationsApi" do
|
|
7
|
+
it "can be instantiated" do
|
|
8
|
+
usVerificationApi = UsVerificationsApi.new()
|
|
9
|
+
|
|
10
|
+
expect(usVerificationApi).not_to be_nil
|
|
11
|
+
expect(usVerificationApi).to be_a_kind_of(UsVerificationsApi)
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
describe "verifySingle" do
|
|
15
|
+
before(:all) do
|
|
16
|
+
api = TestFixtures.api_client_with_live_key()
|
|
17
|
+
@usVerificationApi = UsVerificationsApi.new(api)
|
|
18
|
+
|
|
19
|
+
@validAddress = UsVerificationsWritable.new({
|
|
20
|
+
primary_line: "210 KING ST",
|
|
21
|
+
city: "SAN FRANCISCO",
|
|
22
|
+
state: "CA",
|
|
23
|
+
zip_code: "94107"
|
|
24
|
+
})
|
|
25
|
+
@invalidAddress = UsVerificationsWritable.new({
|
|
26
|
+
primary_line: "1 CEMETERY ST",
|
|
27
|
+
city: "POTATOFIELD",
|
|
28
|
+
state: "NJ",
|
|
29
|
+
zip_code: "07000"
|
|
30
|
+
})
|
|
31
|
+
mc1 = MultipleComponents.new({
|
|
32
|
+
primary_line: "210 KING ST",
|
|
33
|
+
city: "SAN FRANCISCO",
|
|
34
|
+
state: "CA",
|
|
35
|
+
zip_code: "94107"
|
|
36
|
+
})
|
|
37
|
+
mc2 = MultipleComponents.new({
|
|
38
|
+
primary_line: "001 CEMETERY LN",
|
|
39
|
+
secondary_line: "SUITE 666",
|
|
40
|
+
city: "WESTFIELD",
|
|
41
|
+
state: "NJ",
|
|
42
|
+
zip_code: "07000"
|
|
43
|
+
})
|
|
44
|
+
mcError = MultipleComponents.new({
|
|
45
|
+
})
|
|
46
|
+
@addressList = MultipleComponentsList.new({
|
|
47
|
+
addresses: [mc1, mc2]
|
|
48
|
+
})
|
|
49
|
+
|
|
50
|
+
@errorAddressList = MultipleComponentsList.new({
|
|
51
|
+
addresses: [mc1, mcError]
|
|
52
|
+
})
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
it "Verifies valid addresses in bulk" do
|
|
56
|
+
verifiedList = @usVerificationApi.verifyBulk(@addressList)
|
|
57
|
+
expect(verifiedList.addresses.length()).to be(2)
|
|
58
|
+
expect(verifiedList.addresses[0].deliverability).to eq("deliverable")
|
|
59
|
+
expect(verifiedList.addresses[1].deliverability).to eq("undeliverable")
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
it "Handles errors while verifying addresses in bulk" do
|
|
63
|
+
verifiedList = @usVerificationApi.verifyBulk(@errorAddressList)
|
|
64
|
+
expect(verifiedList.addresses.length()).to be(2)
|
|
65
|
+
expect(verifiedList.addresses[1].error).not_to be_nil
|
|
66
|
+
expect(verifiedList.errors).to be(true)
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
it "Verifies single deliverable address" do
|
|
70
|
+
verifiedAddr = @usVerificationApi.verifySingle(@validAddress)
|
|
71
|
+
expect(verifiedAddr.deliverability).to eq("deliverable")
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
it "Verifies single undeliverable address" do
|
|
75
|
+
verifiedAddr = @usVerificationApi.verifySingle(@invalidAddress)
|
|
76
|
+
expect(verifiedAddr.deliverability).to eq("undeliverable")
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
it "handles errors returned by the api" do
|
|
80
|
+
invalidAddress = UsVerificationsWritable.new()
|
|
81
|
+
begin
|
|
82
|
+
response = @usVerificationApi.verifySingle(invalidAddress)
|
|
83
|
+
rescue => err
|
|
84
|
+
expect(err.message.include? "primary_line is required").to be(true)
|
|
85
|
+
end
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
it "does not allow creation with invalid key" do
|
|
89
|
+
config = Lob::Configuration.default
|
|
90
|
+
config.username = "fake key"
|
|
91
|
+
badapi = Lob::ApiClient.new(config)
|
|
92
|
+
|
|
93
|
+
usVerificationApi = UsVerificationsApi.new(badapi)
|
|
94
|
+
|
|
95
|
+
begin
|
|
96
|
+
response = usVerificationApi.verifySingle(@validAddress)
|
|
97
|
+
rescue => err
|
|
98
|
+
expect(err.message.include? "Your API key is not valid.").to be(true)
|
|
99
|
+
end
|
|
100
|
+
end
|
|
101
|
+
end
|
|
102
|
+
end
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# UsAutocompletion.spec.rb
|
|
2
|
+
require_relative '../TestFixtures'
|
|
3
|
+
include Lob
|
|
4
|
+
$:.unshift File.expand_path("../../lib/openapi_client", File.dirname(__FILE__))
|
|
5
|
+
|
|
6
|
+
RSpec.describe "ZipLookupsApi" do
|
|
7
|
+
it "can be instantiated" do
|
|
8
|
+
zipLookupsApi = ZipLookupsApi.new()
|
|
9
|
+
|
|
10
|
+
expect(zipLookupsApi).not_to be_nil
|
|
11
|
+
expect(zipLookupsApi).to be_a_kind_of(ZipLookupsApi)
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
describe "Lookup" do
|
|
15
|
+
before(:all) do
|
|
16
|
+
api = TestFixtures.api_client_with_test_key()
|
|
17
|
+
@zipLookupsApi = ZipLookupsApi.new(api)
|
|
18
|
+
|
|
19
|
+
@zipEditable = ZipEditable.new({
|
|
20
|
+
zip_code: "94107"
|
|
21
|
+
});
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
it "looks up given input" do
|
|
25
|
+
response = @zipLookupsApi.lookup(@zipEditable)
|
|
26
|
+
expect(response.cities.length()).to be > 0
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
module Lob
|
|
2
|
+
class TestFixtures
|
|
3
|
+
|
|
4
|
+
def self.api_client_with_test_key()
|
|
5
|
+
config = Lob::Configuration.default
|
|
6
|
+
config.username = ENV["LOB_API_TEST_KEY"]
|
|
7
|
+
apiClient = Lob::ApiClient.new(config)
|
|
8
|
+
return apiClient
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
def self.api_client_with_live_key()
|
|
12
|
+
config = Lob::Configuration.default
|
|
13
|
+
config.username = ENV["LOB_API_LIVE_KEY"]
|
|
14
|
+
apiClient = Lob::ApiClient.new(config)
|
|
15
|
+
return apiClient
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
def self.FILE_LOCATION()
|
|
19
|
+
return "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/card_horizontal.pdf"
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
def self.FILE_LOCATION_4x6()
|
|
23
|
+
return "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/4x6_pc_template.pdf";
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
def self.FILE_LOCATION_6X18()
|
|
27
|
+
return "https://s3.us-west-2.amazonaws.com/public.lob.com/assets/templates/self_mailers/6x18_sfm_inside.pdf"
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
def self.FILE_LOCATION_8X11()
|
|
31
|
+
return "https://s3-us-west-2.amazonaws.com/public.lob.com/assets/us_letter_1pg.pdf"
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
end
|
|
36
|
+
end
|
data/docs/Address.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Lob::Address
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier prefixed with `adr_`. | [optional] |
|
|
8
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
|
9
|
+
| **name** | **String** | name associated with address | [optional] |
|
|
10
|
+
| **company** | **String** | Either `name` or `company` is required, you may also add both. | [optional] |
|
|
11
|
+
| **phone** | **String** | Must be no longer than 40 characters. | [optional] |
|
|
12
|
+
| **email** | **String** | Must be no longer than 100 characters. | [optional] |
|
|
13
|
+
| **metadata** | **Hash<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] |
|
|
14
|
+
| **address_line1** | **String** | | [optional] |
|
|
15
|
+
| **address_line2** | **String** | | [optional] |
|
|
16
|
+
| **address_city** | **String** | | [optional] |
|
|
17
|
+
| **address_state** | **String** | 2 letter state short-name code | [optional] |
|
|
18
|
+
| **address_zip** | **String** | Must follow the ZIP format of `12345` or ZIP+4 format of `12345-1234`. | [optional] |
|
|
19
|
+
| **address_country** | [**CountryExtendedExpanded**](CountryExtendedExpanded.md) | | [optional] |
|
|
20
|
+
| **object** | **String** | | [optional][default to 'address'] |
|
|
21
|
+
| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] |
|
|
22
|
+
| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] |
|
|
23
|
+
| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
|
|
24
|
+
| **recipient_moved** | **Boolean** | Only returned for accounts on certain <a href=\"https://dashboard.lob.com/#/settings/editions\">Print &amp; Mail Editions</a>. Value is `true` if the address was altered because the recipient filed for a <a href=\"#ncoa\">National Change of Address (NCOA)</a>, `false` if the NCOA check was run but no altered address was found, and `null` if the NCOA check was not run. The NCOA check does not happen for non-US addresses, for non-deliverable US addresses, or for addresses created before the NCOA feature was added to your account. | [optional] |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require 'openapi_client'
|
|
30
|
+
|
|
31
|
+
instance = Lob::Address.new(
|
|
32
|
+
id: null,
|
|
33
|
+
description: null,
|
|
34
|
+
name: null,
|
|
35
|
+
company: null,
|
|
36
|
+
phone: null,
|
|
37
|
+
email: null,
|
|
38
|
+
metadata: null,
|
|
39
|
+
address_line1: null,
|
|
40
|
+
address_line2: null,
|
|
41
|
+
address_city: null,
|
|
42
|
+
address_state: null,
|
|
43
|
+
address_zip: null,
|
|
44
|
+
address_country: null,
|
|
45
|
+
object: null,
|
|
46
|
+
date_created: null,
|
|
47
|
+
date_modified: null,
|
|
48
|
+
deleted: null,
|
|
49
|
+
recipient_moved: null
|
|
50
|
+
)
|
|
51
|
+
```
|
|
52
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Lob::AddressDeletion
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier prefixed with `adr_`. | [optional] |
|
|
8
|
+
| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
|
|
9
|
+
| **object** | **String** | Value is type of resource. | [optional][default to 'address_deleted'] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'openapi_client'
|
|
15
|
+
|
|
16
|
+
instance = Lob::AddressDeletion.new(
|
|
17
|
+
id: null,
|
|
18
|
+
deleted: null,
|
|
19
|
+
object: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Lob::AddressDomestic
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **address_line1** | **String** | The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. | [optional] |
|
|
8
|
+
| **address_line2** | **String** | The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. | [optional] |
|
|
9
|
+
| **address_city** | **String** | | [optional] |
|
|
10
|
+
| **address_state** | **String** | | [optional] |
|
|
11
|
+
| **address_zip** | **String** | Optional postal code. For US addresses, must be either 5 or 9 digits. | [optional] |
|
|
12
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
|
13
|
+
| **name** | **String** | Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address. | [optional] |
|
|
14
|
+
| **company** | **String** | Either `name` or `company` is required, you may also add both. | [optional] |
|
|
15
|
+
| **phone** | **String** | Must be no longer than 40 characters. | [optional] |
|
|
16
|
+
| **email** | **String** | Must be no longer than 100 characters. | [optional] |
|
|
17
|
+
| **address_country** | **String** | The country associated with this address. | [optional] |
|
|
18
|
+
| **metadata** | **Hash<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'openapi_client'
|
|
24
|
+
|
|
25
|
+
instance = Lob::AddressDomestic.new(
|
|
26
|
+
address_line1: null,
|
|
27
|
+
address_line2: null,
|
|
28
|
+
address_city: null,
|
|
29
|
+
address_state: null,
|
|
30
|
+
address_zip: null,
|
|
31
|
+
description: null,
|
|
32
|
+
name: null,
|
|
33
|
+
company: null,
|
|
34
|
+
phone: null,
|
|
35
|
+
email: null,
|
|
36
|
+
address_country: null,
|
|
37
|
+
metadata: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Lob::AddressDomesticExpanded
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **address_line1** | **String** | The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. | [optional] |
|
|
8
|
+
| **address_line2** | **String** | The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. | [optional] |
|
|
9
|
+
| **address_city** | **String** | | [optional] |
|
|
10
|
+
| **address_state** | **String** | | [optional] |
|
|
11
|
+
| **address_zip** | **String** | Optional postal code. For US addresses, must be either 5 or 9 digits. | [optional] |
|
|
12
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
|
13
|
+
| **name** | **String** | Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address. | [optional] |
|
|
14
|
+
| **company** | **String** | Either `name` or `company` is required, you may also add both. | [optional] |
|
|
15
|
+
| **phone** | **String** | Must be no longer than 40 characters. | [optional] |
|
|
16
|
+
| **email** | **String** | Must be no longer than 100 characters. | [optional] |
|
|
17
|
+
| **address_country** | **String** | The country associated with this address. | [optional] |
|
|
18
|
+
| **metadata** | **Hash<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'openapi_client'
|
|
24
|
+
|
|
25
|
+
instance = Lob::AddressDomesticExpanded.new(
|
|
26
|
+
address_line1: null,
|
|
27
|
+
address_line2: null,
|
|
28
|
+
address_city: null,
|
|
29
|
+
address_state: null,
|
|
30
|
+
address_zip: null,
|
|
31
|
+
description: null,
|
|
32
|
+
name: null,
|
|
33
|
+
company: null,
|
|
34
|
+
phone: null,
|
|
35
|
+
email: null,
|
|
36
|
+
address_country: null,
|
|
37
|
+
metadata: null
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|