var search_data = {"index":{"searchIndex":["easypost","address","apikey","batch","beta","endshipper","referral","billing","brand","carbonoffset","carrieraccount","carriertype","customsinfo","customsitem","easypostobject","endshipper","error","event","insurance","order","parcel","paymentmethod","pickup","pickuprate","postagelabel","rate","referral","refund","report","resource","scanform","shipment","taxidentifier","tracker","user","util","webhook","==()","[]()","[]=()","add_accessors()","add_credit_card()","add_credit_card()","add_shipments()","all()","all()","all()","all()","all()","all()","all()","all()","all()","all()","all()","all()","all_api_keys()","api_keys()","as_json()","authorization()","build_dict_key()","buy()","buy()","buy()","buy()","cancel()","class_name()","construct_from()","convert_to_easypost_object()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create_and_buy()","create_and_verify()","create_easypost_credit_card()","create_easypost_credit_card()","create_list()","create_scan_form()","create_stripe_token()","create_stripe_token()","deconstruct_keys()","default_connection()","default_headers()","default_http_config()","delete()","delete()","delete()","delete_payment_method()","each()","each()","flatten_unsaved()","form_encode_params()","fund_wallet()","generate_form()","get_lowest_object_rate()","get_lowest_smartrate()","get_payment_method_info()","get_rates()","get_smartrates()","http_config()","http_config=()","id()","id=()","inspect()","insure()","keys()","label()","label()","lowest_rate()","lowest_rate()","lowest_rate()","lowest_smartrate()","make_client()","make_request()","metaclass()","new()","new()","normalize_string_list()","objects_to_ids()","os_arch()","os_name()","os_version()","parse_response()","receive()","refresh()","refresh_from()","refund()","regenerate_rates()","remove_shipments()","reset_http_config()","retrieve()","retrieve()","retrieve_easypost_stripe_api_key()","retrieve_easypost_stripe_api_key()","retrieve_me()","retrieve_payment_methods()","save()","save()","save()","save()","to_hash()","to_json()","to_s()","to_s()","types()","update()","update_brand()","update_email()","update_email()","url()","url()","url()","user_agent()","validate_webhook()","values()","verify()"],"longSearchIndex":["easypost","easypost::address","easypost::apikey","easypost::batch","easypost::beta","easypost::beta::endshipper","easypost::beta::referral","easypost::billing","easypost::brand","easypost::carbonoffset","easypost::carrieraccount","easypost::carriertype","easypost::customsinfo","easypost::customsitem","easypost::easypostobject","easypost::endshipper","easypost::error","easypost::event","easypost::insurance","easypost::order","easypost::parcel","easypost::paymentmethod","easypost::pickup","easypost::pickuprate","easypost::postagelabel","easypost::rate","easypost::referral","easypost::refund","easypost::report","easypost::resource","easypost::scanform","easypost::shipment","easypost::taxidentifier","easypost::tracker","easypost::user","easypost::util","easypost::webhook","easypost::error#==()","easypost::easypostobject#[]()","easypost::easypostobject#[]=()","easypost::easypostobject#add_accessors()","easypost::beta::referral::add_credit_card()","easypost::referral::add_credit_card()","easypost::batch#add_shipments()","easypost::beta::endshipper::all()","easypost::beta::referral::all()","easypost::customsinfo::all()","easypost::customsitem::all()","easypost::order::all()","easypost::parcel::all()","easypost::paymentmethod::all()","easypost::pickup::all()","easypost::rate::all()","easypost::referral::all()","easypost::report::all()","easypost::resource::all()","easypost::user::all_api_keys()","easypost::user#api_keys()","easypost::easypostobject#as_json()","easypost::authorization()","easypost::util::build_dict_key()","easypost::batch#buy()","easypost::order#buy()","easypost::pickup#buy()","easypost::shipment#buy()","easypost::pickup#cancel()","easypost::resource::class_name()","easypost::easypostobject::construct_from()","easypost::util::convert_to_easypost_object()","easypost::address::create()","easypost::beta::endshipper::create()","easypost::beta::referral::create()","easypost::endshipper::create()","easypost::referral::create()","easypost::report::create()","easypost::resource::create()","easypost::scanform::create()","easypost::shipment::create()","easypost::user::create()","easypost::batch::create_and_buy()","easypost::address::create_and_verify()","easypost::beta::referral::create_easypost_credit_card()","easypost::referral::create_easypost_credit_card()","easypost::tracker::create_list()","easypost::batch#create_scan_form()","easypost::beta::referral::create_stripe_token()","easypost::referral::create_stripe_token()","easypost::easypostobject#deconstruct_keys()","easypost::default_connection()","easypost::default_headers()","easypost::default_http_config()","easypost::resource#delete()","easypost::user#delete()","easypost::webhook#delete()","easypost::billing::delete_payment_method()","easypost::easypostobject#each()","easypost::resource::each()","easypost::easypostobject#flatten_unsaved()","easypost::util::form_encode_params()","easypost::billing::fund_wallet()","easypost::shipment#generate_form()","easypost::util::get_lowest_object_rate()","easypost::shipment::get_lowest_smartrate()","easypost::billing::get_payment_method_info()","easypost::order#get_rates()","easypost::shipment#get_smartrates()","easypost::http_config()","easypost::http_config=()","easypost::easypostobject#id()","easypost::easypostobject#id=()","easypost::easypostobject#inspect()","easypost::shipment#insure()","easypost::easypostobject#keys()","easypost::batch#label()","easypost::shipment#label()","easypost::order#lowest_rate()","easypost::pickup#lowest_rate()","easypost::shipment#lowest_rate()","easypost::shipment#lowest_smartrate()","easypost::make_client()","easypost::make_request()","easypost::easypostobject#metaclass()","easypost::easypostobject::new()","easypost::error::new()","easypost::util::normalize_string_list()","easypost::util::objects_to_ids()","easypost::util::os_arch()","easypost::util::os_name()","easypost::util::os_version()","easypost::parse_response()","easypost::event::receive()","easypost::resource#refresh()","easypost::easypostobject#refresh_from()","easypost::shipment#refund()","easypost::shipment#regenerate_rates()","easypost::batch#remove_shipments()","easypost::reset_http_config()","easypost::beta::endshipper::retrieve()","easypost::resource::retrieve()","easypost::beta::referral::retrieve_easypost_stripe_api_key()","easypost::referral::retrieve_easypost_stripe_api_key()","easypost::user::retrieve_me()","easypost::billing::retrieve_payment_methods()","easypost::beta::endshipper#save()","easypost::endshipper#save()","easypost::resource#save()","easypost::user#save()","easypost::easypostobject#to_hash()","easypost::easypostobject#to_json()","easypost::easypostobject#to_s()","easypost::error#to_s()","easypost::carrieraccount::types()","easypost::webhook#update()","easypost::user#update_brand()","easypost::beta::referral::update_email()","easypost::referral::update_email()","easypost::brand#url()","easypost::resource::url()","easypost::resource#url()","easypost::user_agent()","easypost::webhook::validate_webhook()","easypost::easypostobject#values()","easypost::address#verify()"],"info":[["EasyPost","","EasyPost.html","",""],["EasyPost::Address","","EasyPost/Address.html","","

Address objects are used to represent people, places, and organizations in a number of contexts.\n"],["EasyPost::ApiKey","","EasyPost/ApiKey.html","","

An ApiKey allows you to authenticate with the EasyPost API.\n"],["EasyPost::Batch","","EasyPost/Batch.html","","

The Batch object allows you to perform operations on multiple Shipments at once.\n"],["EasyPost::Beta","","EasyPost/Beta.html","",""],["EasyPost::Beta::EndShipper","","EasyPost/Beta/EndShipper.html","","

EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon …\n"],["EasyPost::Beta::Referral","","EasyPost/Beta/Referral.html","","

Referral objects are User objects created from a Partner user.\n"],["EasyPost::Billing","","EasyPost/Billing.html","","

Billing class that users can manage their payment and fund\n"],["EasyPost::Brand","","EasyPost/Brand.html","","

The Brand object allows you to customize the publicly-accessible html page that shows tracking details …\n"],["EasyPost::CarbonOffset","","EasyPost/CarbonOffset.html","","

The CarbonOffset object is a summary of carbon offset data for a given rate, including grams, price and …\n"],["EasyPost::CarrierAccount","","EasyPost/CarrierAccount.html","","

A CarrierAccount encapsulates your credentials with the carrier.\n"],["EasyPost::CarrierType","","EasyPost/CarrierType.html","","

The CarrierType object provides an interface for determining the valid fields of a CarrierAccount.\n"],["EasyPost::CustomsInfo","","EasyPost/CustomsInfo.html","","

CustomsInfo objects contain CustomsItem objects and all necessary information for the generation of customs …\n"],["EasyPost::CustomsItem","","EasyPost/CustomsItem.html","","

A CustomsItem object describes goods for international shipment and should be created then included in …\n"],["EasyPost::EasyPostObject","","EasyPost/EasyPostObject.html","","

The EasyPostObject is extended by the EasyPost Resource object.\n"],["EasyPost::EndShipper","","EasyPost/EndShipper.html","","

EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon …\n"],["EasyPost::Error","","EasyPost/Error.html","","

EasyPost Error object.\n"],["EasyPost::Event","","EasyPost/Event.html","","

Webhook Events are triggered by changes in objects you’ve created via the API.\n"],["EasyPost::Insurance","","EasyPost/Insurance.html","","

An Insurance object represents insurance for packages purchased both via the EasyPost API as well as …\n"],["EasyPost::Order","","EasyPost/Order.html","","

The Order object represents a collection of packages and can be used for Multi-Piece Shipments.\n"],["EasyPost::Parcel","","EasyPost/Parcel.html","","

Parcel objects represent the physical container being shipped.\n"],["EasyPost::PaymentMethod","","EasyPost/PaymentMethod.html","","

PaymentMethod objects represent a payment method of a user.\n"],["EasyPost::Pickup","","EasyPost/Pickup.html","","

The Pickup object allows you to schedule a pickup from your carrier from your customer’s residence …\n"],["EasyPost::PickupRate","","EasyPost/PickupRate.html","","

A PickupRate is the rate available for a Pickup.\n"],["EasyPost::PostageLabel","","EasyPost/PostageLabel.html","","

PostageLabel is the object containing details about the shipping label.\n"],["EasyPost::Rate","","EasyPost/Rate.html","","

A Rate object contains all the details about the rate of a Shipment.\n"],["EasyPost::Referral","","EasyPost/Referral.html","","

Referral objects are User objects created from a Partner user.\n"],["EasyPost::Refund","","EasyPost/Refund.html","","

The Refund object contains details about the Refund of a Shipment.\n"],["EasyPost::Report","","EasyPost/Report.html","","

A Report contains a csv that is a log of all the objects created within a certain time frame.\n"],["EasyPost::Resource","","EasyPost/Resource.html","","

The Resource object is extended by each EasyPost object.\n"],["EasyPost::ScanForm","","EasyPost/ScanForm.html","","

A ScanForm can be created to speed up and simplify the carrier pickup process. The ScanForm is one document …\n"],["EasyPost::Shipment","","EasyPost/Shipment.html","","

The workhorse of the EasyPost API, a Shipment is made up of a “to” and “from” Address …\n"],["EasyPost::TaxIdentifier","","EasyPost/TaxIdentifier.html","","

TaxIdentifiers are identifying numbers or IDs that are used to charge a specific party when dealing with …\n"],["EasyPost::Tracker","","EasyPost/Tracker.html","","

A Tracker object contains all of the tracking information for a package.\n"],["EasyPost::User","","EasyPost/User.html","","

The User object can be used to manage your own account and to create child accounts.\n"],["EasyPost::Util","","EasyPost/Util.html","","

Internal utilities helpful for this libraries operation.\n"],["EasyPost::Webhook","","EasyPost/Webhook.html","","

Each Webhook contains the url which EasyPost will notify whenever an object in our system updates. Several …\n"],["==","EasyPost::Error","EasyPost/Error.html#method-i-3D-3D","(other)","

Compare error properties.\n"],["[]","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-5B-5D","(key)","

Get element of an array.\n"],["[]=","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-5B-5D-3D","(key, value)","

Set the element of an array.\n"],["add_accessors","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-add_accessors","(keys)","

Add accessors of an object.\n"],["add_credit_card","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-add_credit_card","(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')","

Add credit card to a referral customer. This function requires the Referral Customer’s API key. DEPRECATED: …\n"],["add_credit_card","EasyPost::Referral","EasyPost/Referral.html#method-c-add_credit_card","(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')","

Add credit card to a referral customer. This function requires the Referral Customer’s API key.\n"],["add_shipments","EasyPost::Batch","EasyPost/Batch.html#method-i-add_shipments","(params = {})","

Add Shipments to a Batch.\n"],["all","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-c-all","(params = {}, api_key = nil)","

Retrieves a list of EndShipper objects. DEPRECATED: Please use EndShipper in the main namespace instead. …\n"],["all","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-all","(params = {}, api_key = nil)","

Retrieve a list of referral customers. This function requires the Partner User’s API key. DEPRECATED: …\n"],["all","EasyPost::CustomsInfo","EasyPost/CustomsInfo.html#method-c-all","(_filters = {}, _api_key = nil)","

Retrieve a list of CustomsInfo objects\n"],["all","EasyPost::CustomsItem","EasyPost/CustomsItem.html#method-c-all","(_filters = {}, _api_key = nil)","

Retrieve a list of CustomsItem objects\n"],["all","EasyPost::Order","EasyPost/Order.html#method-c-all","(_filters = {}, _api_key = nil)","

Retrieve a list of Order objects.\n"],["all","EasyPost::Parcel","EasyPost/Parcel.html#method-c-all","(_filters = {}, _api_key = nil)","

Retrieving all Parcel objects is not supported.\n"],["all","EasyPost::PaymentMethod","EasyPost/PaymentMethod.html#method-c-all","(_filters = {}, api_key = nil)","

DEPRECATED: Please use Billing class instead. Deprecated: v4.5.0 - v6.0.0\n"],["all","EasyPost::Pickup","EasyPost/Pickup.html#method-c-all","(_filters = {}, _api_key = nil)","

Retrieve a list of all Pickup objects.\n"],["all","EasyPost::Rate","EasyPost/Rate.html#method-c-all","(_filters = {}, _api_key = nil)","

Retrieving all Rate objects is not supported.\n"],["all","EasyPost::Referral","EasyPost/Referral.html#method-c-all","(params = {}, api_key = nil)","

Retrieve a list of referral customers. This function requires the Partner User’s API key.\n"],["all","EasyPost::Report","EasyPost/Report.html#method-c-all","(filters = {}, api_key = nil)","

Retrieve a list of Report objects.\n"],["all","EasyPost::Resource","EasyPost/Resource.html#method-c-all","(filters = {}, api_key = nil)","

Retrieve a list of EasyPost objects.\n"],["all_api_keys","EasyPost::User","EasyPost/User.html#method-c-all_api_keys","()","

Retrieve a list of ApiKey objects.\n"],["api_keys","EasyPost::User","EasyPost/User.html#method-i-api_keys","()","

Retrieve a list of ApiKey objects of a child User.\n"],["as_json","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-as_json","(_options = {})","

Get values as JSON.\n"],["authorization","EasyPost","EasyPost.html#method-c-authorization","(key)",""],["build_dict_key","EasyPost::Util","EasyPost/Util.html#method-c-build_dict_key","(keys)","

Build a dict key from a list of keys. Example: [code, number] -> code\n"],["buy","EasyPost::Batch","EasyPost/Batch.html#method-i-buy","(params = {})","

Buy a Batch.\n"],["buy","EasyPost::Order","EasyPost/Order.html#method-i-buy","(params = {})","

Buy an Order.\n"],["buy","EasyPost::Pickup","EasyPost/Pickup.html#method-i-buy","(params = {})","

Buy a Pickup.\n"],["buy","EasyPost::Shipment","EasyPost/Shipment.html#method-i-buy","(params = {}, with_carbon_offset = false, end_shipper_id = nil)","

Buy a Shipment.\n"],["cancel","EasyPost::Pickup","EasyPost/Pickup.html#method-i-cancel","(params = {})","

Cancel a Pickup.\n"],["class_name","EasyPost::Resource","EasyPost/Resource.html#method-c-class_name","()","

The class name of an EasyPost object.\n"],["construct_from","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-c-construct_from","(values, api_key = nil, parent = nil, name = nil)","

Construct an object from values.\n"],["convert_to_easypost_object","EasyPost::Util","EasyPost/Util.html#method-c-convert_to_easypost_object","(response, api_key, parent = nil, name = nil)","

Convert data to an EasyPost Object.\n"],["create","EasyPost::Address","EasyPost/Address.html#method-c-create","(params = {}, api_key = nil)","

Create an Address.\n"],["create","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-c-create","(params = {}, api_key = nil)","

Create an EndShipper object. DEPRECATED: Please use EndShipper in the main namespace instead.\n"],["create","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-create","(params = {}, api_key = nil)","

Create a referral customer. This function requires the Partner User’s API key. DEPRECATED: Please use …\n"],["create","EasyPost::EndShipper","EasyPost/EndShipper.html#method-c-create","(params = {}, api_key = nil)","

Create an EndShipper object.\n"],["create","EasyPost::Referral","EasyPost/Referral.html#method-c-create","(params = {}, api_key = nil)","

Create a referral customer. This function requires the Partner User’s API key.\n"],["create","EasyPost::Report","EasyPost/Report.html#method-c-create","(params = {}, api_key = nil)","

Create a Report.\n"],["create","EasyPost::Resource","EasyPost/Resource.html#method-c-create","(params = {}, api_key = nil)","

Create an EasyPost object.\n"],["create","EasyPost::ScanForm","EasyPost/ScanForm.html#method-c-create","(params = {}, api_key = nil)","

Create a ScanForm.\n"],["create","EasyPost::Shipment","EasyPost/Shipment.html#method-c-create","(params = {}, api_key = nil, with_carbon_offset = false)","

Create a Shipment.\n"],["create","EasyPost::User","EasyPost/User.html#method-c-create","(params = {}, api_key = nil)","

Create a child User.\n"],["create_and_buy","EasyPost::Batch","EasyPost/Batch.html#method-c-create_and_buy","(params = {}, api_key = nil)","

Create and buy a batch in one call.\n"],["create_and_verify","EasyPost::Address","EasyPost/Address.html#method-c-create_and_verify","(params = {}, api_key = nil)","

Create and verify an Address in one call.\n"],["create_easypost_credit_card","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-create_easypost_credit_card","(referral_api_key, stripe_object_id, priority = 'primary')","

Submit Stripe credit card token to EasyPost.\n"],["create_easypost_credit_card","EasyPost::Referral","EasyPost/Referral.html#method-c-create_easypost_credit_card","(referral_api_key, stripe_object_id, priority = 'primary')","

Submit Stripe credit card token to EasyPost.\n"],["create_list","EasyPost::Tracker","EasyPost/Tracker.html#method-c-create_list","(params = {}, api_key = nil)","

Create multiple Tracker objects in bulk.\n"],["create_scan_form","EasyPost::Batch","EasyPost/Batch.html#method-i-create_scan_form","(params = {})","

Create a ScanForm for a Batch.\n"],["create_stripe_token","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-create_stripe_token","(number, expiration_month, expiration_year, cvc, easypost_stripe_token)","

Get credit card token from Stripe.\n"],["create_stripe_token","EasyPost::Referral","EasyPost/Referral.html#method-c-create_stripe_token","(number, expiration_month, expiration_year, cvc, easypost_stripe_token)","

Get credit card token from Stripe.\n"],["deconstruct_keys","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-deconstruct_keys","(_keys)","

Deconstruct the keys of an object.\n"],["default_connection","EasyPost","EasyPost.html#method-c-default_connection","()",""],["default_headers","EasyPost","EasyPost.html#method-c-default_headers","()",""],["default_http_config","EasyPost","EasyPost.html#method-c-default_http_config","()",""],["delete","EasyPost::Resource","EasyPost/Resource.html#method-i-delete","()","

Delete an EasyPost object.\n"],["delete","EasyPost::User","EasyPost/User.html#method-i-delete","()","

Delete a User.\n"],["delete","EasyPost::Webhook","EasyPost/Webhook.html#method-i-delete","()","

Delete a Webhook.\n"],["delete_payment_method","EasyPost::Billing","EasyPost/Billing.html#method-c-delete_payment_method","(primary_or_secondary, api_key = nil)","

Delete a payment method.\n"],["each","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-each","(&blk)","

Get each element of values.\n"],["each","EasyPost::Resource","EasyPost/Resource.html#method-c-each","(filters = {}, api_key = EasyPost.api_key, &block)","

Filter all results based on criteria.\n"],["flatten_unsaved","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-flatten_unsaved","()","

Flatten the unsaved values of an object.\n"],["form_encode_params","EasyPost::Util","EasyPost/Util.html#method-c-form_encode_params","(hash, parent_keys = [], parent_dict = {})","

Form-encode a multi-layer dictionary to a one-layer dictionary.\n"],["fund_wallet","EasyPost::Billing","EasyPost/Billing.html#method-c-fund_wallet","(amount, primary_or_secondary = 'primary', api_key = nil)","

Fund your EasyPost wallet by charging your primary or secondary card on file.\n"],["generate_form","EasyPost::Shipment","EasyPost/Shipment.html#method-i-generate_form","(form_type, form_options = {})","

Generate a form for a Shipment.\n"],["get_lowest_object_rate","EasyPost::Util","EasyPost/Util.html#method-c-get_lowest_object_rate","(easypost_object, carriers = [], services = [], rates_key = 'rates')","

Gets the lowest rate of an EasyPost object such as a Shipment, Order, or Pickup. You can exclude by having …\n"],["get_lowest_smartrate","EasyPost::Shipment","EasyPost/Shipment.html#method-c-get_lowest_smartrate","(smartrates, delivery_days, delivery_accuracy)","

Get the lowest smartrate from a list of smartrates.\n"],["get_payment_method_info","EasyPost::Billing","EasyPost/Billing.html#method-c-get_payment_method_info","(primary_or_secondary)","

Get payment method info (type of the payment method and ID of the payment method)\n"],["get_rates","EasyPost::Order","EasyPost/Order.html#method-i-get_rates","(params = {})","

Get the rates of an Order.\n"],["get_smartrates","EasyPost::Shipment","EasyPost/Shipment.html#method-i-get_smartrates","()","

Get the SmartRates of a Shipment.\n"],["http_config","EasyPost","EasyPost.html#method-c-http_config","()","

Get the HTTP config.\n"],["http_config=","EasyPost","EasyPost.html#method-c-http_config-3D","(http_config_params)","

Set the HTTP config.\n"],["id","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-id","()","

Get the ID of an object.\n"],["id=","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-id-3D","(id)","

Set the ID of an object.\n"],["inspect","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-inspect","()","

Inspect JSON.\n"],["insure","EasyPost::Shipment","EasyPost/Shipment.html#method-i-insure","(params = {})","

Insure a Shipment.\n"],["keys","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-keys","()","

Keys of an object.\n"],["label","EasyPost::Batch","EasyPost/Batch.html#method-i-label","(params = {})","

Convert the label format of a Batch.\n"],["label","EasyPost::Shipment","EasyPost/Shipment.html#method-i-label","(params = {})","

Convert the label format of a Shipment.\n"],["lowest_rate","EasyPost::Order","EasyPost/Order.html#method-i-lowest_rate","(carriers = [], services = [])","

Get the lowest rate of an Order (can exclude by having ‘’!‘` as the first element of your optional …\n"],["lowest_rate","EasyPost::Pickup","EasyPost/Pickup.html#method-i-lowest_rate","(carriers = [], services = [])","

Get the lowest rate of a Pickup (can exclude by having ‘’!‘` as the first element of your optional …\n"],["lowest_rate","EasyPost::Shipment","EasyPost/Shipment.html#method-i-lowest_rate","(carriers = [], services = [])","

Get the lowest rate of a Shipment (can exclude by having ‘’!‘` as the first element of your optional …\n"],["lowest_smartrate","EasyPost::Shipment","EasyPost/Shipment.html#method-i-lowest_smartrate","(delivery_days, delivery_accuracy)","

Get the lowest smartrate of a Shipment.\n"],["make_client","EasyPost","EasyPost.html#method-c-make_client","(url)","

Create an EasyPost Client.\n

@deprecated\n"],["make_request","EasyPost","EasyPost.html#method-c-make_request","(method, path, api_key = nil, body = nil)","

Make an HTTP request against the {default_connection}\n

@param method [Symbol] the HTTP Verb (get, method, …\n"],["metaclass","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-metaclass","()","

The metaclass of an object.\n"],["new","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-c-new","(id = nil, api_key = nil, parent = nil, name = nil)","

Initialize an EasyPostObject.\n"],["new","EasyPost::Error","EasyPost/Error.html#method-c-new","(message = nil, status = nil, code = nil, errors = nil, http_body = nil)","

Initialize a new EasyPost Error\n"],["normalize_string_list","EasyPost::Util","EasyPost/Util.html#method-c-normalize_string_list","(lst)","

Normalizes a list of strings.\n"],["objects_to_ids","EasyPost::Util","EasyPost/Util.html#method-c-objects_to_ids","(obj)","

Converts an object to an object ID.\n"],["os_arch","EasyPost::Util","EasyPost/Util.html#method-c-os_arch","()",""],["os_name","EasyPost::Util","EasyPost/Util.html#method-c-os_name","()",""],["os_version","EasyPost::Util","EasyPost/Util.html#method-c-os_version","()",""],["parse_response","EasyPost","EasyPost.html#method-c-parse_response","(status:, body:, json:)",""],["receive","EasyPost::Event","EasyPost/Event.html#method-c-receive","(values)","

Converts a raw webhook event into an EasyPost object.\n"],["refresh","EasyPost::Resource","EasyPost/Resource.html#method-i-refresh","()","

Refresh an object from the API response.\n"],["refresh_from","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-refresh_from","(values, api_key)","

Refresh an object from the API.\n"],["refund","EasyPost::Shipment","EasyPost/Shipment.html#method-i-refund","(params = {})","

Refund a Shipment.\n"],["regenerate_rates","EasyPost::Shipment","EasyPost/Shipment.html#method-i-regenerate_rates","(with_carbon_offset = false)","

Regenerate the rates of a Shipment.\n"],["remove_shipments","EasyPost::Batch","EasyPost/Batch.html#method-i-remove_shipments","(params = {})","

Remove Shipments from a Batch.\n"],["reset_http_config","EasyPost","EasyPost.html#method-c-reset_http_config","()","

Reset the HTTP config.\n"],["retrieve","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-c-retrieve","(id, params = {}, api_key = nil)","

Retrieves an EndShipper object. DEPRECATED: Please use EndShipper in the main namespace instead.\n"],["retrieve","EasyPost::Resource","EasyPost/Resource.html#method-c-retrieve","(id, api_key = nil)","

Retrieve an EasyPost object.\n"],["retrieve_easypost_stripe_api_key","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-retrieve_easypost_stripe_api_key","()","

Retrieve EasyPost’s Stripe public API key.\n"],["retrieve_easypost_stripe_api_key","EasyPost::Referral","EasyPost/Referral.html#method-c-retrieve_easypost_stripe_api_key","()","

Retrieve EasyPost’s Stripe public API key.\n"],["retrieve_me","EasyPost::User","EasyPost/User.html#method-c-retrieve_me","()","

Retrieve the authenticated User.\n"],["retrieve_payment_methods","EasyPost::Billing","EasyPost/Billing.html#method-c-retrieve_payment_methods","(api_key = nil)","

Retrieve all payment methods.\n"],["save","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-i-save","()","

Updates (saves) an EndShipper object. This requires all parameters to be set. DEPRECATED: Please use …\n"],["save","EasyPost::EndShipper","EasyPost/EndShipper.html#method-i-save","()","

Updates (saves) an EndShipper object. This requires all parameters to be set.\n"],["save","EasyPost::Resource","EasyPost/Resource.html#method-i-save","()","

Save (update) and EasyPost object.\n"],["save","EasyPost::User","EasyPost/User.html#method-i-save","()","

Save (update) a User.\n"],["to_hash","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-to_hash","()","

Make values a hash.\n"],["to_json","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-to_json","(_options = {})","

Make values JSON.\n"],["to_s","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-to_s","(*_args)","

Convert to a string.\n"],["to_s","EasyPost::Error","EasyPost/Error.html#method-i-to_s","()","

Convert an error to a string.\n"],["types","EasyPost::CarrierAccount","EasyPost/CarrierAccount.html#method-c-types","()","

Retrieve a list of available CarrierAccount types for the authenticated User.\n"],["update","EasyPost::Webhook","EasyPost/Webhook.html#method-i-update","(params = {})","

Update a Webhook.\n"],["update_brand","EasyPost::User","EasyPost/User.html#method-i-update_brand","(**attrs)","

Update the Brand of a User.\n"],["update_email","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-update_email","(email, user_id, api_key = nil)","

Update a referral customer. This function requires the Partner User’s API key. DEPRECATED: Please use …\n"],["update_email","EasyPost::Referral","EasyPost/Referral.html#method-c-update_email","(email, user_id, api_key = nil)","

Update a referral customer. This function requires the Partner User’s API key.\n"],["url","EasyPost::Brand","EasyPost/Brand.html#method-i-url","()","

The url of the Brand object.\n"],["url","EasyPost::Resource","EasyPost/Resource.html#method-c-url","()","

The instance url of the Resource.\n"],["url","EasyPost::Resource","EasyPost/Resource.html#method-i-url","()","

The url of the Resource.\n"],["user_agent","EasyPost","EasyPost.html#method-c-user_agent","()",""],["validate_webhook","EasyPost::Webhook","EasyPost/Webhook.html#method-c-validate_webhook","(event_body, headers, webhook_secret)","

Validate a webhook by comparing the HMAC signature header sent from EasyPost to your shared secret. …\n"],["values","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-values","()","

Values of an object.\n"],["verify","EasyPost::Address","EasyPost/Address.html#method-i-verify","()","

Verify an Address.\n"]]}}