Module: Lob

Defined in:

lib/lob/version.rb,
lib/lob.rb,
lib/lob/api_error.rb,
lib/lob/api_client.rb,
lib/lob/models/zip.rb,
lib/lob/models/card.rb,
lib/lob/models/check.rb,
lib/lob/api/cards_api.rb,
lib/lob/configuration.rb,
lib/lob/models/events.rb,
lib/lob/models/export.rb,
lib/lob/models/letter.rb,
lib/lob/models/upload.rb,
lib/lob/api/checks_api.rb,
lib/lob/models/address.rb,
lib/lob/models/qr_code.rb,
lib/lob/models/sort_by.rb,
lib/lob/api/default_api.rb,
lib/lob/api/letters_api.rb,
lib/lob/api/uploads_api.rb,
lib/lob/models/buckslip.rb,
lib/lob/models/campaign.rb,
lib/lob/models/location.rb,
lib/lob/models/postcard.rb,
lib/lob/models/sort_by1.rb,
lib/lob/models/sort_by2.rb,
lib/lob/models/sort_by3.rb,
lib/lob/models/sort_by4.rb,
lib/lob/models/template.rb,
lib/lob/models/card_list.rb,
lib/lob/models/lob_error.rb,
lib/lob/models/mail_type.rb,
lib/lob/models/snap_pack.rb,
lib/lob/models/thumbnail.rb,
lib/lob/api/addresses_api.rb,
lib/lob/api/buckslips_api.rb,
lib/lob/api/campaigns_api.rb,
lib/lob/api/creatives_api.rb,
lib/lob/api/postcards_api.rb,
lib/lob/api/templates_api.rb,
lib/lob/models/bulk_error.rb,
lib/lob/models/card_order.rb,
lib/lob/models/check_list.rb,
lib/lob/models/event_type.rb,
lib/lob/models/us_address.rb,
lib/lob/api/snap_packs_api.rb,
lib/lob/models/engine_html.rb,
lib/lob/models/letter_list.rb,
lib/lob/models/self_mailer.rb,
lib/lob/models/suggestions.rb,
lib/lob/models/upload_file.rb,
lib/lob/api/card_orders_api.rb,
lib/lob/api/zip_lookups_api.rb,
lib/lob/models/address_list.rb,
lib/lob/models/bank_account.rb,
lib/lob/models/chk_use_type.rb,
lib/lob/models/cmp_use_type.rb,
lib/lob/models/dpv_footnote.rb,
lib/lob/models/export_model.rb,
lib/lob/models/intl_address.rb,
lib/lob/models/ltr_use_type.rb,
lib/lob/models/psc_use_type.rb,
lib/lob/models/sfm_use_type.rb,
lib/lob/models/snp_use_type.rb,
lib/lob/models/upload_state.rb,
lib/lob/models/zip_editable.rb,
lib/lob/api/self_mailers_api.rb,
lib/lob/models/billing_group.rb,
lib/lob/models/card_deletion.rb,
lib/lob/models/card_editable.rb,
lib/lob/models/inline_object.rb,
lib/lob/models/postcard_list.rb,
lib/lob/models/postcard_size.rb,
lib/lob/models/template_list.rb,
lib/lob/models/us_components.rb,
lib/lob/models/zip_code_type.rb,
lib/lob/api/bank_accounts_api.rb,
lib/lob/models/bank_type_enum.rb,
lib/lob/models/buckslip_order.rb,
lib/lob/models/buckslips_list.rb,
lib/lob/models/campaigns_list.rb,
lib/lob/models/card_updatable.rb,
lib/lob/models/check_deletion.rb,
lib/lob/models/check_editable.rb,
lib/lob/models/creative_patch.rb,
lib/lob/models/snap_pack_list.rb,
lib/lob/models/snap_pack_size.rb,
lib/lob/api/billing_groups_api.rb,
lib/lob/models/card_order_list.rb,
lib/lob/models/intl_components.rb,
lib/lob/models/letter_deletion.rb,
lib/lob/models/letter_editable.rb,
lib/lob/models/return_envelope.rb,
lib/lob/models/reverse_geocode.rb,
lib/lob/models/template_update.rb,
lib/lob/models/upload_writable.rb,
lib/lob/models/us_verification.rb,
lib/lob/models/zip_lookup_city.rb,
lib/lob/api/buckslip_orders_api.rb,
lib/lob/models/address_deletion.rb,
lib/lob/models/address_domestic.rb,
lib/lob/models/address_editable.rb,
lib/lob/models/country_extended.rb,
lib/lob/models/intl_suggestions.rb,
lib/lob/models/self_mailer_list.rb,
lib/lob/models/self_mailer_size.rb,
lib/lob/models/template_version.rb,
lib/lob/models/upload_updatable.rb,
lib/lob/models/uploads_metadata.rb,
lib/lob/models/us_verifications.rb,
lib/lob/models/validation_error.rb,
lib/lob/api/us_verifications_api.rb,
lib/lob/models/bank_account_list.rb,
lib/lob/models/buckslip_deletion.rb,
lib/lob/models/buckslip_editable.rb,
lib/lob/models/campaign_creative.rb,
lib/lob/models/campaign_deletion.rb,
lib/lob/models/campaign_writable.rb,
lib/lob/models/cmp_schedule_type.rb,
lib/lob/models/creative_response.rb,
lib/lob/models/creative_writable.rb,
lib/lob/models/geocode_addresses.rb,
lib/lob/models/intl_verification.rb,
lib/lob/models/location_analysis.rb,
lib/lob/models/placeholder_model.rb,
lib/lob/models/postcard_deletion.rb,
lib/lob/models/postcard_editable.rb,
lib/lob/models/template_deletion.rb,
lib/lob/models/template_writable.rb,
lib/lob/api/template_versions_api.rb,
lib/lob/models/billing_group_list.rb,
lib/lob/models/buckslip_updatable.rb,
lib/lob/models/campaign_updatable.rb,
lib/lob/models/geocode_components.rb,
lib/lob/models/intl_verifications.rb,
lib/lob/models/multi_line_address.rb,
lib/lob/models/snap_pack_deletion.rb,
lib/lob/models/snap_pack_editable.rb,
lib/lob/models/us_autocompletions.rb,
lib/lob/api/intl_verifications_api.rb,
lib/lob/api/us_autocompletions_api.rb,
lib/lob/models/bank_account_verify.rb,
lib/lob/models/card_order_editable.rb,
lib/lob/models/identity_validation.rb,
lib/lob/models/multiple_components.rb,
lib/lob/api/identity_validation_api.rb,
lib/lob/models/buckslip_orders_list.rb,
lib/lob/models/intl_autocompletions.rb,
lib/lob/models/lob_confidence_score.rb,
lib/lob/models/self_mailer_deletion.rb,
lib/lob/models/self_mailer_editable.rb,
lib/lob/models/upload_create_export.rb,
lib/lob/api/intl_autocompletions_api.rb,
lib/lob/models/bank_account_deletion.rb,
lib/lob/models/bank_account_writable.rb,
lib/lob/models/bulk_error_properties.rb,
lib/lob/models/http_validation_error.rb,
lib/lob/models/sort_by_date_modified.rb,
lib/lob/models/template_version_list.rb,
lib/lob/models/tracking_event_normal.rb,
lib/lob/models/billing_group_editable.rb,
lib/lob/models/letter_custom_envelope.rb,
lib/lob/models/tracking_event_details.rb,
lib/lob/models/buckslip_order_editable.rb,
lib/lob/models/deliverability_analysis.rb,
lib/lob/models/letter_details_returned.rb,
lib/lob/models/letter_details_writable.rb,
lib/lob/api/reverse_geocode_lookups_api.rb,
lib/lob/models/custom_envelope_returned.rb,
lib/lob/models/multiple_components_intl.rb,
lib/lob/models/multiple_components_list.rb,
lib/lob/models/tracking_event_certified.rb,
lib/lob/models/us_verification_or_error.rb,
lib/lob/models/address_domestic_expanded.rb,
lib/lob/models/country_extended_expanded.rb,
lib/lob/models/postcard_details_returned.rb,
lib/lob/models/postcard_details_writable.rb,
lib/lob/models/template_version_deletion.rb,
lib/lob/models/template_version_writable.rb,
lib/lob/models/us_verifications_writable.rb,
lib/lob/models/intl_verification_or_error.rb,
lib/lob/models/intl_verification_writable.rb,
lib/lob/models/intl_verifications_payload.rb,
lib/lob/models/template_version_updatable.rb,
lib/lob/models/us_autocompletions_writable.rb,
lib/lob/models/intl_autocompletions_writable.rb,
lib/lob/models/country_extended_expanded_no_us.rb,
lib/lob/models/optional_address_column_mapping.rb,
lib/lob/models/required_address_column_mapping.rb

