easypost 4.9.0 → 4.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e86ea0929dfc06e0691b833ebb28f3f145bb3b648e0eb65c177289e47402971
-  data.tar.gz: 4defa28531159be78fa0201fa136626a74d30f80263c06507b31e2f8290a14e0
+  metadata.gz: 52156e3c1bbedd38fc28ccad285c19086d178a62635be174f31039d641136277
+  data.tar.gz: 3d47a62c26c9f8bb27d6430330c4502496f32652c017b4ff026577d4bdbe08bc
 SHA512:
-  metadata.gz: 5eb2a6961275e7c5f8c38d46c059eec7d50d1593ac962f639db717b483685b2c25eddcf8582ff451d378917b73633e6e5a30a9e70d58f22a742ea80b65fab644
-  data.tar.gz: 13d85999dc9b63dbd7c1895dde7b09b6ce54e5e533ce1f0d738413d4de2d63e97de4e7f99eba9a0fcfbc68706c40b192c21f5cf31b0ea8681a834edb06947a65
+  metadata.gz: 905456623de704532dbb3a3fe01b0905a455e9d7916bc53eb64d73cf64e3568221943744eaf6474ae22215118922b120dea6fa34dba295623db7c8b086d8b2b0
+  data.tar.gz: e1b316d90d6a8c5ae4411e85c07b7cf6c7a5e480de7ffeaf96f1678323971814bd248ffe79f823c0339cb896241ce0da278937671a433bb52249cb603f3b55f3

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## v4.11.0 (2023-01-18)
+
+- Added function to retrieve all pickups, accessible via `EasyPost::Pickup.all`
+- Added payload functions `retrieve_all_payloads` and `retrieve_payload` to retrieve all payloads or a specific payload for an event.
+
+## v4.10.0 (2023-01-11)
+
+- Added new beta billing functionality for referral customer users, accessible via `EasyPost::Beta::Referral`
+  - `add_payment_method` to add an existing Stripe bank account or credit card to your EasyPost account
+  - `refund_by_amount` refunds you wallet balance by a specified amount
+  - `refund_by_payment_log` refunds you wallet balance by a specified payment log
+- Fix bug where bank account and credit card payment methods were not deserializing to the `EasyPost::PaymentMethod` class
+
 ## v4.9.0 (2022-12-07)
 
 - Routes requests for creating a carrier account with a custom workflow (eg: FedEx, UPS) to the correct endpoint when using the `create` function

data/README.md

@@ -159,5 +159,5 @@ The following are required on every test run:
 Some tests may require an EasyPost user with a particular set of enabled features such as a `Partner` user when creating referrals. We have attempted to call out these functions in their respective docstrings. The following are required when you need to re-record cassettes for applicable tests:
 
 - `USPS_CARRIER_ACCOUNT_ID` (eg: one-call buying a shipment for non-EasyPost employees)
-- `PARTNER_USER_PROD_API_KEY` (eg: creating a referral user)
-- `REFERRAL_USER_PROD_API_KEY` (eg: adding a credit card to a referral user)
+- `PARTNER_USER_PROD_API_KEY` (eg: creating a referral customer)
+- `REFERRAL_CUSTOMER_PROD_API_KEY` (eg: adding a credit card to a referral customer)

data/VERSION

@@ -1 +1 @@
-4.9.0
+4.11.0

data/docs/EasyPost/Beta/Referral.html

@@ -115,7 +115,7 @@
         </div>
 
         <div class="method-description">
-          <p>Add credit card to a referral user. This function requires the <a href="Referral.html"><code>Referral</code></a> User’s API key. <strong>DEPRECATED:</strong> Please use <code>Referral</code> in the main namespace instead.</p>
+          <p>Add credit card to a referral customer. This function requires the <a href="Referral.html"><code>Referral</code></a> User’s API key. <strong>DEPRECATED:</strong> Please use <code>Referral</code> in the main namespace instead.</p>
 
           <div class="method-source-code" id="add_credit_card-source">
             <pre><span class="ruby-comment"># File lib/easypost/beta/referral.rb, line 91</span>
@@ -152,7 +152,7 @@
         </div>
 
         <div class="method-description">
-          <p>Retrieve a list of referral users. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> Please use <code>Referral</code> in the main namespace instead.</p>
+          <p>Retrieve a list of referral customers. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> Please use <code>Referral</code> in the main namespace instead.</p>
 
           <div class="method-source-code" id="all-source">
             <pre><span class="ruby-comment"># File lib/easypost/beta/referral.rb, line 83</span>
@@ -175,7 +175,7 @@
         </div>
 
         <div class="method-description">
-          <p>Create a referral user. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> Please use <code>Referral</code> in the main namespace instead.</p>
+          <p>Create a referral customer. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> Please use <code>Referral</code> in the main namespace instead.</p>
 
           <div class="method-source-code" id="create-source">
             <pre><span class="ruby-comment"># File lib/easypost/beta/referral.rb, line 60</span>
@@ -198,7 +198,7 @@
         </div>
 
         <div class="method-description">
-          <p>Update a referral user. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> Please use <code>Referral</code> in the main namespace instead.</p>
+          <p>Update a referral customer. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> Please use <code>Referral</code> in the main namespace instead.</p>
 
           <div class="method-source-code" id="update_email-source">
             <pre><span class="ruby-comment"># File lib/easypost/beta/referral.rb, line 68</span>

data/docs/EasyPost/Referral.html

@@ -115,7 +115,7 @@
         </div>
 
         <div class="method-description">
-          <p>Add credit card to a referral user. This function requires the <a href="Referral.html"><code>Referral</code></a> User’s API key.</p>
+          <p>Add credit card to a referral customer. This function requires the <a href="Referral.html"><code>Referral</code></a> User’s API key.</p>
 
           <div class="method-source-code" id="add_credit_card-source">
             <pre><span class="ruby-comment"># File lib/easypost/referral.rb, line 84</span>
@@ -151,7 +151,7 @@
         </div>
 
         <div class="method-description">
-          <p>Retrieve a list of referral users. This function requires the Partner User’s API key.</p>
+          <p>Retrieve a list of referral customers. This function requires the Partner User’s API key.</p>
 
           <div class="method-source-code" id="all-source">
             <pre><span class="ruby-comment"># File lib/easypost/referral.rb, line 78</span>
@@ -173,7 +173,7 @@
         </div>
 
         <div class="method-description">
-          <p>Create a referral user. This function requires the Partner User’s API key.</p>
+          <p>Create a referral customer. This function requires the Partner User’s API key.</p>
 
           <div class="method-source-code" id="create-source">
             <pre><span class="ruby-comment"># File lib/easypost/referral.rb, line 59</span>
@@ -195,7 +195,7 @@
         </div>
 
         <div class="method-description">
-          <p>Update a referral user. This function requires the Partner User’s API key.</p>
+          <p>Update a referral customer. This function requires the Partner User’s API key.</p>
 
           <div class="method-source-code" id="update_email-source">
             <pre><span class="ruby-comment"># File lib/easypost/referral.rb, line 65</span>

data/docs/js/search_index.js