Overview

#Lob

#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](lob.github.io/legacy-docs/)?

The version of the OpenAPI document: 1.3.0 Contact: lob-openapi@lob.com Generated by: openapi-generator.tech OpenAPI Generator version: 5.2.1

Defined Under Namespace

Modules: Address Classes: AddressDeletion, AddressDomestic, AddressDomesticExpanded, AddressEditable, AddressList, AddressesApi, ApiClient, ApiError, BankAccount, BankAccountDeletion, BankAccountList, BankAccountVerify, BankAccountWritable, BankAccountsApi, BankTypeEnum, BillingGroup, BillingGroupEditable, BillingGroupList, BillingGroupsApi, Buckslip, BuckslipDeletion, BuckslipEditable, BuckslipOrder, BuckslipOrderEditable, BuckslipOrdersApi, BuckslipOrdersList, BuckslipUpdatable, BuckslipsApi, BuckslipsList, BulkError, BulkErrorProperties, Campaign, CampaignCreative, CampaignDeletion, CampaignUpdatable, CampaignWritable, CampaignsApi, CampaignsList, Card, CardDeletion, CardEditable, CardList, CardOrder, CardOrderEditable, CardOrderList, CardOrdersApi, CardUpdatable, CardsApi, Check, CheckDeletion, CheckEditable, CheckList, ChecksApi, ChkUseType, CmpScheduleType, CmpUseType, Configuration, CountryExtended, CountryExtendedExpanded, CountryExtendedExpandedNoUs, CreativePatch, CreativeResponse, CreativeWritable, CreativesApi, CustomEnvelopeReturned, DefaultApi, DeliverabilityAnalysis, DpvFootnote, EngineHtml, EventType, Events, Export, ExportModel, GeocodeAddresses, GeocodeComponents, HTTPValidationError, IdentityValidation, IdentityValidationApi, InlineObject, IntlAddress, IntlAutocompletions, IntlAutocompletionsApi, IntlAutocompletionsWritable, IntlComponents, IntlSuggestions, IntlVerification, IntlVerificationOrError, IntlVerificationWritable, IntlVerifications, IntlVerificationsApi, IntlVerificationsPayload, Letter, LetterCustomEnvelope, LetterDeletion, LetterDetailsReturned, LetterDetailsWritable, LetterEditable, LetterList, LettersApi, LobConfidenceScore, LobError, Location, LocationAnalysis, LtrUseType, MailType, MultiLineAddress, MultipleComponents, MultipleComponentsIntl, MultipleComponentsList, OptionalAddressColumnMapping, PlaceholderModel, Postcard, PostcardDeletion, PostcardDetailsReturned, PostcardDetailsWritable, PostcardEditable, PostcardList, PostcardSize, PostcardsApi, PscUseType, QrCode, RequiredAddressColumnMapping, ReturnEnvelope, ReverseGeocode, ReverseGeocodeLookupsApi, SelfMailer, SelfMailerDeletion, SelfMailerEditable, SelfMailerList, SelfMailerSize, SelfMailersApi, SfmUseType, SnapPack, SnapPackDeletion, SnapPackEditable, SnapPackList, SnapPackSize, SnapPacksApi, SnpUseType, SortBy, SortBy1, SortBy2, SortBy3, SortBy4, SortByDateModified, Suggestions, Template, TemplateDeletion, TemplateList, TemplateUpdate, TemplateVersion, TemplateVersionDeletion, TemplateVersionList, TemplateVersionUpdatable, TemplateVersionWritable, TemplateVersionsApi, TemplateWritable, TemplatesApi, Thumbnail, TrackingEventCertified, TrackingEventDetails, TrackingEventNormal, Upload, UploadCreateExport, UploadFile, UploadState, UploadUpdatable, UploadWritable, UploadsApi, UploadsMetadata, UsAddress, UsAutocompletions, UsAutocompletionsApi, UsAutocompletionsWritable, UsComponents, UsVerification, UsVerificationOrError, UsVerifications, UsVerificationsApi, UsVerificationsWritable, ValidationError, Zip, ZipCodeType, ZipEditable, ZipLookupCity, ZipLookupsApi

Constant Summary

VERSION =

'6.1.0'

Class Method Summary

• .configure ⇒ Object

  Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Lob.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File 'lib/lob.rb', line 215

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end