@@ -1 +1 @@
-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","","<p>Address objects are used to represent people, places, and organizations in a number of contexts.\n"],["EasyPost::ApiKey","","EasyPost/ApiKey.html","","<p>An ApiKey allows you to authenticate with the EasyPost API.\n"],["EasyPost::Batch","","EasyPost/Batch.html","","<p>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","","<p>EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon …\n"],["EasyPost::Beta::Referral","","EasyPost/Beta/Referral.html","","<p>Referral objects are User objects created from a Partner user.\n"],["EasyPost::Billing","","EasyPost/Billing.html","","<p>Billing class that users can manage their payment and fund\n"],["EasyPost::Brand","","EasyPost/Brand.html","","<p>The Brand object allows you to customize the publicly-accessible html page that shows tracking details …\n"],["EasyPost::CarbonOffset","","EasyPost/CarbonOffset.html","","<p>The CarbonOffset object is a summary of carbon offset data for a given rate, including grams, price and …\n"],["EasyPost::CarrierAccount","","EasyPost/CarrierAccount.html","","<p>A CarrierAccount encapsulates your credentials with the carrier.\n"],["EasyPost::CarrierType","","EasyPost/CarrierType.html","","<p>The CarrierType object provides an interface for determining the valid fields of a CarrierAccount.\n"],["EasyPost::CustomsInfo","","EasyPost/CustomsInfo.html","","<p>CustomsInfo objects contain CustomsItem objects and all necessary information for the generation of customs …\n"],["EasyPost::CustomsItem","","EasyPost/CustomsItem.html","","<p>A CustomsItem object describes goods for international shipment and should be created then included in …\n"],["EasyPost::EasyPostObject","","EasyPost/EasyPostObject.html","","<p>The EasyPostObject is extended by the EasyPost Resource object.\n"],["EasyPost::EndShipper","","EasyPost/EndShipper.html","","<p>EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon …\n"],["EasyPost::Error","","EasyPost/Error.html","","<p>EasyPost Error object.\n"],["EasyPost::Event","","EasyPost/Event.html","","<p>Webhook Events are triggered by changes in objects you’ve created via the API.\n"],["EasyPost::Insurance","","EasyPost/Insurance.html","","<p>An Insurance object represents insurance for packages purchased both via the EasyPost API as well as …\n"],["EasyPost::Order","","EasyPost/Order.html","","<p>The Order object represents a collection of packages and can be used for Multi-Piece Shipments.\n"],["EasyPost::Parcel","","EasyPost/Parcel.html","","<p>Parcel objects represent the physical container being shipped.\n"],["EasyPost::PaymentMethod","","EasyPost/PaymentMethod.html","","<p>PaymentMethod objects represent a payment method of a user.\n"],["EasyPost::Pickup","","EasyPost/Pickup.html","","<p>The Pickup object allows you to schedule a pickup from your carrier from your customer’s residence …\n"],["EasyPost::PickupRate","","EasyPost/PickupRate.html","","<p>A PickupRate is the rate available for a Pickup.\n"],["EasyPost::PostageLabel","","EasyPost/PostageLabel.html","","<p>PostageLabel is the object containing details about the shipping label.\n"],["EasyPost::Rate","","EasyPost/Rate.html","","<p>A Rate object contains all the details about the rate of a Shipment.\n"],["EasyPost::Referral","","EasyPost/Referral.html","","<p>Referral objects are User objects created from a Partner user.\n"],["EasyPost::Refund","","EasyPost/Refund.html","","<p>The Refund object contains details about the Refund of a Shipment.\n"],["EasyPost::Report","","EasyPost/Report.html","","<p>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","","<p>The Resource object is extended by each EasyPost object.\n"],["EasyPost::ScanForm","","EasyPost/ScanForm.html","","<p>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","","<p>The workhorse of the EasyPost API, a Shipment is made up of a “to” and “from” Address …\n"],["EasyPost::TaxIdentifier","","EasyPost/TaxIdentifier.html","","<p>TaxIdentifiers are identifying numbers or IDs that are used to charge a specific party when dealing with …\n"],["EasyPost::Tracker","","EasyPost/Tracker.html","","<p>A Tracker object contains all of the tracking information for a package.\n"],["EasyPost::User","","EasyPost/User.html","","<p>The User object can be used to manage your own account and to create child accounts.\n"],["EasyPost::Util","","EasyPost/Util.html","","<p>Internal utilities helpful for this libraries operation.\n"],["EasyPost::Webhook","","EasyPost/Webhook.html","","<p>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)","<p>Compare error properties.\n"],["[]","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-5B-5D","(key)","<p>Get element of an array.\n"],["[]=","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-5B-5D-3D","(key, value)","<p>Set the element of an array.\n"],["add_accessors","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-add_accessors","(keys)","<p>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')","<p>Add credit card to a referral user. This function requires the Referral User’s API key. <strong>DEPRECATED:</strong> …\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')","<p>Add credit card to a referral user. This function requires the Referral User’s API key.\n"],["add_shipments","EasyPost::Batch","EasyPost/Batch.html#method-i-add_shipments","(params = {})","<p>Add Shipments to a Batch.\n"],["all","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-c-all","(params = {}, api_key = nil)","<p>Retrieves a list of EndShipper objects. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead. …\n"],["all","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-all","(params = {}, api_key = nil)","<p>Retrieve a list of referral users. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> …\n"],["all","EasyPost::CustomsInfo","EasyPost/CustomsInfo.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieve a list of CustomsInfo objects\n"],["all","EasyPost::CustomsItem","EasyPost/CustomsItem.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieve a list of CustomsItem objects\n"],["all","EasyPost::Order","EasyPost/Order.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieve a list of Order objects.\n"],["all","EasyPost::Parcel","EasyPost/Parcel.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieving all Parcel objects is not supported.\n"],["all","EasyPost::PaymentMethod","EasyPost/PaymentMethod.html#method-c-all","(_filters = {}, api_key = nil)","<p><strong>DEPRECATED:</strong> Please use <code>Billing class</code> instead. Deprecated: v4.5.0 - v6.0.0\n"],["all","EasyPost::Pickup","EasyPost/Pickup.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieve a list of all Pickup objects.\n"],["all","EasyPost::Rate","EasyPost/Rate.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieving all Rate objects is not supported.\n"],["all","EasyPost::Referral","EasyPost/Referral.html#method-c-all","(params = {}, api_key = nil)","<p>Retrieve a list of referral users. This function requires the Partner User’s API key.\n"],["all","EasyPost::Report","EasyPost/Report.html#method-c-all","(filters = {}, api_key = nil)","<p>Retrieve a list of Report objects.\n"],["all","EasyPost::Resource","EasyPost/Resource.html#method-c-all","(filters = {}, api_key = nil)","<p>Retrieve a list of EasyPost objects.\n"],["all_api_keys","EasyPost::User","EasyPost/User.html#method-c-all_api_keys","()","<p>Retrieve a list of ApiKey objects.\n"],["api_keys","EasyPost::User","EasyPost/User.html#method-i-api_keys","()","<p>Retrieve a list of ApiKey objects of a child User.\n"],["as_json","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-as_json","(_options = {})","<p>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)","<p>Build a dict key from a list of keys. Example: [code, number] -&gt; code\n"],["buy","EasyPost::Batch","EasyPost/Batch.html#method-i-buy","(params = {})","<p>Buy a Batch.\n"],["buy","EasyPost::Order","EasyPost/Order.html#method-i-buy","(params = {})","<p>Buy an Order.\n"],["buy","EasyPost::Pickup","EasyPost/Pickup.html#method-i-buy","(params = {})","<p>Buy a Pickup.\n"],["buy","EasyPost::Shipment","EasyPost/Shipment.html#method-i-buy","(params = {}, with_carbon_offset = false, end_shipper_id = nil)","<p>Buy a Shipment.\n"],["cancel","EasyPost::Pickup","EasyPost/Pickup.html#method-i-cancel","(params = {})","<p>Cancel a Pickup.\n"],["class_name","EasyPost::Resource","EasyPost/Resource.html#method-c-class_name","()","<p>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)","<p>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)","<p>Convert data to an EasyPost Object.\n"],["create","EasyPost::Address","EasyPost/Address.html#method-c-create","(params = {}, api_key = nil)","<p>Create an Address.\n"],["create","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-c-create","(params = {}, api_key = nil)","<p>Create an EndShipper object. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead.\n"],["create","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-create","(params = {}, api_key = nil)","<p>Create a referral user. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> Please use …\n"],["create","EasyPost::EndShipper","EasyPost/EndShipper.html#method-c-create","(params = {}, api_key = nil)","<p>Create an EndShipper object.\n"],["create","EasyPost::Referral","EasyPost/Referral.html#method-c-create","(params = {}, api_key = nil)","<p>Create a referral user. This function requires the Partner User’s API key.\n"],["create","EasyPost::Report","EasyPost/Report.html#method-c-create","(params = {}, api_key = nil)","<p>Create a Report.\n"],["create","EasyPost::Resource","EasyPost/Resource.html#method-c-create","(params = {}, api_key = nil)","<p>Create an EasyPost object.\n"],["create","EasyPost::ScanForm","EasyPost/ScanForm.html#method-c-create","(params = {}, api_key = nil)","<p>Create a ScanForm.\n"],["create","EasyPost::Shipment","EasyPost/Shipment.html#method-c-create","(params = {}, api_key = nil, with_carbon_offset = false)","<p>Create a Shipment.\n"],["create","EasyPost::User","EasyPost/User.html#method-c-create","(params = {}, api_key = nil)","<p>Create a child User.\n"],["create_and_buy","EasyPost::Batch","EasyPost/Batch.html#method-c-create_and_buy","(params = {}, api_key = nil)","<p>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)","<p>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')","<p>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')","<p>Submit Stripe credit card token to EasyPost.\n"],["create_list","EasyPost::Tracker","EasyPost/Tracker.html#method-c-create_list","(params = {}, api_key = nil)","<p>Create multiple Tracker objects in bulk.\n"],["create_scan_form","EasyPost::Batch","EasyPost/Batch.html#method-i-create_scan_form","(params = {})","<p>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)","<p>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)","<p>Get credit card token from Stripe.\n"],["deconstruct_keys","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-deconstruct_keys","(_keys)","<p>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","()","<p>Delete an EasyPost object.\n"],["delete","EasyPost::User","EasyPost/User.html#method-i-delete","()","<p>Delete a User.\n"],["delete","EasyPost::Webhook","EasyPost/Webhook.html#method-i-delete","()","<p>Delete a Webhook.\n"],["delete_payment_method","EasyPost::Billing","EasyPost/Billing.html#method-c-delete_payment_method","(primary_or_secondary, api_key = nil)","<p>Delete a payment method.\n"],["each","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-each","(&blk)","<p>Get each element of values.\n"],["each","EasyPost::Resource","EasyPost/Resource.html#method-c-each","(filters = {}, api_key = EasyPost.api_key, &block)","<p>Filter all results based on criteria.\n"],["flatten_unsaved","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-flatten_unsaved","()","<p>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 = {})","<p>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)","<p>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 = {})","<p>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')","<p>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)","<p>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)","<p>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 = {})","<p>Get the rates of an Order.\n"],["get_smartrates","EasyPost::Shipment","EasyPost/Shipment.html#method-i-get_smartrates","()","<p>Get the SmartRates of a Shipment.\n"],["http_config","EasyPost","EasyPost.html#method-c-http_config","()","<p>Get the HTTP config.\n"],["http_config=","EasyPost","EasyPost.html#method-c-http_config-3D","(http_config_params)","<p>Set the HTTP config.\n"],["id","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-id","()","<p>Get the ID of an object.\n"],["id=","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-id-3D","(id)","<p>Set the ID of an object.\n"],["inspect","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-inspect","()","<p>Inspect JSON.\n"],["insure","EasyPost::Shipment","EasyPost/Shipment.html#method-i-insure","(params = {})","<p>Insure a Shipment.\n"],["keys","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-keys","()","<p>Keys of an object.\n"],["label","EasyPost::Batch","EasyPost/Batch.html#method-i-label","(params = {})","<p>Convert the label format of a Batch.\n"],["label","EasyPost::Shipment","EasyPost/Shipment.html#method-i-label","(params = {})","<p>Convert the label format of a Shipment.\n"],["lowest_rate","EasyPost::Order","EasyPost/Order.html#method-i-lowest_rate","(carriers = [], services = [])","<p>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 = [])","<p>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 = [])","<p>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)","<p>Get the lowest smartrate of a Shipment.\n"],["make_client","EasyPost","EasyPost.html#method-c-make_client","(url)","<p>Create an EasyPost Client.\n<p>@deprecated\n"],["make_request","EasyPost","EasyPost.html#method-c-make_request","(method, path, api_key = nil, body = nil)","<p>Make an HTTP request against the {default_connection}\n<p>@param method [Symbol] the HTTP Verb (get, method, …\n"],["metaclass","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-metaclass","()","<p>The metaclass of an object.\n"],["new","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-c-new","(id = nil, api_key = nil, parent = nil, name = nil)","<p>Initialize an EasyPostObject.\n"],["new","EasyPost::Error","EasyPost/Error.html#method-c-new","(message = nil, status = nil, code = nil, errors = nil, http_body = nil)","<p>Initialize a new EasyPost Error\n"],["normalize_string_list","EasyPost::Util","EasyPost/Util.html#method-c-normalize_string_list","(lst)","<p>Normalizes a list of strings.\n"],["objects_to_ids","EasyPost::Util","EasyPost/Util.html#method-c-objects_to_ids","(obj)","<p>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)","<p>Converts a raw webhook event into an EasyPost object.\n"],["refresh","EasyPost::Resource","EasyPost/Resource.html#method-i-refresh","()","<p>Refresh an object from the API response.\n"],["refresh_from","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-refresh_from","(values, api_key)","<p>Refresh an object from the API.\n"],["refund","EasyPost::Shipment","EasyPost/Shipment.html#method-i-refund","(params = {})","<p>Refund a Shipment.\n"],["regenerate_rates","EasyPost::Shipment","EasyPost/Shipment.html#method-i-regenerate_rates","(with_carbon_offset = false)","<p>Regenerate the rates of a Shipment.\n"],["remove_shipments","EasyPost::Batch","EasyPost/Batch.html#method-i-remove_shipments","(params = {})","<p>Remove Shipments from a Batch.\n"],["reset_http_config","EasyPost","EasyPost.html#method-c-reset_http_config","()","<p>Reset the HTTP config.\n"],["retrieve","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-c-retrieve","(id, params = {}, api_key = nil)","<p>Retrieves an EndShipper object. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead.\n"],["retrieve","EasyPost::Resource","EasyPost/Resource.html#method-c-retrieve","(id, api_key = nil)","<p>Retrieve an EasyPost object.\n"],["retrieve_easypost_stripe_api_key","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-retrieve_easypost_stripe_api_key","()","<p>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","()","<p>Retrieve EasyPost’s Stripe public API key.\n"],["retrieve_me","EasyPost::User","EasyPost/User.html#method-c-retrieve_me","()","<p>Retrieve the authenticated User.\n"],["retrieve_payment_methods","EasyPost::Billing","EasyPost/Billing.html#method-c-retrieve_payment_methods","(api_key = nil)","<p>Retrieve all payment methods.\n"],["save","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-i-save","()","<p>Updates (saves) an EndShipper object. This requires all parameters to be set. <strong>DEPRECATED:</strong> Please use …\n"],["save","EasyPost::EndShipper","EasyPost/EndShipper.html#method-i-save","()","<p>Updates (saves) an EndShipper object. This requires all parameters to be set.\n"],["save","EasyPost::Resource","EasyPost/Resource.html#method-i-save","()","<p>Save (update) and EasyPost object.\n"],["save","EasyPost::User","EasyPost/User.html#method-i-save","()","<p>Save (update) a User.\n"],["to_hash","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-to_hash","()","<p>Make values a hash.\n"],["to_json","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-to_json","(_options = {})","<p>Make values JSON.\n"],["to_s","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-to_s","(*_args)","<p>Convert to a string.\n"],["to_s","EasyPost::Error","EasyPost/Error.html#method-i-to_s","()","<p>Convert an error to a string.\n"],["types","EasyPost::CarrierAccount","EasyPost/CarrierAccount.html#method-c-types","()","<p>Retrieve a list of available CarrierAccount types for the authenticated User.\n"],["update","EasyPost::Webhook","EasyPost/Webhook.html#method-i-update","(params = {})","<p>Update a Webhook.\n"],["update_brand","EasyPost::User","EasyPost/User.html#method-i-update_brand","(**attrs)","<p>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)","<p>Update a referral user. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> Please use …\n"],["update_email","EasyPost::Referral","EasyPost/Referral.html#method-c-update_email","(email, user_id, api_key = nil)","<p>Update a referral user. This function requires the Partner User’s API key.\n"],["url","EasyPost::Brand","EasyPost/Brand.html#method-i-url","()","<p>The url of the Brand object.\n"],["url","EasyPost::Resource","EasyPost/Resource.html#method-c-url","()","<p>The instance url of the Resource.\n"],["url","EasyPost::Resource","EasyPost/Resource.html#method-i-url","()","<p>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)","<p>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","()","<p>Values of an object.\n"],["verify","EasyPost::Address","EasyPost/Address.html#method-i-verify","()","<p>Verify an Address.\n"]]}}
+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","","<p>Address objects are used to represent people, places, and organizations in a number of contexts.\n"],["EasyPost::ApiKey","","EasyPost/ApiKey.html","","<p>An ApiKey allows you to authenticate with the EasyPost API.\n"],["EasyPost::Batch","","EasyPost/Batch.html","","<p>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","","<p>EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon …\n"],["EasyPost::Beta::Referral","","EasyPost/Beta/Referral.html","","<p>Referral objects are User objects created from a Partner user.\n"],["EasyPost::Billing","","EasyPost/Billing.html","","<p>Billing class that users can manage their payment and fund\n"],["EasyPost::Brand","","EasyPost/Brand.html","","<p>The Brand object allows you to customize the publicly-accessible html page that shows tracking details …\n"],["EasyPost::CarbonOffset","","EasyPost/CarbonOffset.html","","<p>The CarbonOffset object is a summary of carbon offset data for a given rate, including grams, price and …\n"],["EasyPost::CarrierAccount","","EasyPost/CarrierAccount.html","","<p>A CarrierAccount encapsulates your credentials with the carrier.\n"],["EasyPost::CarrierType","","EasyPost/CarrierType.html","","<p>The CarrierType object provides an interface for determining the valid fields of a CarrierAccount.\n"],["EasyPost::CustomsInfo","","EasyPost/CustomsInfo.html","","<p>CustomsInfo objects contain CustomsItem objects and all necessary information for the generation of customs …\n"],["EasyPost::CustomsItem","","EasyPost/CustomsItem.html","","<p>A CustomsItem object describes goods for international shipment and should be created then included in …\n"],["EasyPost::EasyPostObject","","EasyPost/EasyPostObject.html","","<p>The EasyPostObject is extended by the EasyPost Resource object.\n"],["EasyPost::EndShipper","","EasyPost/EndShipper.html","","<p>EndShipper objects are fully-qualified Address objects that require all parameters and get verified upon …\n"],["EasyPost::Error","","EasyPost/Error.html","","<p>EasyPost Error object.\n"],["EasyPost::Event","","EasyPost/Event.html","","<p>Webhook Events are triggered by changes in objects you’ve created via the API.\n"],["EasyPost::Insurance","","EasyPost/Insurance.html","","<p>An Insurance object represents insurance for packages purchased both via the EasyPost API as well as …\n"],["EasyPost::Order","","EasyPost/Order.html","","<p>The Order object represents a collection of packages and can be used for Multi-Piece Shipments.\n"],["EasyPost::Parcel","","EasyPost/Parcel.html","","<p>Parcel objects represent the physical container being shipped.\n"],["EasyPost::PaymentMethod","","EasyPost/PaymentMethod.html","","<p>PaymentMethod objects represent a payment method of a user.\n"],["EasyPost::Pickup","","EasyPost/Pickup.html","","<p>The Pickup object allows you to schedule a pickup from your carrier from your customer’s residence …\n"],["EasyPost::PickupRate","","EasyPost/PickupRate.html","","<p>A PickupRate is the rate available for a Pickup.\n"],["EasyPost::PostageLabel","","EasyPost/PostageLabel.html","","<p>PostageLabel is the object containing details about the shipping label.\n"],["EasyPost::Rate","","EasyPost/Rate.html","","<p>A Rate object contains all the details about the rate of a Shipment.\n"],["EasyPost::Referral","","EasyPost/Referral.html","","<p>Referral objects are User objects created from a Partner user.\n"],["EasyPost::Refund","","EasyPost/Refund.html","","<p>The Refund object contains details about the Refund of a Shipment.\n"],["EasyPost::Report","","EasyPost/Report.html","","<p>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","","<p>The Resource object is extended by each EasyPost object.\n"],["EasyPost::ScanForm","","EasyPost/ScanForm.html","","<p>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","","<p>The workhorse of the EasyPost API, a Shipment is made up of a “to” and “from” Address …\n"],["EasyPost::TaxIdentifier","","EasyPost/TaxIdentifier.html","","<p>TaxIdentifiers are identifying numbers or IDs that are used to charge a specific party when dealing with …\n"],["EasyPost::Tracker","","EasyPost/Tracker.html","","<p>A Tracker object contains all of the tracking information for a package.\n"],["EasyPost::User","","EasyPost/User.html","","<p>The User object can be used to manage your own account and to create child accounts.\n"],["EasyPost::Util","","EasyPost/Util.html","","<p>Internal utilities helpful for this libraries operation.\n"],["EasyPost::Webhook","","EasyPost/Webhook.html","","<p>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)","<p>Compare error properties.\n"],["[]","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-5B-5D","(key)","<p>Get element of an array.\n"],["[]=","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-5B-5D-3D","(key, value)","<p>Set the element of an array.\n"],["add_accessors","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-add_accessors","(keys)","<p>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')","<p>Add credit card to a referral customer. This function requires the Referral Customer’s API key. <strong>DEPRECATED:</strong> …\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')","<p>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 = {})","<p>Add Shipments to a Batch.\n"],["all","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-c-all","(params = {}, api_key = nil)","<p>Retrieves a list of EndShipper objects. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead. …\n"],["all","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-all","(params = {}, api_key = nil)","<p>Retrieve a list of referral customers. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> …\n"],["all","EasyPost::CustomsInfo","EasyPost/CustomsInfo.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieve a list of CustomsInfo objects\n"],["all","EasyPost::CustomsItem","EasyPost/CustomsItem.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieve a list of CustomsItem objects\n"],["all","EasyPost::Order","EasyPost/Order.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieve a list of Order objects.\n"],["all","EasyPost::Parcel","EasyPost/Parcel.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieving all Parcel objects is not supported.\n"],["all","EasyPost::PaymentMethod","EasyPost/PaymentMethod.html#method-c-all","(_filters = {}, api_key = nil)","<p><strong>DEPRECATED:</strong> Please use <code>Billing class</code> instead. Deprecated: v4.5.0 - v6.0.0\n"],["all","EasyPost::Pickup","EasyPost/Pickup.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieve a list of all Pickup objects.\n"],["all","EasyPost::Rate","EasyPost/Rate.html#method-c-all","(_filters = {}, _api_key = nil)","<p>Retrieving all Rate objects is not supported.\n"],["all","EasyPost::Referral","EasyPost/Referral.html#method-c-all","(params = {}, api_key = nil)","<p>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)","<p>Retrieve a list of Report objects.\n"],["all","EasyPost::Resource","EasyPost/Resource.html#method-c-all","(filters = {}, api_key = nil)","<p>Retrieve a list of EasyPost objects.\n"],["all_api_keys","EasyPost::User","EasyPost/User.html#method-c-all_api_keys","()","<p>Retrieve a list of ApiKey objects.\n"],["api_keys","EasyPost::User","EasyPost/User.html#method-i-api_keys","()","<p>Retrieve a list of ApiKey objects of a child User.\n"],["as_json","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-as_json","(_options = {})","<p>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)","<p>Build a dict key from a list of keys. Example: [code, number] -&gt; code\n"],["buy","EasyPost::Batch","EasyPost/Batch.html#method-i-buy","(params = {})","<p>Buy a Batch.\n"],["buy","EasyPost::Order","EasyPost/Order.html#method-i-buy","(params = {})","<p>Buy an Order.\n"],["buy","EasyPost::Pickup","EasyPost/Pickup.html#method-i-buy","(params = {})","<p>Buy a Pickup.\n"],["buy","EasyPost::Shipment","EasyPost/Shipment.html#method-i-buy","(params = {}, with_carbon_offset = false, end_shipper_id = nil)","<p>Buy a Shipment.\n"],["cancel","EasyPost::Pickup","EasyPost/Pickup.html#method-i-cancel","(params = {})","<p>Cancel a Pickup.\n"],["class_name","EasyPost::Resource","EasyPost/Resource.html#method-c-class_name","()","<p>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)","<p>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)","<p>Convert data to an EasyPost Object.\n"],["create","EasyPost::Address","EasyPost/Address.html#method-c-create","(params = {}, api_key = nil)","<p>Create an Address.\n"],["create","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-c-create","(params = {}, api_key = nil)","<p>Create an EndShipper object. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead.\n"],["create","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-create","(params = {}, api_key = nil)","<p>Create a referral customer. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> Please use …\n"],["create","EasyPost::EndShipper","EasyPost/EndShipper.html#method-c-create","(params = {}, api_key = nil)","<p>Create an EndShipper object.\n"],["create","EasyPost::Referral","EasyPost/Referral.html#method-c-create","(params = {}, api_key = nil)","<p>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)","<p>Create a Report.\n"],["create","EasyPost::Resource","EasyPost/Resource.html#method-c-create","(params = {}, api_key = nil)","<p>Create an EasyPost object.\n"],["create","EasyPost::ScanForm","EasyPost/ScanForm.html#method-c-create","(params = {}, api_key = nil)","<p>Create a ScanForm.\n"],["create","EasyPost::Shipment","EasyPost/Shipment.html#method-c-create","(params = {}, api_key = nil, with_carbon_offset = false)","<p>Create a Shipment.\n"],["create","EasyPost::User","EasyPost/User.html#method-c-create","(params = {}, api_key = nil)","<p>Create a child User.\n"],["create_and_buy","EasyPost::Batch","EasyPost/Batch.html#method-c-create_and_buy","(params = {}, api_key = nil)","<p>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)","<p>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')","<p>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')","<p>Submit Stripe credit card token to EasyPost.\n"],["create_list","EasyPost::Tracker","EasyPost/Tracker.html#method-c-create_list","(params = {}, api_key = nil)","<p>Create multiple Tracker objects in bulk.\n"],["create_scan_form","EasyPost::Batch","EasyPost/Batch.html#method-i-create_scan_form","(params = {})","<p>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)","<p>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)","<p>Get credit card token from Stripe.\n"],["deconstruct_keys","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-deconstruct_keys","(_keys)","<p>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","()","<p>Delete an EasyPost object.\n"],["delete","EasyPost::User","EasyPost/User.html#method-i-delete","()","<p>Delete a User.\n"],["delete","EasyPost::Webhook","EasyPost/Webhook.html#method-i-delete","()","<p>Delete a Webhook.\n"],["delete_payment_method","EasyPost::Billing","EasyPost/Billing.html#method-c-delete_payment_method","(primary_or_secondary, api_key = nil)","<p>Delete a payment method.\n"],["each","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-each","(&blk)","<p>Get each element of values.\n"],["each","EasyPost::Resource","EasyPost/Resource.html#method-c-each","(filters = {}, api_key = EasyPost.api_key, &block)","<p>Filter all results based on criteria.\n"],["flatten_unsaved","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-flatten_unsaved","()","<p>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 = {})","<p>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)","<p>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 = {})","<p>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')","<p>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)","<p>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)","<p>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 = {})","<p>Get the rates of an Order.\n"],["get_smartrates","EasyPost::Shipment","EasyPost/Shipment.html#method-i-get_smartrates","()","<p>Get the SmartRates of a Shipment.\n"],["http_config","EasyPost","EasyPost.html#method-c-http_config","()","<p>Get the HTTP config.\n"],["http_config=","EasyPost","EasyPost.html#method-c-http_config-3D","(http_config_params)","<p>Set the HTTP config.\n"],["id","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-id","()","<p>Get the ID of an object.\n"],["id=","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-id-3D","(id)","<p>Set the ID of an object.\n"],["inspect","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-inspect","()","<p>Inspect JSON.\n"],["insure","EasyPost::Shipment","EasyPost/Shipment.html#method-i-insure","(params = {})","<p>Insure a Shipment.\n"],["keys","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-keys","()","<p>Keys of an object.\n"],["label","EasyPost::Batch","EasyPost/Batch.html#method-i-label","(params = {})","<p>Convert the label format of a Batch.\n"],["label","EasyPost::Shipment","EasyPost/Shipment.html#method-i-label","(params = {})","<p>Convert the label format of a Shipment.\n"],["lowest_rate","EasyPost::Order","EasyPost/Order.html#method-i-lowest_rate","(carriers = [], services = [])","<p>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 = [])","<p>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 = [])","<p>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)","<p>Get the lowest smartrate of a Shipment.\n"],["make_client","EasyPost","EasyPost.html#method-c-make_client","(url)","<p>Create an EasyPost Client.\n<p>@deprecated\n"],["make_request","EasyPost","EasyPost.html#method-c-make_request","(method, path, api_key = nil, body = nil)","<p>Make an HTTP request against the {default_connection}\n<p>@param method [Symbol] the HTTP Verb (get, method, …\n"],["metaclass","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-metaclass","()","<p>The metaclass of an object.\n"],["new","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-c-new","(id = nil, api_key = nil, parent = nil, name = nil)","<p>Initialize an EasyPostObject.\n"],["new","EasyPost::Error","EasyPost/Error.html#method-c-new","(message = nil, status = nil, code = nil, errors = nil, http_body = nil)","<p>Initialize a new EasyPost Error\n"],["normalize_string_list","EasyPost::Util","EasyPost/Util.html#method-c-normalize_string_list","(lst)","<p>Normalizes a list of strings.\n"],["objects_to_ids","EasyPost::Util","EasyPost/Util.html#method-c-objects_to_ids","(obj)","<p>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)","<p>Converts a raw webhook event into an EasyPost object.\n"],["refresh","EasyPost::Resource","EasyPost/Resource.html#method-i-refresh","()","<p>Refresh an object from the API response.\n"],["refresh_from","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-refresh_from","(values, api_key)","<p>Refresh an object from the API.\n"],["refund","EasyPost::Shipment","EasyPost/Shipment.html#method-i-refund","(params = {})","<p>Refund a Shipment.\n"],["regenerate_rates","EasyPost::Shipment","EasyPost/Shipment.html#method-i-regenerate_rates","(with_carbon_offset = false)","<p>Regenerate the rates of a Shipment.\n"],["remove_shipments","EasyPost::Batch","EasyPost/Batch.html#method-i-remove_shipments","(params = {})","<p>Remove Shipments from a Batch.\n"],["reset_http_config","EasyPost","EasyPost.html#method-c-reset_http_config","()","<p>Reset the HTTP config.\n"],["retrieve","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-c-retrieve","(id, params = {}, api_key = nil)","<p>Retrieves an EndShipper object. <strong>DEPRECATED:</strong> Please use <code>EndShipper</code> in the main namespace instead.\n"],["retrieve","EasyPost::Resource","EasyPost/Resource.html#method-c-retrieve","(id, api_key = nil)","<p>Retrieve an EasyPost object.\n"],["retrieve_easypost_stripe_api_key","EasyPost::Beta::Referral","EasyPost/Beta/Referral.html#method-c-retrieve_easypost_stripe_api_key","()","<p>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","()","<p>Retrieve EasyPost’s Stripe public API key.\n"],["retrieve_me","EasyPost::User","EasyPost/User.html#method-c-retrieve_me","()","<p>Retrieve the authenticated User.\n"],["retrieve_payment_methods","EasyPost::Billing","EasyPost/Billing.html#method-c-retrieve_payment_methods","(api_key = nil)","<p>Retrieve all payment methods.\n"],["save","EasyPost::Beta::EndShipper","EasyPost/Beta/EndShipper.html#method-i-save","()","<p>Updates (saves) an EndShipper object. This requires all parameters to be set. <strong>DEPRECATED:</strong> Please use …\n"],["save","EasyPost::EndShipper","EasyPost/EndShipper.html#method-i-save","()","<p>Updates (saves) an EndShipper object. This requires all parameters to be set.\n"],["save","EasyPost::Resource","EasyPost/Resource.html#method-i-save","()","<p>Save (update) and EasyPost object.\n"],["save","EasyPost::User","EasyPost/User.html#method-i-save","()","<p>Save (update) a User.\n"],["to_hash","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-to_hash","()","<p>Make values a hash.\n"],["to_json","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-to_json","(_options = {})","<p>Make values JSON.\n"],["to_s","EasyPost::EasyPostObject","EasyPost/EasyPostObject.html#method-i-to_s","(*_args)","<p>Convert to a string.\n"],["to_s","EasyPost::Error","EasyPost/Error.html#method-i-to_s","()","<p>Convert an error to a string.\n"],["types","EasyPost::CarrierAccount","EasyPost/CarrierAccount.html#method-c-types","()","<p>Retrieve a list of available CarrierAccount types for the authenticated User.\n"],["update","EasyPost::Webhook","EasyPost/Webhook.html#method-i-update","(params = {})","<p>Update a Webhook.\n"],["update_brand","EasyPost::User","EasyPost/User.html#method-i-update_brand","(**attrs)","<p>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)","<p>Update a referral customer. This function requires the Partner User’s API key. <strong>DEPRECATED:</strong> Please use …\n"],["update_email","EasyPost::Referral","EasyPost/Referral.html#method-c-update_email","(email, user_id, api_key = nil)","<p>Update a referral customer. This function requires the Partner User’s API key.\n"],["url","EasyPost::Brand","EasyPost/Brand.html#method-i-url","()","<p>The url of the Brand object.\n"],["url","EasyPost::Resource","EasyPost/Resource.html#method-c-url","()","<p>The instance url of the Resource.\n"],["url","EasyPost::Resource","EasyPost/Resource.html#method-i-url","()","<p>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)","<p>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","()","<p>Values of an object.\n"],["verify","EasyPost::Address","EasyPost/Address.html#method-i-verify","()","<p>Verify an Address.\n"]]}}

data/lib/easypost/beta/payment_refund.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# PaymentRefund objects represent a refund of a payment.
+class EasyPost::Beta::PaymentRefund < EasyPost::Resource
+end

data/lib/easypost/beta/referral.rb

@@ -55,7 +55,7 @@ class EasyPost::Beta::Referral < EasyPost::Resource
     end
   end
 
-  # Create a referral user. This function requires the Partner User's API key.
+  # Create a referral customer. This function requires the Partner User's API key.
   # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
   def self.create(params = {}, api_key = nil)
     warn '[DEPRECATION] Please use `Referral.create` in the main namespace instead.'
@@ -63,7 +63,7 @@ class EasyPost::Beta::Referral < EasyPost::Resource
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
-  # Update a referral user. This function requires the Partner User's API key.
+  # Update a referral customer. This function requires the Partner User's API key.
   # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
   def self.update_email(email, user_id, api_key = nil)
     warn '[DEPRECATION] Please use `Referral.update_email` in the main namespace instead.'
@@ -78,7 +78,7 @@ class EasyPost::Beta::Referral < EasyPost::Resource
     true
   end
 
-  # Retrieve a list of referral users. This function requires the Partner User's API key.
+  # Retrieve a list of referral customers. This function requires the Partner User's API key.
   # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
   def self.all(params = {}, api_key = nil)
     warn '[DEPRECATION] Please use `Referral.all` in the main namespace instead.'
@@ -86,7 +86,7 @@ class EasyPost::Beta::Referral < EasyPost::Resource
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
-  # Add credit card to a referral user. This function requires the Referral User's API key.
+  # Add credit card to a referral customer. This function requires the Referral Customer's API key.
   # <b>DEPRECATED:</b> Please use <tt>Referral</tt> in the main namespace instead.
   def self.add_credit_card(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')
     warn '[DEPRECATION] Please use `Referral.add_credit_card` in the main namespace instead.'
@@ -107,4 +107,52 @@ class EasyPost::Beta::Referral < EasyPost::Resource
     response = create_easypost_credit_card(referral_api_key, stripe_credit_card_token, priority)
     EasyPost::Util.convert_to_easypost_object(response, referral_api_key)
   end
+
+  # Add a Stripe payment method to a Referral Customer. This function requires the Referral Customer's API key.
+  # @param [String] stripe_customer_id Unique customer ID provided by Stripe.
+  # @param [String] payment_method_reference ID of the card or bank account provided by Stripe.
+  # @param [String] payment_method_type Which priority to save this payment method as on EasyPost, either 'primary' or 'secondary'.
+  # @param [String] api_key Override the API key used for this request.
+  # @return [EasyPost::PaymentMethod] The newly-added payment method.
+  # noinspection RubyParameterNamingConvention
+  def self.add_payment_method(stripe_customer_id, payment_method_reference, priority = 'primary', api_key = nil)
+    wrapped_params = {
+      payment_method: {
+        stripe_customer_id: stripe_customer_id,
+        payment_method_reference: payment_method_reference,
+        priority: priority.downcase,
+      },
+    }
+    response = EasyPost.make_request(:post, '/beta/referral_customers/payment_method', api_key, wrapped_params)
+    # noinspection RubyMismatchedReturnType
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
+
+  # Refund a Referral Customer's wallet by a specified amount. Refund will be issued to the user's original payment method.
+  # This function requires the Referral Customer's API key.
+  # @param [Integer] amount The amount to refund, in cents.
+  # @param [String] api_key Override the API key used for this request.
+  # @return [EasyPost::Beta::PaymentRefund] The newly-created refund.
+  def self.refund_by_amount(amount, api_key = nil)
+    params = {
+      refund_amount: amount,
+    }
+    response = EasyPost.make_request(:post, '/beta/referral_customers/refunds', api_key, params)
+    # noinspection RubyMismatchedReturnType
+    EasyPost::Util.convert_to_easypost_object(response, api_key) # TODO: Needs "object" or ID prefix to determine object class.
+  end
+
+  # Refund a Referral Customer's wallet for a specified payment log entry. Refund will be issued to the user's original payment method.
+  # This function requires the Referral Customer's API key.
+  # @param [String] payment_log_id Payment log ID to refund.
+  # @param [String] api_key Override the API key used for this request.
+  # @return [EasyPost::Beta::PaymentRefund] The newly-created refund.
+  def self.refund_by_payment_log(payment_log_id, api_key = nil)
+    params = {
+      payment_log_id: payment_log_id,
+    }
+    response = EasyPost.make_request(:post, '/beta/referral_customers/refunds', api_key, params)
+    # noinspection RubyMismatchedReturnType
+    EasyPost::Util.convert_to_easypost_object(response, api_key) # TODO: Needs "object" or ID prefix to determine object class.
+  end
 end

data/lib/easypost/event.rb

@@ -8,4 +8,16 @@ class EasyPost::Event < EasyPost::Resource
   def self.receive(values)
     EasyPost::Util.convert_to_easypost_object(JSON.parse(values), nil)
   end
+
+  # Retrieve all payloads for an event.
+  def retrieve_all_payloads(api_key = nil)
+    response = EasyPost.make_request(:get, "#{url}/payloads", api_key)
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
+
+  # Retrieve a specific payload for an event.
+  def retrieve_payload(payload_id, api_key = nil)
+    response = EasyPost.make_request(:get, "#{url}/payloads/#{payload_id}", api_key)
+    EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
 end

data/lib/easypost/payload.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Webhook Event Payloads are triggered by changes in objects you've created via the API.
+class EasyPost::Payload < EasyPost::Resource
+end

data/lib/easypost/payment_method.rb

@@ -2,7 +2,8 @@
 
 # PaymentMethod objects represent a payment method of a user.
 class EasyPost::PaymentMethod < EasyPost::Resource
-  # <b>DEPRECATED:</b> Please use <tt>Billing class</tt> instead.
+  # List all payment methods associated with the current user.
+  # <b>DEPRECATED:</b> Please use <tt>Billing.retrieve_payment_methods</tt> instead.
   # Deprecated: v4.5.0 - v6.0.0
   def self.all(_filters = {}, api_key = nil)
     warn '[DEPRECATION] `all` is deprecated.  Please use `Billing.retrieve_payment_methods` instead.'

data/lib/easypost/pickup.rb

@@ -25,11 +25,6 @@ class EasyPost::Pickup < EasyPost::Resource
     self
   end
 
-  # Retrieve a list of all Pickup objects.
-  def self.all(_filters = {}, _api_key = nil)
-    raise NotImplementedError.new('Pickup.all not implemented.')
-  end
-
   # Get the lowest rate of a Pickup (can exclude by having `'!'` as the first element of your optional filter lists).
   def lowest_rate(carriers = [], services = [])
     EasyPost::Util.get_lowest_object_rate(self, carriers, services, 'pickup_rates')

data/lib/easypost/referral.rb

@@ -55,13 +55,13 @@ class EasyPost::Referral < EasyPost::Resource
     end
   end
 
-  # Create a referral user. This function requires the Partner User's API key.
+  # Create a referral customer. This function requires the Partner User's API key.
   def self.create(params = {}, api_key = nil)
     response = EasyPost.make_request(:post, '/v2/referral_customers', api_key, { user: params })
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
-  # Update a referral user. This function requires the Partner User's API key.
+  # Update a referral customer. This function requires the Partner User's API key.
   def self.update_email(email, user_id, api_key = nil)
     wrapped_params = {
       user: {
@@ -74,13 +74,13 @@ class EasyPost::Referral < EasyPost::Resource
     true
   end
 
-  # Retrieve a list of referral users. This function requires the Partner User's API key.
+  # Retrieve a list of referral customers. This function requires the Partner User's API key.
   def self.all(params = {}, api_key = nil)
     response = EasyPost.make_request(:get, '/v2/referral_customers', api_key, params)
     EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 
-  # Add credit card to a referral user. This function requires the Referral User's API key.
+  # Add credit card to a referral customer. This function requires the Referral Customer's API key.
   def self.add_credit_card(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')
     easypost_stripe_api_key = retrieve_easypost_stripe_api_key
 

data/lib/easypost/util.rb

@@ -7,9 +7,11 @@ module EasyPost::Util
   BY_PREFIX = {
     'ak' => EasyPost::ApiKey,
     'adr' => EasyPost::Address,
+    'bank' => EasyPost::PaymentMethod,
     'batch' => EasyPost::Batch,
     'brd' => EasyPost::Brand,
     'ca' => EasyPost::CarrierAccount,
+    'card' => EasyPost::PaymentMethod,
     'cstinfo' => EasyPost::CustomsInfo,
     'cstitem' => EasyPost::CustomsItem,
     'es' => EasyPost::EndShipper,
@@ -17,6 +19,7 @@ module EasyPost::Util
     'hook' => EasyPost::Webhook,
     'ins' => EasyPost::Insurance,
     'order' => EasyPost::Order,
+    'payload' => EasyPost::Payload,
     'pickup' => EasyPost::Pickup,
     'pickuprate' => EasyPost::PickupRate,
     'pl' => EasyPost::PostageLabel,
@@ -37,10 +40,12 @@ module EasyPost::Util
   BY_TYPE = {
     'Address' => EasyPost::Address,
     'ApiKey' => EasyPost::ApiKey,
+    'BankAccount' => EasyPost::PaymentMethod,
     'Batch' => EasyPost::Batch,
     'Brand' => EasyPost::Brand,
     'CarbonOffset' => EasyPost::CarbonOffset,
     'CarrierAccount' => EasyPost::CarrierAccount,
+    'CreditCard' => EasyPost::PaymentMethod,
     'CustomsInfo' => EasyPost::CustomsInfo,
     'CustomsItem' => EasyPost::CustomsItem,
     'EndShipper' => EasyPost::EndShipper,
@@ -146,25 +151,28 @@ module EasyPost::Util
     when Array
       response.map { |i| convert_to_easypost_object(i, api_key, parent) }
     when Hash
-      if (cls_name = response[:object])
+      # Determine class based on the "object" key in the JSON response
+      cls_name = response[:object] || response['object']
+      if cls_name
+        # Use the "object" key value to look up the class
         cls = BY_TYPE[cls_name]
-      elsif response[:id]
-        if response[:id].index('_').nil?
-          cls = EasyPost::EasyPostObject
-        elsif (cls_prefix = response[:id][0..response[:id].index('_')])
-          cls = BY_PREFIX[cls_prefix[0..-2]]
-        end
-      elsif response['id']
-        if response['id'].index('_').nil?
+      else
+        # Fallback to determining class based on the "id" prefix in the JSON response
+        id = response[:id] || response['id']
+        if id.nil? || id.index('_').nil?
+          # ID not present or prefix not present (ID malformed)
           cls = EasyPost::EasyPostObject
-        elsif (cls_prefix = response['id'][0..response['id'].index('_')])
-          cls = BY_PREFIX[cls_prefix[0..-2]]
+        else
+          # Parse the prefix from the ID and use it to look up the class
+          cls_prefix = id[0..id.index('_')][0..-2]
+          cls = BY_PREFIX[cls_prefix]
         end
       end
-
+      # Fallback to using the generic class if other determination methods fail (or class lookup produced no results)
       cls ||= EasyPost::EasyPostObject
       cls.construct_from(response, api_key, parent, name)
     else
+      # response is neither a Hash nor Array (used mostly when dealing with final values like strings, booleans, etc.)
       response
     end
   end

data/lib/easypost.rb

@@ -26,6 +26,7 @@ require 'easypost/event'
 require 'easypost/insurance'
 require 'easypost/order'
 require 'easypost/parcel'
+require 'easypost/payload'
 require 'easypost/payment_method' # deprecated
 require 'easypost/pickup_rate'
 require 'easypost/pickup'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 4.9.0
+  version: 4.11.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-07 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman
@@ -195,15 +195,11 @@ files:
 - ".gitmodules"
 - ".rubocop.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - Makefile
 - README.md
 - Rakefile
-- SECURITY.md
-- SUPPORT.md
 - UPGRADE_GUIDE.md
 - VERSION
 - bin/easypost-irb
@@ -296,6 +292,7 @@ files:
 - lib/easypost/batch.rb
 - lib/easypost/beta.rb
 - lib/easypost/beta/end_shipper.rb
+- lib/easypost/beta/payment_refund.rb
 - lib/easypost/beta/referral.rb
 - lib/easypost/billing.rb
 - lib/easypost/brand.rb
@@ -312,6 +309,7 @@ files:
 - lib/easypost/object.rb
 - lib/easypost/order.rb
 - lib/easypost/parcel.rb
+- lib/easypost/payload.rb
 - lib/easypost/payment_method.rb
 - lib/easypost/pickup.rb
 - lib/easypost/pickup_rate.rb
@@ -348,7 +346,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: EasyPost Ruby Client Library

data/CODE_OF_CONDUCT.md

@@ -1,16 +0,0 @@
-# Code of Conduct
-
-> Remember the golden rule? Treat others as you'd like to be treated
-
-## Standards
-
-- Create a welcoming and safe community for `everyone`
-- Demonstrate empathy towards others, realize that everyone has a different `level of experience`
-- Be respectful of others opinions, viewpoints, and experiences
-- Give and receive respectful constructive feedback
-- Accept responsibility and apologize when necessary
-- Focus on what is best for the overall community
-
-## Failure to Follow Standards
-
-If there is a failure to follow the standards laid out above, the user will first be warned. If the offending behavior continues, the user may be blocked entirely.

data/CONTRIBUTING.md

@@ -1,47 +0,0 @@
-# Contributing Guide
-
-Please read this document in its entirety.
-
-## General
-
-- Be nice and respectful of maintainers’ and contributors’ time and viewpoints
-- Be as descriptive as possible! More info is always better than not enough
-- Be patient, there may be a lot of in-flight work, some of it across multiple projects not related to the repo being contributed to
-- Have fun!
-
-## Contributing
-
-Contributing comes in many forms! We are incredibly grateful to anyone who can do any of the following:
-
-- Add new features
-- Fix bugs
-- Fix typos
-- Improve docs
-- Improve tests
-- Triage issues
-- Review pull requests
-- Share opinions and viewpoints on issues
-
-## Issues
-
-- If your issue is security related, please follow the [SECURITY guide](https://github.com/easypost/.github/SECURITY.md)
-- Before opening a new issue, check for existing issues that are related, including closed ones
-- Provide as much information as possible about the issue, including how to reproduce the problem and the expected behavior
-- Don't needlessly bump issues (eg: if there hasn’t been progress for more than a few weeks, feel free to reach back out)
-
-## Pull Requests
-
-- All Pull Requests should be accompanied first by an issue describing the reason why the Pull Request is needed
-- Be as descriptive as possible in your PR description about why the changes are being made and what the changes contain
-- Pull Requests should be as small as possible
-- Don't make unrelated changes in your Pull Request
-- Don't open a Pull Request if you don't plan to see it through. PRs submitted by individuals that cannot complete additional work to get a PR merged may be closed without completion
-- Adhere to the existing code style of the repo, even if it differs from your personal preference
-- When applicable, add tests that provide ample coverage of the logic added or changed
-- Pull Requests should come from branches and never the default `master` branch
-- Pull Requests must pass CI, including linting and testing
-- Pull Requests must go through code review before they can be merged to the main branch
-- Do not include "version bump" changes in the same PR as your code changes; these will be handled as a separate PR and releasing process
-- Make sure the `Allow edits from maintainers` checkbox is checked. That way EasyPost engineers can make certain minor changes as needed, allowing your pull request to be merged sooner.
-
-You agree and acknowledge that you have necessary intellectual property rights to provide your Contribution and hereby assign to EasyPost all right, title and interest in such Contribution.

data/SECURITY.md

@@ -1,7 +0,0 @@
-# Security Guide
-
-We take security seriously at EasyPost. If you find a security issue or vulnerability in our open source projects, please abide by the following guidelines:
-
-- Please read our [Responsible Disclosure Policy](https://www.easypost.com/privacy#disclosure-policy).
-- Do not open an issue on GitHub about the security vulnerability. Doing so draws attention to the issue and exposes it to the public.
-- Send an email to `security-abuse@easypost.com` including as many details as possible.

data/SUPPORT.md

@@ -1,3 +0,0 @@
-# Support Guide
-
-Looking for support for one of our projects? If your question is related to our API, please contact our support team at `support@easypost.com`. If you need support regarding this project, create an issue on GitHub with as many details as possible and we’ll take a look.