From 0dfde18e234731c4c581929443be270e6f6ed905 Mon Sep 17 00:00:00 2001 From: Justintime50 <39606064+Justintime50@users.noreply.github.com> Date: Wed, 7 May 2025 14:54:00 -0600 Subject: [PATCH 1/3] feat: v7 ruby docs --- Gemfile.lock | 6 +-- examples.gemspec | 2 +- .../billing/add-stripe-bank-account.rb | 16 +++++++ .../current/billing/add-stripe-credit-card.rb | 11 +++++ .../create-stripe-bank-account-secret.rb | 7 +++ .../create-stripe-credit-card-secret.rb | 7 +++ official/docs/ruby/current/webhooks/create.rb | 3 ++ official/docs/ruby/current/webhooks/update.rb | 9 +++- .../ruby/v6/addresses/create-and-verify.rb | 15 ++++++ official/docs/ruby/v6/addresses/create.rb | 16 +++++++ official/docs/ruby/v6/addresses/list.rb | 9 ++++ official/docs/ruby/v6/addresses/retrieve.rb | 7 +++ .../docs/ruby/v6/addresses/verify-param.rb | 16 +++++++ .../ruby/v6/addresses/verify-strict-param.rb | 16 +++++++ official/docs/ruby/v6/addresses/verify.rb | 7 +++ official/docs/ruby/v6/api-keys/retrieve.rb | 13 ++++++ .../docs/ruby/v6/batches/add-shipments.rb | 13 ++++++ official/docs/ruby/v6/batches/buy.rb | 20 ++++++++ official/docs/ruby/v6/batches/create.rb | 12 +++++ official/docs/ruby/v6/batches/label.rb | 10 ++++ official/docs/ruby/v6/batches/list.rb | 9 ++++ .../docs/ruby/v6/batches/remove-shipments.rb | 12 +++++ official/docs/ruby/v6/batches/retrieve.rb | 7 +++ official/docs/ruby/v6/batches/scan-forms.rb | 7 +++ .../ruby/v6/billing/create-ep-credit-card.rb | 13 ++++++ official/docs/ruby/v6/billing/delete.rb | 5 ++ official/docs/ruby/v6/billing/fund.rb | 5 ++ official/docs/ruby/v6/billing/list.rb | 7 +++ official/docs/ruby/v6/brand/update.rb | 10 ++++ .../docs/ruby/v6/carrier-accounts/create.rb | 22 +++++++++ .../docs/ruby/v6/carrier-accounts/delete.rb | 5 ++ .../docs/ruby/v6/carrier-accounts/list.rb | 7 +++ .../docs/ruby/v6/carrier-accounts/retrieve.rb | 7 +++ .../docs/ruby/v6/carrier-accounts/update.rb | 10 ++++ .../docs/ruby/v6/carrier-metadata/retrieve.rb | 11 +++++ official/docs/ruby/v6/carrier-types/list.rb | 7 +++ official/docs/ruby/v6/child-users/create.rb | 9 ++++ official/docs/ruby/v6/child-users/delete.rb | 5 ++ official/docs/ruby/v6/child-users/list.rb | 9 ++++ official/docs/ruby/v6/claim/cancel.rb | 7 +++ official/docs/ruby/v6/claim/create.rb | 19 ++++++++ official/docs/ruby/v6/claim/list.rb | 9 ++++ official/docs/ruby/v6/claim/retrieve.rb | 7 +++ official/docs/ruby/v6/customs-infos/create.rb | 24 ++++++++++ .../docs/ruby/v6/customs-infos/retrieve.rb | 7 +++ official/docs/ruby/v6/customs-items/create.rb | 14 ++++++ .../docs/ruby/v6/customs-items/retrieve.rb | 7 +++ official/docs/ruby/v6/endshipper/buy.rb | 15 ++++++ official/docs/ruby/v6/endshipper/create.rb | 18 ++++++++ official/docs/ruby/v6/endshipper/list.rb | 9 ++++ official/docs/ruby/v6/endshipper/retrieve.rb | 7 +++ official/docs/ruby/v6/endshipper/update.rb | 20 ++++++++ official/docs/ruby/v6/events/list.rb | 9 ++++ official/docs/ruby/v6/events/retrieve.rb | 7 +++ official/docs/ruby/v6/forms/create.rb | 22 +++++++++ official/docs/ruby/v6/insurance/create.rb | 18 ++++++++ official/docs/ruby/v6/insurance/list.rb | 9 ++++ official/docs/ruby/v6/insurance/refund.rb | 7 +++ official/docs/ruby/v6/insurance/retrieve.rb | 7 +++ .../ruby/v6/options/create-with-options.rb | 20 ++++++++ official/docs/ruby/v6/orders/buy.rb | 7 +++ official/docs/ruby/v6/orders/create.rb | 27 +++++++++++ official/docs/ruby/v6/orders/one-call-buy.rb | 29 ++++++++++++ official/docs/ruby/v6/orders/retrieve.rb | 7 +++ .../docs/ruby/v6/pagination/get-next-page.rb | 11 +++++ official/docs/ruby/v6/parcels/create.rb | 12 +++++ official/docs/ruby/v6/parcels/retrieve.rb | 7 +++ official/docs/ruby/v6/payloads/list.rb | 7 +++ official/docs/ruby/v6/payloads/retrieve.rb | 7 +++ official/docs/ruby/v6/pickups/buy.rb | 7 +++ official/docs/ruby/v6/pickups/cancel.rb | 7 +++ official/docs/ruby/v6/pickups/create.rb | 19 ++++++++ official/docs/ruby/v6/pickups/list.rb | 9 ++++ official/docs/ruby/v6/pickups/retrieve.rb | 7 +++ official/docs/ruby/v6/rates/regenerate.rb | 7 +++ .../docs/ruby/v6/rates/retrieve-stateless.rb | 37 +++++++++++++++ official/docs/ruby/v6/rates/retrieve.rb | 7 +++ .../add-payment-method-with-bank-account.rb | 11 +++++ .../add-payment-method-with-credit-card.rb | 11 +++++ .../docs/ruby/v6/referral-customers/create.rb | 11 +++++ .../docs/ruby/v6/referral-customers/list.rb | 9 ++++ .../v6/referral-customers/refund-by-amount.rb | 7 +++ .../refund-by-payment-log.rb | 7 +++ .../docs/ruby/v6/referral-customers/update.rb | 10 ++++ official/docs/ruby/v6/refunds/create.rb | 10 ++++ official/docs/ruby/v6/refunds/list.rb | 9 ++++ official/docs/ruby/v6/refunds/retrieve.rb | 7 +++ official/docs/ruby/v6/reports/create.rb | 11 +++++ official/docs/ruby/v6/reports/list.rb | 11 +++++ official/docs/ruby/v6/reports/retrieve.rb | 7 +++ official/docs/ruby/v6/returns/create.rb | 36 +++++++++++++++ official/docs/ruby/v6/scan-form/create.rb | 16 +++++++ official/docs/ruby/v6/scan-form/list.rb | 9 ++++ official/docs/ruby/v6/scan-form/retrieve.rb | 7 +++ official/docs/ruby/v6/shipments/buy.rb | 13 ++++++ official/docs/ruby/v6/shipments/create.rb | 38 +++++++++++++++ official/docs/ruby/v6/shipments/label.rb | 7 +++ official/docs/ruby/v6/shipments/list.rb | 9 ++++ .../docs/ruby/v6/shipments/one-call-buy.rb | 37 +++++++++++++++ official/docs/ruby/v6/shipments/retrieve.rb | 7 +++ .../docs/ruby/v6/shipping-insurance/insure.rb | 7 +++ .../docs/ruby/v6/shipping-refund/refund.rb | 7 +++ .../retrieve-estimated-delivery-date.rb | 10 ++++ .../smartrate/retrieve-recommend-ship-date.rb | 10 ++++ ...etrieve-standalone-smartrate-deliver-by.rb | 14 ++++++ ...etrieve-standalone-smartrate-deliver-on.rb | 14 ++++++ .../retrieve-time-in-transit-statistics.rb | 7 +++ .../docs/ruby/v6/tax-identifiers/create.rb | 46 +++++++++++++++++++ official/docs/ruby/v6/trackers/create.rb | 10 ++++ official/docs/ruby/v6/trackers/list.rb | 9 ++++ official/docs/ruby/v6/trackers/retrieve.rb | 7 +++ official/docs/ruby/v6/users/retrieve.rb | 11 +++++ official/docs/ruby/v6/users/update.rb | 9 ++++ official/docs/ruby/v6/webhooks/create.rb | 10 ++++ official/docs/ruby/v6/webhooks/delete.rb | 7 +++ official/docs/ruby/v6/webhooks/list.rb | 7 +++ official/docs/ruby/v6/webhooks/retrieve.rb | 7 +++ official/docs/ruby/v6/webhooks/update.rb | 7 +++ .../guides/errors-guide/ruby/catch-error.rb | 15 +++++- 119 files changed, 1365 insertions(+), 7 deletions(-) create mode 100644 official/docs/ruby/current/billing/add-stripe-bank-account.rb create mode 100644 official/docs/ruby/current/billing/add-stripe-credit-card.rb create mode 100644 official/docs/ruby/current/billing/create-stripe-bank-account-secret.rb create mode 100644 official/docs/ruby/current/billing/create-stripe-credit-card-secret.rb create mode 100644 official/docs/ruby/v6/addresses/create-and-verify.rb create mode 100644 official/docs/ruby/v6/addresses/create.rb create mode 100644 official/docs/ruby/v6/addresses/list.rb create mode 100644 official/docs/ruby/v6/addresses/retrieve.rb create mode 100644 official/docs/ruby/v6/addresses/verify-param.rb create mode 100644 official/docs/ruby/v6/addresses/verify-strict-param.rb create mode 100644 official/docs/ruby/v6/addresses/verify.rb create mode 100644 official/docs/ruby/v6/api-keys/retrieve.rb create mode 100644 official/docs/ruby/v6/batches/add-shipments.rb create mode 100644 official/docs/ruby/v6/batches/buy.rb create mode 100644 official/docs/ruby/v6/batches/create.rb create mode 100644 official/docs/ruby/v6/batches/label.rb create mode 100644 official/docs/ruby/v6/batches/list.rb create mode 100644 official/docs/ruby/v6/batches/remove-shipments.rb create mode 100644 official/docs/ruby/v6/batches/retrieve.rb create mode 100644 official/docs/ruby/v6/batches/scan-forms.rb create mode 100644 official/docs/ruby/v6/billing/create-ep-credit-card.rb create mode 100644 official/docs/ruby/v6/billing/delete.rb create mode 100644 official/docs/ruby/v6/billing/fund.rb create mode 100644 official/docs/ruby/v6/billing/list.rb create mode 100644 official/docs/ruby/v6/brand/update.rb create mode 100644 official/docs/ruby/v6/carrier-accounts/create.rb create mode 100644 official/docs/ruby/v6/carrier-accounts/delete.rb create mode 100644 official/docs/ruby/v6/carrier-accounts/list.rb create mode 100644 official/docs/ruby/v6/carrier-accounts/retrieve.rb create mode 100644 official/docs/ruby/v6/carrier-accounts/update.rb create mode 100644 official/docs/ruby/v6/carrier-metadata/retrieve.rb create mode 100644 official/docs/ruby/v6/carrier-types/list.rb create mode 100644 official/docs/ruby/v6/child-users/create.rb create mode 100644 official/docs/ruby/v6/child-users/delete.rb create mode 100644 official/docs/ruby/v6/child-users/list.rb create mode 100644 official/docs/ruby/v6/claim/cancel.rb create mode 100644 official/docs/ruby/v6/claim/create.rb create mode 100644 official/docs/ruby/v6/claim/list.rb create mode 100644 official/docs/ruby/v6/claim/retrieve.rb create mode 100644 official/docs/ruby/v6/customs-infos/create.rb create mode 100644 official/docs/ruby/v6/customs-infos/retrieve.rb create mode 100644 official/docs/ruby/v6/customs-items/create.rb create mode 100644 official/docs/ruby/v6/customs-items/retrieve.rb create mode 100644 official/docs/ruby/v6/endshipper/buy.rb create mode 100644 official/docs/ruby/v6/endshipper/create.rb create mode 100644 official/docs/ruby/v6/endshipper/list.rb create mode 100644 official/docs/ruby/v6/endshipper/retrieve.rb create mode 100644 official/docs/ruby/v6/endshipper/update.rb create mode 100644 official/docs/ruby/v6/events/list.rb create mode 100644 official/docs/ruby/v6/events/retrieve.rb create mode 100644 official/docs/ruby/v6/forms/create.rb create mode 100644 official/docs/ruby/v6/insurance/create.rb create mode 100644 official/docs/ruby/v6/insurance/list.rb create mode 100644 official/docs/ruby/v6/insurance/refund.rb create mode 100644 official/docs/ruby/v6/insurance/retrieve.rb create mode 100644 official/docs/ruby/v6/options/create-with-options.rb create mode 100644 official/docs/ruby/v6/orders/buy.rb create mode 100644 official/docs/ruby/v6/orders/create.rb create mode 100644 official/docs/ruby/v6/orders/one-call-buy.rb create mode 100644 official/docs/ruby/v6/orders/retrieve.rb create mode 100644 official/docs/ruby/v6/pagination/get-next-page.rb create mode 100644 official/docs/ruby/v6/parcels/create.rb create mode 100644 official/docs/ruby/v6/parcels/retrieve.rb create mode 100644 official/docs/ruby/v6/payloads/list.rb create mode 100644 official/docs/ruby/v6/payloads/retrieve.rb create mode 100644 official/docs/ruby/v6/pickups/buy.rb create mode 100644 official/docs/ruby/v6/pickups/cancel.rb create mode 100644 official/docs/ruby/v6/pickups/create.rb create mode 100644 official/docs/ruby/v6/pickups/list.rb create mode 100644 official/docs/ruby/v6/pickups/retrieve.rb create mode 100644 official/docs/ruby/v6/rates/regenerate.rb create mode 100644 official/docs/ruby/v6/rates/retrieve-stateless.rb create mode 100644 official/docs/ruby/v6/rates/retrieve.rb create mode 100644 official/docs/ruby/v6/referral-customers/add-payment-method-with-bank-account.rb create mode 100644 official/docs/ruby/v6/referral-customers/add-payment-method-with-credit-card.rb create mode 100644 official/docs/ruby/v6/referral-customers/create.rb create mode 100644 official/docs/ruby/v6/referral-customers/list.rb create mode 100644 official/docs/ruby/v6/referral-customers/refund-by-amount.rb create mode 100644 official/docs/ruby/v6/referral-customers/refund-by-payment-log.rb create mode 100644 official/docs/ruby/v6/referral-customers/update.rb create mode 100644 official/docs/ruby/v6/refunds/create.rb create mode 100644 official/docs/ruby/v6/refunds/list.rb create mode 100644 official/docs/ruby/v6/refunds/retrieve.rb create mode 100644 official/docs/ruby/v6/reports/create.rb create mode 100644 official/docs/ruby/v6/reports/list.rb create mode 100644 official/docs/ruby/v6/reports/retrieve.rb create mode 100644 official/docs/ruby/v6/returns/create.rb create mode 100644 official/docs/ruby/v6/scan-form/create.rb create mode 100644 official/docs/ruby/v6/scan-form/list.rb create mode 100644 official/docs/ruby/v6/scan-form/retrieve.rb create mode 100644 official/docs/ruby/v6/shipments/buy.rb create mode 100644 official/docs/ruby/v6/shipments/create.rb create mode 100644 official/docs/ruby/v6/shipments/label.rb create mode 100644 official/docs/ruby/v6/shipments/list.rb create mode 100644 official/docs/ruby/v6/shipments/one-call-buy.rb create mode 100644 official/docs/ruby/v6/shipments/retrieve.rb create mode 100644 official/docs/ruby/v6/shipping-insurance/insure.rb create mode 100644 official/docs/ruby/v6/shipping-refund/refund.rb create mode 100644 official/docs/ruby/v6/smartrate/retrieve-estimated-delivery-date.rb create mode 100644 official/docs/ruby/v6/smartrate/retrieve-recommend-ship-date.rb create mode 100644 official/docs/ruby/v6/smartrate/retrieve-standalone-smartrate-deliver-by.rb create mode 100644 official/docs/ruby/v6/smartrate/retrieve-standalone-smartrate-deliver-on.rb create mode 100644 official/docs/ruby/v6/smartrate/retrieve-time-in-transit-statistics.rb create mode 100644 official/docs/ruby/v6/tax-identifiers/create.rb create mode 100644 official/docs/ruby/v6/trackers/create.rb create mode 100644 official/docs/ruby/v6/trackers/list.rb create mode 100644 official/docs/ruby/v6/trackers/retrieve.rb create mode 100644 official/docs/ruby/v6/users/retrieve.rb create mode 100644 official/docs/ruby/v6/users/update.rb create mode 100644 official/docs/ruby/v6/webhooks/create.rb create mode 100644 official/docs/ruby/v6/webhooks/delete.rb create mode 100644 official/docs/ruby/v6/webhooks/list.rb create mode 100644 official/docs/ruby/v6/webhooks/retrieve.rb create mode 100644 official/docs/ruby/v6/webhooks/update.rb diff --git a/Gemfile.lock b/Gemfile.lock index 5935e9d9..e74224da 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -2,13 +2,13 @@ PATH remote: . specs: examples (0.1.0) - easypost (~> 6) + easypost (~> 7) GEM remote: https://rubygems.org/ specs: ast (2.4.2) - easypost (6.4.1) + easypost (7.0.0) json (2.10.2) language_server-protocol (3.17.0.4) lint_roller (1.1.0) @@ -62,4 +62,4 @@ DEPENDENCIES rubocop-rspec (~> 2.31) BUNDLED WITH - 2.5.11 + 2.6.8 diff --git a/examples.gemspec b/examples.gemspec index 038e127a..0567256c 100644 --- a/examples.gemspec +++ b/examples.gemspec @@ -11,7 +11,7 @@ Gem::Specification.new do |spec| spec.homepage = 'https://github.com/easypost/examples' spec.license = 'MIT' - spec.add_dependency 'easypost', '~> 6' + spec.add_dependency 'easypost', '~> 7' spec.add_development_dependency 'rubocop', '= 1.73' spec.add_development_dependency 'rubocop-rspec', '~> 2.31' # Can't upgrade to v3 until we drop Ruby 2.7 diff --git a/official/docs/ruby/current/billing/add-stripe-bank-account.rb b/official/docs/ruby/current/billing/add-stripe-bank-account.rb new file mode 100644 index 00000000..dcf039ff --- /dev/null +++ b/official/docs/ruby/current/billing/add-stripe-bank-account.rb @@ -0,0 +1,16 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +payment_method = client.referral_customer.add_bank_account_from_stripe( + 'REFERRAL_USER_API_KEY', + 'fca_...', + { + ip_address: '127.0.0.1', + user_agent: 'Mozilla/5.0', + accepted_at: 172_251_073, + }, + 'primary', +) + +puts payment_method diff --git a/official/docs/ruby/current/billing/add-stripe-credit-card.rb b/official/docs/ruby/current/billing/add-stripe-credit-card.rb new file mode 100644 index 00000000..efb3cace --- /dev/null +++ b/official/docs/ruby/current/billing/add-stripe-credit-card.rb @@ -0,0 +1,11 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +payment_method = client.referral_customer.add_credit_card_from_stripe( + 'REFERRAL_USER_API_KEY', + 'seti_...', + 'primary', +) + +puts payment_method diff --git a/official/docs/ruby/current/billing/create-stripe-bank-account-secret.rb b/official/docs/ruby/current/billing/create-stripe-bank-account-secret.rb new file mode 100644 index 00000000..1db5f988 --- /dev/null +++ b/official/docs/ruby/current/billing/create-stripe-bank-account-secret.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +response = client.beta_referral_customer.create_bank_account_client_secret + +puts response diff --git a/official/docs/ruby/current/billing/create-stripe-credit-card-secret.rb b/official/docs/ruby/current/billing/create-stripe-credit-card-secret.rb new file mode 100644 index 00000000..34b0b4c5 --- /dev/null +++ b/official/docs/ruby/current/billing/create-stripe-credit-card-secret.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +response = client.beta_referral_customer.create_credit_card_client_secret + +puts response diff --git a/official/docs/ruby/current/webhooks/create.rb b/official/docs/ruby/current/webhooks/create.rb index b6f580bf..e30059d8 100644 --- a/official/docs/ruby/current/webhooks/create.rb +++ b/official/docs/ruby/current/webhooks/create.rb @@ -5,6 +5,9 @@ webhook = client.webhook.create( url: 'example.com', webhook_secret: 'A1B2C3', + custom_headers: { + 'X-Header-Name' => 'header_value', + }, ) puts webhook diff --git a/official/docs/ruby/current/webhooks/update.rb b/official/docs/ruby/current/webhooks/update.rb index 37224dfb..ddf94d8a 100644 --- a/official/docs/ruby/current/webhooks/update.rb +++ b/official/docs/ruby/current/webhooks/update.rb @@ -2,6 +2,13 @@ client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') -webhook = client.webhook.update('hook_...') +webhook = client.webhook.update( + 'hook_...', { + webhook_secret: 'A1B2C3', + custom_headers: { + 'X-Header-Name' => 'header_value', + }, + }, +) puts webhook diff --git a/official/docs/ruby/v6/addresses/create-and-verify.rb b/official/docs/ruby/v6/addresses/create-and-verify.rb new file mode 100644 index 00000000..3cceadc9 --- /dev/null +++ b/official/docs/ruby/v6/addresses/create-and-verify.rb @@ -0,0 +1,15 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +address = client.address.create_and_verify( + street1: '000 unknown street', + city: 'Not A City', + state: 'ZZ', + zip: '00001', + country: 'US', + email: 'test@example.com', + phone: '5555555555', +) + +puts address diff --git a/official/docs/ruby/v6/addresses/create.rb b/official/docs/ruby/v6/addresses/create.rb new file mode 100644 index 00000000..63deabb9 --- /dev/null +++ b/official/docs/ruby/v6/addresses/create.rb @@ -0,0 +1,16 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +address = client.address.create( + street1: '417 MONTGOMERY ST', + street2: 'FLOOR 5', + city: 'SAN FRANCISCO', + state: 'CA', + zip: '94104', + country: 'US', + company: 'EasyPost', + phone: '415-123-4567', +) + +puts address diff --git a/official/docs/ruby/v6/addresses/list.rb b/official/docs/ruby/v6/addresses/list.rb new file mode 100644 index 00000000..fc9f19e9 --- /dev/null +++ b/official/docs/ruby/v6/addresses/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +addresses = client.address.all( + page_size: 5, +) + +puts addresses diff --git a/official/docs/ruby/v6/addresses/retrieve.rb b/official/docs/ruby/v6/addresses/retrieve.rb new file mode 100644 index 00000000..d015e263 --- /dev/null +++ b/official/docs/ruby/v6/addresses/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +address = client.address.retrieve('adr_...') + +puts address diff --git a/official/docs/ruby/v6/addresses/verify-param.rb b/official/docs/ruby/v6/addresses/verify-param.rb new file mode 100644 index 00000000..82448e67 --- /dev/null +++ b/official/docs/ruby/v6/addresses/verify-param.rb @@ -0,0 +1,16 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +address = client.address.create( + verify: true, + street1: '000 unknown street', + city: 'Not A City', + state: 'ZZ', + zip: '00001', + country: 'US', + email: 'test@example.com', + phone: '5555555555', +) + +puts address diff --git a/official/docs/ruby/v6/addresses/verify-strict-param.rb b/official/docs/ruby/v6/addresses/verify-strict-param.rb new file mode 100644 index 00000000..e72b7ddd --- /dev/null +++ b/official/docs/ruby/v6/addresses/verify-strict-param.rb @@ -0,0 +1,16 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +address = client.address.create( + verify_strict: true, + street1: '000 unknown street', + city: 'Not A City', + state: 'ZZ', + zip: '00001', + country: 'US', + email: 'test@example.com', + phone: '5555555555', +) + +puts address diff --git a/official/docs/ruby/v6/addresses/verify.rb b/official/docs/ruby/v6/addresses/verify.rb new file mode 100644 index 00000000..bf92fe63 --- /dev/null +++ b/official/docs/ruby/v6/addresses/verify.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +address = client.address.verify('adr_...') + +puts address diff --git a/official/docs/ruby/v6/api-keys/retrieve.rb b/official/docs/ruby/v6/api-keys/retrieve.rb new file mode 100644 index 00000000..9e99f6f5 --- /dev/null +++ b/official/docs/ruby/v6/api-keys/retrieve.rb @@ -0,0 +1,13 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +# Retrieve all API keys including children +api_keys = client.api_key.all + +puts api_keys + +# Retrieve API keys for a specific child user +child_api_keys = client.api_key.retrieve_api_keys_for_user('user_...') + +puts child_api_keys diff --git a/official/docs/ruby/v6/batches/add-shipments.rb b/official/docs/ruby/v6/batches/add-shipments.rb new file mode 100644 index 00000000..6f0b367c --- /dev/null +++ b/official/docs/ruby/v6/batches/add-shipments.rb @@ -0,0 +1,13 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +batch = client.batch.add_shipments( + 'batch_...', + shipments: [ + { id: 'shp_...' }, + { id: 'shp_...' }, + ], +) + +puts batch diff --git a/official/docs/ruby/v6/batches/buy.rb b/official/docs/ruby/v6/batches/buy.rb new file mode 100644 index 00000000..ec29972c --- /dev/null +++ b/official/docs/ruby/v6/batches/buy.rb @@ -0,0 +1,20 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +created_batch = client.batch.create( + shipments: [ + { + from_address: { id: 'adr_...' }, + to_address: { id: 'adr_...' }, + parcel: { id: 'prcl_...' }, + service: 'First', + carrier: 'USPS', + carrier_accounts: ['ca_...'], + }, + ], +) + +batch = client.batch.buy(created_batch.id) + +puts batch diff --git a/official/docs/ruby/v6/batches/create.rb b/official/docs/ruby/v6/batches/create.rb new file mode 100644 index 00000000..142d8c67 --- /dev/null +++ b/official/docs/ruby/v6/batches/create.rb @@ -0,0 +1,12 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +batch = client.batch.create( + shipments: [ + { id: 'shp_...' }, + { id: 'shp_...' }, + ], +) + +puts batch diff --git a/official/docs/ruby/v6/batches/label.rb b/official/docs/ruby/v6/batches/label.rb new file mode 100644 index 00000000..8ace76da --- /dev/null +++ b/official/docs/ruby/v6/batches/label.rb @@ -0,0 +1,10 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +batch = client.batch.label( + 'batch_...', + file_format: 'PDF', +) + +puts batch diff --git a/official/docs/ruby/v6/batches/list.rb b/official/docs/ruby/v6/batches/list.rb new file mode 100644 index 00000000..9b714870 --- /dev/null +++ b/official/docs/ruby/v6/batches/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +batches = client.batch.all( + page_size: 5, +) + +puts batches diff --git a/official/docs/ruby/v6/batches/remove-shipments.rb b/official/docs/ruby/v6/batches/remove-shipments.rb new file mode 100644 index 00000000..bc5e718a --- /dev/null +++ b/official/docs/ruby/v6/batches/remove-shipments.rb @@ -0,0 +1,12 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +batch = client.batch.remove_shipments( + 'batch_...', + shipments: [ + { id: 'shp_...' }, + ], +) + +puts batch diff --git a/official/docs/ruby/v6/batches/retrieve.rb b/official/docs/ruby/v6/batches/retrieve.rb new file mode 100644 index 00000000..80cede3b --- /dev/null +++ b/official/docs/ruby/v6/batches/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +batch = client.batch.retrieve('batch_...') + +puts batch diff --git a/official/docs/ruby/v6/batches/scan-forms.rb b/official/docs/ruby/v6/batches/scan-forms.rb new file mode 100644 index 00000000..d451f115 --- /dev/null +++ b/official/docs/ruby/v6/batches/scan-forms.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +batch = client.batch.create_scan_form('batch_...') + +puts batch diff --git a/official/docs/ruby/v6/billing/create-ep-credit-card.rb b/official/docs/ruby/v6/billing/create-ep-credit-card.rb new file mode 100644 index 00000000..d500a945 --- /dev/null +++ b/official/docs/ruby/v6/billing/create-ep-credit-card.rb @@ -0,0 +1,13 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +credit_card = client.referral_customer.add_credit_card( + 'REFERRAL_USER_API_KEY', + '0123456789101234', + '01', + '2025', + '111', +) + +puts credit_card diff --git a/official/docs/ruby/v6/billing/delete.rb b/official/docs/ruby/v6/billing/delete.rb new file mode 100644 index 00000000..26120eb5 --- /dev/null +++ b/official/docs/ruby/v6/billing/delete.rb @@ -0,0 +1,5 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +client.referral_customer.delete('primary') diff --git a/official/docs/ruby/v6/billing/fund.rb b/official/docs/ruby/v6/billing/fund.rb new file mode 100644 index 00000000..b6afc7d6 --- /dev/null +++ b/official/docs/ruby/v6/billing/fund.rb @@ -0,0 +1,5 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +client.billing.fund_wallet('2000', 'primary') diff --git a/official/docs/ruby/v6/billing/list.rb b/official/docs/ruby/v6/billing/list.rb new file mode 100644 index 00000000..299d5297 --- /dev/null +++ b/official/docs/ruby/v6/billing/list.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +payment_methods = client.billing.retrieve_payment_methods + +puts payment_methods diff --git a/official/docs/ruby/v6/brand/update.rb b/official/docs/ruby/v6/brand/update.rb new file mode 100644 index 00000000..03587190 --- /dev/null +++ b/official/docs/ruby/v6/brand/update.rb @@ -0,0 +1,10 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +brand = client.user.update_brand( + 'user_...', + color: '#303F9F', +) + +puts brand diff --git a/official/docs/ruby/v6/carrier-accounts/create.rb b/official/docs/ruby/v6/carrier-accounts/create.rb new file mode 100644 index 00000000..47b0453e --- /dev/null +++ b/official/docs/ruby/v6/carrier-accounts/create.rb @@ -0,0 +1,22 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +carrier_account = client.carrier_account.create( + type: 'DhlEcsAccount', + description: 'CA Location DHL eCommerce Solutions Account', + credentials: { + client_id: '123456', + client_secret: '123abc', + distribution_center: 'USLAX1', + pickup_id: '123456', + }, + test_credentials: { + client_id: '123456', + client_secret: '123abc', + distribution_center: 'USLAX1', + pickup_id: '123456', + }, +) + +puts carrier_account diff --git a/official/docs/ruby/v6/carrier-accounts/delete.rb b/official/docs/ruby/v6/carrier-accounts/delete.rb new file mode 100644 index 00000000..42459fc2 --- /dev/null +++ b/official/docs/ruby/v6/carrier-accounts/delete.rb @@ -0,0 +1,5 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +client.carrier_account.delete('ca_...') diff --git a/official/docs/ruby/v6/carrier-accounts/list.rb b/official/docs/ruby/v6/carrier-accounts/list.rb new file mode 100644 index 00000000..3774ab27 --- /dev/null +++ b/official/docs/ruby/v6/carrier-accounts/list.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +carrier_accounts = client.carrier_account.all + +puts carrier_accounts diff --git a/official/docs/ruby/v6/carrier-accounts/retrieve.rb b/official/docs/ruby/v6/carrier-accounts/retrieve.rb new file mode 100644 index 00000000..c0b53e8f --- /dev/null +++ b/official/docs/ruby/v6/carrier-accounts/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +carrier_account = client.carrier_account.retrieve('ca_...') + +puts carrier_account diff --git a/official/docs/ruby/v6/carrier-accounts/update.rb b/official/docs/ruby/v6/carrier-accounts/update.rb new file mode 100644 index 00000000..a8eb587f --- /dev/null +++ b/official/docs/ruby/v6/carrier-accounts/update.rb @@ -0,0 +1,10 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +carrier_account = client.carrier_account.update( + 'ca_...', + description: 'FL Location DHL eCommerce Solutions Account', +) + +puts carrier_account diff --git a/official/docs/ruby/v6/carrier-metadata/retrieve.rb b/official/docs/ruby/v6/carrier-metadata/retrieve.rb new file mode 100644 index 00000000..8adcaf5a --- /dev/null +++ b/official/docs/ruby/v6/carrier-metadata/retrieve.rb @@ -0,0 +1,11 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +# Request all metadata for all carriers +carrier_metadata = client.carrier_metadata.retrieve +puts carrier_metadata + +# Request specific metadata for specific carriers +usps_carrier_metadata = client.carrier_metadata.retrieve('usps', %w[service_levels predefined_packages]) +puts usps_carrier_metadata diff --git a/official/docs/ruby/v6/carrier-types/list.rb b/official/docs/ruby/v6/carrier-types/list.rb new file mode 100644 index 00000000..06e98b9b --- /dev/null +++ b/official/docs/ruby/v6/carrier-types/list.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +carrier_types = client.carrier_account.types + +puts carrier_types diff --git a/official/docs/ruby/v6/child-users/create.rb b/official/docs/ruby/v6/child-users/create.rb new file mode 100644 index 00000000..0c60995d --- /dev/null +++ b/official/docs/ruby/v6/child-users/create.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +user = client.user.create( + name: 'Child Account Name', +) + +puts user diff --git a/official/docs/ruby/v6/child-users/delete.rb b/official/docs/ruby/v6/child-users/delete.rb new file mode 100644 index 00000000..2989df1e --- /dev/null +++ b/official/docs/ruby/v6/child-users/delete.rb @@ -0,0 +1,5 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +client.user.delete('user_...') diff --git a/official/docs/ruby/v6/child-users/list.rb b/official/docs/ruby/v6/child-users/list.rb new file mode 100644 index 00000000..33105080 --- /dev/null +++ b/official/docs/ruby/v6/child-users/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +child_users = client.user.all_children( + page_size: 5, +) + +puts child_users diff --git a/official/docs/ruby/v6/claim/cancel.rb b/official/docs/ruby/v6/claim/cancel.rb new file mode 100644 index 00000000..a5386218 --- /dev/null +++ b/official/docs/ruby/v6/claim/cancel.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +claim = client.claim.cancel('clm_...') + +puts claim diff --git a/official/docs/ruby/v6/claim/create.rb b/official/docs/ruby/v6/claim/create.rb new file mode 100644 index 00000000..a6cd27a1 --- /dev/null +++ b/official/docs/ruby/v6/claim/create.rb @@ -0,0 +1,19 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +claim = client.claim.create( + type: 'damage', + email_evidence_attachments: + ['REPLACE_WITH_BASE64_STRING'], + invoice_attachments: + ['REPLACE_WITH_BASE64_STRING'], + supporting_documentation_attachments: + ['REPLACE_WITH_BASE64_STRING'], + description: 'Test Description', + contact_email: 'test@example.com', + tracking_code: 'YOUR_TRACKING_CODE', + amount: '100', +) + +puts claim diff --git a/official/docs/ruby/v6/claim/list.rb b/official/docs/ruby/v6/claim/list.rb new file mode 100644 index 00000000..5109f69d --- /dev/null +++ b/official/docs/ruby/v6/claim/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +claims = client.claim.all( + page_size: 5, +) + +puts claims diff --git a/official/docs/ruby/v6/claim/retrieve.rb b/official/docs/ruby/v6/claim/retrieve.rb new file mode 100644 index 00000000..c5bc62c7 --- /dev/null +++ b/official/docs/ruby/v6/claim/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +claim = client.claim.retrieve('clm_...') + +puts claim diff --git a/official/docs/ruby/v6/customs-infos/create.rb b/official/docs/ruby/v6/customs-infos/create.rb new file mode 100644 index 00000000..ea6f9b67 --- /dev/null +++ b/official/docs/ruby/v6/customs-infos/create.rb @@ -0,0 +1,24 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +customs_info = client.customs_info.create( + customs_certify: true, + customs_signer: 'Steve Brule', + contents_type: 'merchandise', + contents_explanation: '', + restriction_type: 'none', + eel_pfc: 'NOEEI 30.37(a)', + customs_items: [ + { + description: 'T-shirt', + quantity: 1, + weight: 5, + value: 10, + hs_tariff_number: '123456', + origin_country: 'US', + }, + ], +) + +puts customs_info diff --git a/official/docs/ruby/v6/customs-infos/retrieve.rb b/official/docs/ruby/v6/customs-infos/retrieve.rb new file mode 100644 index 00000000..0e1a4a73 --- /dev/null +++ b/official/docs/ruby/v6/customs-infos/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +customs_info = client.customs_info.retrieve('cstinfo_...') + +puts customs_info diff --git a/official/docs/ruby/v6/customs-items/create.rb b/official/docs/ruby/v6/customs-items/create.rb new file mode 100644 index 00000000..e2ddc898 --- /dev/null +++ b/official/docs/ruby/v6/customs-items/create.rb @@ -0,0 +1,14 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +customs_item = client.customs_item.create( + description: 'T-shirt', + quantity: 1, + weight: 5, + value: 10, + hs_tariff_number: '123456', + origin_country: 'us', +) + +puts customs_item diff --git a/official/docs/ruby/v6/customs-items/retrieve.rb b/official/docs/ruby/v6/customs-items/retrieve.rb new file mode 100644 index 00000000..4f0a24c6 --- /dev/null +++ b/official/docs/ruby/v6/customs-items/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +customs_item = client.customs_item.retrieve('cstitem_...') + +puts customs_item diff --git a/official/docs/ruby/v6/endshipper/buy.rb b/official/docs/ruby/v6/endshipper/buy.rb new file mode 100644 index 00000000..b11785d3 --- /dev/null +++ b/official/docs/ruby/v6/endshipper/buy.rb @@ -0,0 +1,15 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +retrieved_shipment = client.shipment.retrieve('shp_...') + +shipment = client.shipment.buy( + retrieved_shipment.id, + rate: retrieved_shipment.lowest_rate, + insurance: nil, + with_carbon_offset: false, + end_shipper_id: 'es_...', +) + +puts shipment diff --git a/official/docs/ruby/v6/endshipper/create.rb b/official/docs/ruby/v6/endshipper/create.rb new file mode 100644 index 00000000..45311aaa --- /dev/null +++ b/official/docs/ruby/v6/endshipper/create.rb @@ -0,0 +1,18 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +end_shipper = client.end_shipper.create( + name: 'FOO BAR', + company: 'BAZ', + street1: '164 TOWNSEND STREET UNIT 1', + street2: 'UNIT 1', + city: 'SAN FRANCISCO', + state: 'CA', + zip: '94107', + country: 'US', + phone: '555-555-5555', + email: 'FOO@EXAMPLE.COM', +) + +puts end_shipper diff --git a/official/docs/ruby/v6/endshipper/list.rb b/official/docs/ruby/v6/endshipper/list.rb new file mode 100644 index 00000000..20f99f04 --- /dev/null +++ b/official/docs/ruby/v6/endshipper/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +end_shippers = client.end_shipper.all( + page_size: 5, +) + +puts end_shippers diff --git a/official/docs/ruby/v6/endshipper/retrieve.rb b/official/docs/ruby/v6/endshipper/retrieve.rb new file mode 100644 index 00000000..0cf48fd0 --- /dev/null +++ b/official/docs/ruby/v6/endshipper/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +end_shipper = client.end_shipper.retrieve('es_...') + +puts end_shipper diff --git a/official/docs/ruby/v6/endshipper/update.rb b/official/docs/ruby/v6/endshipper/update.rb new file mode 100644 index 00000000..d4548634 --- /dev/null +++ b/official/docs/ruby/v6/endshipper/update.rb @@ -0,0 +1,20 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +end_shipper = client.end_shipper.update( + 'es_...', + { + 'name' => 'New Name', + 'street1' => '388 Townsend St', + 'street2' => 'Apt 20', + 'city' => 'San Francisco', + 'state' => 'CA', + 'zip' => '94107', + 'country' => 'US', + 'email' => 'test@example.com', + 'phone' => '5555555555', + }, +) + +puts end_shipper diff --git a/official/docs/ruby/v6/events/list.rb b/official/docs/ruby/v6/events/list.rb new file mode 100644 index 00000000..58d24e7e --- /dev/null +++ b/official/docs/ruby/v6/events/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +events = client.event.all( + page_size: 5, +) + +puts events diff --git a/official/docs/ruby/v6/events/retrieve.rb b/official/docs/ruby/v6/events/retrieve.rb new file mode 100644 index 00000000..256e6d55 --- /dev/null +++ b/official/docs/ruby/v6/events/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +event = client.event.retrieve('evt_...') + +puts event diff --git a/official/docs/ruby/v6/forms/create.rb b/official/docs/ruby/v6/forms/create.rb new file mode 100644 index 00000000..20ecc917 --- /dev/null +++ b/official/docs/ruby/v6/forms/create.rb @@ -0,0 +1,22 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +form_type = 'return_packing_slip' +form_options = { + type: 'return_packing_slip', + barcode: 'RMA12345678900', + line_items: [ + { + product: { + title: 'Square Reader', + barcode: '855658003251', + }, + units: '8', + }, + ], +} + +shipment = client.shipment.generate_form('shp_...', form_type, form_options) + +puts shipment diff --git a/official/docs/ruby/v6/insurance/create.rb b/official/docs/ruby/v6/insurance/create.rb new file mode 100644 index 00000000..66c1ce52 --- /dev/null +++ b/official/docs/ruby/v6/insurance/create.rb @@ -0,0 +1,18 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +insurance = client.insurance.create( + to_address: { + id: 'adr_...', + }, + from_address: { + id: 'adr_...', + }, + tracking_code: '9400110898825022579493', + carrier: 'USPS', + reference: 'insuranceRef1', + amount: '100.00', +) + +puts insurance diff --git a/official/docs/ruby/v6/insurance/list.rb b/official/docs/ruby/v6/insurance/list.rb new file mode 100644 index 00000000..c957b59b --- /dev/null +++ b/official/docs/ruby/v6/insurance/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +insurances = client.insurance.all( + page_size: 5, +) + +puts insurances diff --git a/official/docs/ruby/v6/insurance/refund.rb b/official/docs/ruby/v6/insurance/refund.rb new file mode 100644 index 00000000..f386a7bc --- /dev/null +++ b/official/docs/ruby/v6/insurance/refund.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +insurance = client.insurance.refund('ins_...') + +puts insurance diff --git a/official/docs/ruby/v6/insurance/retrieve.rb b/official/docs/ruby/v6/insurance/retrieve.rb new file mode 100644 index 00000000..c3065791 --- /dev/null +++ b/official/docs/ruby/v6/insurance/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +insurance = client.insurance.retrieve('ins_...') + +puts insurance diff --git a/official/docs/ruby/v6/options/create-with-options.rb b/official/docs/ruby/v6/options/create-with-options.rb new file mode 100644 index 00000000..b35a82b0 --- /dev/null +++ b/official/docs/ruby/v6/options/create-with-options.rb @@ -0,0 +1,20 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipment = client.shipment.create( + to_address: { + id: 'adr_...', + }, + from_address: { + id: 'adr_...', + }, + parcel: { + id: 'prcl_...', + }, + options: { + print_custom_1: 'Custom label message', + }, +) + +puts shipment diff --git a/official/docs/ruby/v6/orders/buy.rb b/official/docs/ruby/v6/orders/buy.rb new file mode 100644 index 00000000..573a89d9 --- /dev/null +++ b/official/docs/ruby/v6/orders/buy.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +order = client.order.buy('order_...', carrier: 'FedEx', service: 'FEDEX_GROUND') + +puts order diff --git a/official/docs/ruby/v6/orders/create.rb b/official/docs/ruby/v6/orders/create.rb new file mode 100644 index 00000000..8377f1b5 --- /dev/null +++ b/official/docs/ruby/v6/orders/create.rb @@ -0,0 +1,27 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +order = client.order.create( + to_address: { + id: 'adr_...', + }, + from_address: { + id: 'adr_...', + }, + shipments: [ + { + parcel: { + weight: 10.2, + }, + }, + { + parcel: { + predefined_package: 'FedExBox', + weight: 17.5, + }, + }, + ], +) + +puts order diff --git a/official/docs/ruby/v6/orders/one-call-buy.rb b/official/docs/ruby/v6/orders/one-call-buy.rb new file mode 100644 index 00000000..219b1e2b --- /dev/null +++ b/official/docs/ruby/v6/orders/one-call-buy.rb @@ -0,0 +1,29 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +order = client.order.create( + to_address: { + id: 'adr_...', + }, + from_address: { + id: 'adr_...', + }, + shipments: [ + { + parcel: { + weight: 10.2, + }, + }, + { + parcel: { + predefined_package: 'FedExBox', + weight: 17.5, + }, + }, + ], + service: 'NextDayAir', + carrier_accounts: ['ca_...'], +) + +puts order diff --git a/official/docs/ruby/v6/orders/retrieve.rb b/official/docs/ruby/v6/orders/retrieve.rb new file mode 100644 index 00000000..da5ee4dd --- /dev/null +++ b/official/docs/ruby/v6/orders/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +order = client.order.retrieve('order_...') + +puts order diff --git a/official/docs/ruby/v6/pagination/get-next-page.rb b/official/docs/ruby/v6/pagination/get-next-page.rb new file mode 100644 index 00000000..c3fa2d1f --- /dev/null +++ b/official/docs/ruby/v6/pagination/get-next-page.rb @@ -0,0 +1,11 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +# Get first page of results +shipments = client.shipment.all(page_size: 5) + +# Provide the previous results page to move onto the next page +next_page = client.shipment.get_next_page(shipments) + +puts next_page diff --git a/official/docs/ruby/v6/parcels/create.rb b/official/docs/ruby/v6/parcels/create.rb new file mode 100644 index 00000000..c0aac26c --- /dev/null +++ b/official/docs/ruby/v6/parcels/create.rb @@ -0,0 +1,12 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +parcel = client.parcel.create( + length: 20.2, + width: 10.9, + height: 5, + weight: 65.9, +) + +puts parcel diff --git a/official/docs/ruby/v6/parcels/retrieve.rb b/official/docs/ruby/v6/parcels/retrieve.rb new file mode 100644 index 00000000..1ebd3b43 --- /dev/null +++ b/official/docs/ruby/v6/parcels/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +parcel = client.parcel.retrieve('prcl_...') + +puts parcel diff --git a/official/docs/ruby/v6/payloads/list.rb b/official/docs/ruby/v6/payloads/list.rb new file mode 100644 index 00000000..d657f294 --- /dev/null +++ b/official/docs/ruby/v6/payloads/list.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +payloads = client.event.retrieve_all_payloads('evt_...') + +puts payloads diff --git a/official/docs/ruby/v6/payloads/retrieve.rb b/official/docs/ruby/v6/payloads/retrieve.rb new file mode 100644 index 00000000..2dfb79c4 --- /dev/null +++ b/official/docs/ruby/v6/payloads/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +payload = client.event.retrieve_payload('evt_...', 'payload_...') + +puts payload diff --git a/official/docs/ruby/v6/pickups/buy.rb b/official/docs/ruby/v6/pickups/buy.rb new file mode 100644 index 00000000..b2981ce3 --- /dev/null +++ b/official/docs/ruby/v6/pickups/buy.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +pickup = client.pickup.buy('pickup_...', carrier: 'UPS', service: 'Same-Day Pickup') + +puts pickup diff --git a/official/docs/ruby/v6/pickups/cancel.rb b/official/docs/ruby/v6/pickups/cancel.rb new file mode 100644 index 00000000..4c118ec2 --- /dev/null +++ b/official/docs/ruby/v6/pickups/cancel.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +pickup = client.pickup.cancel('pickup_...') + +puts pickup diff --git a/official/docs/ruby/v6/pickups/create.rb b/official/docs/ruby/v6/pickups/create.rb new file mode 100644 index 00000000..14ffb208 --- /dev/null +++ b/official/docs/ruby/v6/pickups/create.rb @@ -0,0 +1,19 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +pickup = client.pickup.create( + reference: 'my-first-pickup', + min_datetime: '2022-10-01 10:30:00', + max_datetime: '2022-10-02 10:30:00', + shipment: { + id: 'shp_...', + }, + address: { + id: 'adr_...', + }, + is_account_address: false, + instructions: 'Special pickup instructions', +) + +puts pickup diff --git a/official/docs/ruby/v6/pickups/list.rb b/official/docs/ruby/v6/pickups/list.rb new file mode 100644 index 00000000..7d283fdd --- /dev/null +++ b/official/docs/ruby/v6/pickups/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +pickups = client.pickup.all( + page_size: 5, +) + +puts pickups diff --git a/official/docs/ruby/v6/pickups/retrieve.rb b/official/docs/ruby/v6/pickups/retrieve.rb new file mode 100644 index 00000000..0cf442b0 --- /dev/null +++ b/official/docs/ruby/v6/pickups/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +pickup = client.pickup.retrieve('pickup_...') + +puts pickup diff --git a/official/docs/ruby/v6/rates/regenerate.rb b/official/docs/ruby/v6/rates/regenerate.rb new file mode 100644 index 00000000..ad4d5d35 --- /dev/null +++ b/official/docs/ruby/v6/rates/regenerate.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipment = client.shipment.regenerate_rates('shp_...') + +puts shipment diff --git a/official/docs/ruby/v6/rates/retrieve-stateless.rb b/official/docs/ruby/v6/rates/retrieve-stateless.rb new file mode 100644 index 00000000..92e8e61e --- /dev/null +++ b/official/docs/ruby/v6/rates/retrieve-stateless.rb @@ -0,0 +1,37 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipment_details = { + to_address: { + name: 'Dr. Steve Brule', + street1: '179 N Harbor Dr', + city: 'Redondo Beach', + state: 'CA', + zip: '90277', + country: 'US', + phone: '4155559999', + email: 'dr_steve_brule@gmail.com', + }, + from_address: { + name: 'EasyPost', + street1: '417 Montgomery Street', + street2: '5th Floor', + city: 'San Francisco', + state: 'CA', + zip: '94104', + country: 'US', + phone: '4153334445', + email: 'support@easypost.com', + }, + parcel: { + length: 20.2, + width: 10.9, + height: 5, + weight: 65.9, + }, +} + +rates = client.beta_rate.retrieve_stateless_rates(shipment_details) + +puts rates diff --git a/official/docs/ruby/v6/rates/retrieve.rb b/official/docs/ruby/v6/rates/retrieve.rb new file mode 100644 index 00000000..4571aac9 --- /dev/null +++ b/official/docs/ruby/v6/rates/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +rate = client.rate.retrieve('rate...') + +puts rate diff --git a/official/docs/ruby/v6/referral-customers/add-payment-method-with-bank-account.rb b/official/docs/ruby/v6/referral-customers/add-payment-method-with-bank-account.rb new file mode 100644 index 00000000..e4786e27 --- /dev/null +++ b/official/docs/ruby/v6/referral-customers/add-payment-method-with-bank-account.rb @@ -0,0 +1,11 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +payment_method = client.beta_referral_customer.add_payment_method( + 'cus_...', + 'ba_...', + 'primary', +) + +puts payment_method diff --git a/official/docs/ruby/v6/referral-customers/add-payment-method-with-credit-card.rb b/official/docs/ruby/v6/referral-customers/add-payment-method-with-credit-card.rb new file mode 100644 index 00000000..16543fbf --- /dev/null +++ b/official/docs/ruby/v6/referral-customers/add-payment-method-with-credit-card.rb @@ -0,0 +1,11 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +payment_method = client.beta_referral_customer.add_payment_method( + 'cus_...', + 'card_...', + 'primary', +) + +puts payment_method diff --git a/official/docs/ruby/v6/referral-customers/create.rb b/official/docs/ruby/v6/referral-customers/create.rb new file mode 100644 index 00000000..223080c5 --- /dev/null +++ b/official/docs/ruby/v6/referral-customers/create.rb @@ -0,0 +1,11 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +referral_user = client.referral_customer.create( + name: 'test user', + email: 'email@example.com', + phone: '8888888888', +) + +puts referral_user diff --git a/official/docs/ruby/v6/referral-customers/list.rb b/official/docs/ruby/v6/referral-customers/list.rb new file mode 100644 index 00000000..c6d4a052 --- /dev/null +++ b/official/docs/ruby/v6/referral-customers/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +referral_users = client.referral_customer.all( + page_size: 5, +) + +puts referral_users diff --git a/official/docs/ruby/v6/referral-customers/refund-by-amount.rb b/official/docs/ruby/v6/referral-customers/refund-by-amount.rb new file mode 100644 index 00000000..d6808ef8 --- /dev/null +++ b/official/docs/ruby/v6/referral-customers/refund-by-amount.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +refund = client.beta_referral_customer.refund_by_amount(2000) + +puts refund diff --git a/official/docs/ruby/v6/referral-customers/refund-by-payment-log.rb b/official/docs/ruby/v6/referral-customers/refund-by-payment-log.rb new file mode 100644 index 00000000..f62275e0 --- /dev/null +++ b/official/docs/ruby/v6/referral-customers/refund-by-payment-log.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +refund = client.beta_referral_customer.refund_by_payment_log('paylog_...') + +puts refund diff --git a/official/docs/ruby/v6/referral-customers/update.rb b/official/docs/ruby/v6/referral-customers/update.rb new file mode 100644 index 00000000..2f973d13 --- /dev/null +++ b/official/docs/ruby/v6/referral-customers/update.rb @@ -0,0 +1,10 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +message = client.referral_customer.update_email( + 'user_...', + 'new_email@example.com', +) + +puts message diff --git a/official/docs/ruby/v6/refunds/create.rb b/official/docs/ruby/v6/refunds/create.rb new file mode 100644 index 00000000..08ec3e81 --- /dev/null +++ b/official/docs/ruby/v6/refunds/create.rb @@ -0,0 +1,10 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +refunds = client.refund.create( + carrier: 'USPS', + tracking_codes: ['EZ1000000001'], +) + +puts refunds diff --git a/official/docs/ruby/v6/refunds/list.rb b/official/docs/ruby/v6/refunds/list.rb new file mode 100644 index 00000000..50ef4239 --- /dev/null +++ b/official/docs/ruby/v6/refunds/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +refunds = client.refund.all( + page_size: 5, +) + +puts refunds diff --git a/official/docs/ruby/v6/refunds/retrieve.rb b/official/docs/ruby/v6/refunds/retrieve.rb new file mode 100644 index 00000000..28d4b737 --- /dev/null +++ b/official/docs/ruby/v6/refunds/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +refund = client.refund.retrieve('rfnd_...') + +puts refund diff --git a/official/docs/ruby/v6/reports/create.rb b/official/docs/ruby/v6/reports/create.rb new file mode 100644 index 00000000..eca4ddba --- /dev/null +++ b/official/docs/ruby/v6/reports/create.rb @@ -0,0 +1,11 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +report = client.report.create( + type: 'payment_log', + start_date: '2022-10-01', + end_date: '2022-10-31', +) + +puts report diff --git a/official/docs/ruby/v6/reports/list.rb b/official/docs/ruby/v6/reports/list.rb new file mode 100644 index 00000000..1b02185a --- /dev/null +++ b/official/docs/ruby/v6/reports/list.rb @@ -0,0 +1,11 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +reports = client.report.all( + # Replace `payment_log` with any of the report types listed above + type: 'payment_log', + page_size: 5, +) + +puts reports diff --git a/official/docs/ruby/v6/reports/retrieve.rb b/official/docs/ruby/v6/reports/retrieve.rb new file mode 100644 index 00000000..76891ecd --- /dev/null +++ b/official/docs/ruby/v6/reports/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +report = client.report.retrieve('') + +puts report diff --git a/official/docs/ruby/v6/returns/create.rb b/official/docs/ruby/v6/returns/create.rb new file mode 100644 index 00000000..001e3145 --- /dev/null +++ b/official/docs/ruby/v6/returns/create.rb @@ -0,0 +1,36 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipment = client.shipment.create( + to_address: { + name: 'Dr. Steve Brule', + street1: '179 N Harbor Dr', + city: 'Redondo Beach', + state: 'CA', + zip: '90277', + country: 'US', + phone: '8573875756', + email: 'dr_steve_brule@gmail.com', + }, + from_address: { + name: 'EasyPost', + street1: '417 Montgomery Street', + street2: '5th Floor', + city: 'San Francisco', + state: 'CA', + zip: '94104', + country: 'US', + phone: '4153334445', + email: 'support@easypost.com', + }, + parcel: { + length: 20.2, + width: 10.9, + height: 5, + weight: 65.9, + }, + is_return: true, +) + +puts shipment diff --git a/official/docs/ruby/v6/scan-form/create.rb b/official/docs/ruby/v6/scan-form/create.rb new file mode 100644 index 00000000..8ebad975 --- /dev/null +++ b/official/docs/ruby/v6/scan-form/create.rb @@ -0,0 +1,16 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +scan_form = client.scan_form.create( + shipments: [ + { + id: 'shp_...', + }, + { + id: 'shp_...', + }, + ], +) + +puts scan_form diff --git a/official/docs/ruby/v6/scan-form/list.rb b/official/docs/ruby/v6/scan-form/list.rb new file mode 100644 index 00000000..250f21ed --- /dev/null +++ b/official/docs/ruby/v6/scan-form/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +scan_forms = client.scan_form.all( + page_size: 5, +) + +puts scan_forms diff --git a/official/docs/ruby/v6/scan-form/retrieve.rb b/official/docs/ruby/v6/scan-form/retrieve.rb new file mode 100644 index 00000000..687ede63 --- /dev/null +++ b/official/docs/ruby/v6/scan-form/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +scan_form = client.scan_form.retrieve('sf_...') + +puts scan_form diff --git a/official/docs/ruby/v6/shipments/buy.rb b/official/docs/ruby/v6/shipments/buy.rb new file mode 100644 index 00000000..0cd118a2 --- /dev/null +++ b/official/docs/ruby/v6/shipments/buy.rb @@ -0,0 +1,13 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +retrieved_shipment = client.shipment.retrieve + +shipment = client.shipment.buy( + retrieved_shipment.id, + rate: retrieved_shipment.lowest_rate, + insurance: '244.99', +) + +puts shipment diff --git a/official/docs/ruby/v6/shipments/create.rb b/official/docs/ruby/v6/shipments/create.rb new file mode 100644 index 00000000..c22548f8 --- /dev/null +++ b/official/docs/ruby/v6/shipments/create.rb @@ -0,0 +1,38 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipment = client.shipment.create( + to_address: { + name: 'Dr. Steve Brule', + street1: '179 N Harbor Dr', + city: 'Redondo Beach', + state: 'CA', + zip: '90277', + country: 'US', + phone: '4155559999', + email: 'dr_steve_brule@gmail.com', + }, + from_address: { + name: 'EasyPost', + street1: '417 Montgomery Street', + street2: '5th Floor', + city: 'San Francisco', + state: 'CA', + zip: '94104', + country: 'US', + phone: '4153334445', + email: 'support@easypost.com', + }, + parcel: { + length: 20.2, + width: 10.9, + height: 5, + weight: 65.9, + }, + customs_info: { + id: 'cstinfo_...', + }, +) + +puts shipment diff --git a/official/docs/ruby/v6/shipments/label.rb b/official/docs/ruby/v6/shipments/label.rb new file mode 100644 index 00000000..de8f633d --- /dev/null +++ b/official/docs/ruby/v6/shipments/label.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipment = client.shipment.label('shp_...', file_format: 'ZPL') + +puts shipment diff --git a/official/docs/ruby/v6/shipments/list.rb b/official/docs/ruby/v6/shipments/list.rb new file mode 100644 index 00000000..39319019 --- /dev/null +++ b/official/docs/ruby/v6/shipments/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipments = client.shipment.all( + page_size: 5, +) + +puts shipments diff --git a/official/docs/ruby/v6/shipments/one-call-buy.rb b/official/docs/ruby/v6/shipments/one-call-buy.rb new file mode 100644 index 00000000..07150ce9 --- /dev/null +++ b/official/docs/ruby/v6/shipments/one-call-buy.rb @@ -0,0 +1,37 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipment = client.shipment.create( + to_address: { + name: 'Dr. Steve Brule', + street1: '179 N Harbor Dr', + city: 'Redondo Beach', + state: 'CA', + zip: '90277', + country: 'US', + phone: '8573875756', + email: 'dr_steve_brule@gmail.com', + }, + from_address: { + name: 'EasyPost', + street1: '417 Montgomery Street', + street2: '5th Floor', + city: 'San Francisco', + state: 'CA', + zip: '94104', + country: 'US', + phone: '4153334445', + email: 'support@easypost.com', + }, + parcel: { + length: 20.2, + width: 10.9, + height: 5, + weight: 65.9, + }, + service: 'NextDayAir', + carrier_accounts: ['ca_...'], +) + +puts shipment diff --git a/official/docs/ruby/v6/shipments/retrieve.rb b/official/docs/ruby/v6/shipments/retrieve.rb new file mode 100644 index 00000000..70674579 --- /dev/null +++ b/official/docs/ruby/v6/shipments/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipment = client.shipment.retrieve('shp_...') + +puts shipment diff --git a/official/docs/ruby/v6/shipping-insurance/insure.rb b/official/docs/ruby/v6/shipping-insurance/insure.rb new file mode 100644 index 00000000..e4a0b33e --- /dev/null +++ b/official/docs/ruby/v6/shipping-insurance/insure.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipment = client.shipment.insure('shp_...', amount: 100) + +puts shipment diff --git a/official/docs/ruby/v6/shipping-refund/refund.rb b/official/docs/ruby/v6/shipping-refund/refund.rb new file mode 100644 index 00000000..a6dbd22b --- /dev/null +++ b/official/docs/ruby/v6/shipping-refund/refund.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipment = client.shipment.refund('shp_...') + +puts shipment diff --git a/official/docs/ruby/v6/smartrate/retrieve-estimated-delivery-date.rb b/official/docs/ruby/v6/smartrate/retrieve-estimated-delivery-date.rb new file mode 100644 index 00000000..cd92164d --- /dev/null +++ b/official/docs/ruby/v6/smartrate/retrieve-estimated-delivery-date.rb @@ -0,0 +1,10 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +estimated_delivery_dates = client.shipment.retrieve_estimated_delivery_date( + 'shp_...', + 'YYYY-MM-DD', +) + +puts estimated_delivery_dates diff --git a/official/docs/ruby/v6/smartrate/retrieve-recommend-ship-date.rb b/official/docs/ruby/v6/smartrate/retrieve-recommend-ship-date.rb new file mode 100644 index 00000000..4b5022e2 --- /dev/null +++ b/official/docs/ruby/v6/smartrate/retrieve-recommend-ship-date.rb @@ -0,0 +1,10 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +rates = client.shipment.recommend_ship_date( + 'shp_...', + 'YYYY-MM-DD', +) + +puts rates diff --git a/official/docs/ruby/v6/smartrate/retrieve-standalone-smartrate-deliver-by.rb b/official/docs/ruby/v6/smartrate/retrieve-standalone-smartrate-deliver-by.rb new file mode 100644 index 00000000..e8cabad0 --- /dev/null +++ b/official/docs/ruby/v6/smartrate/retrieve-standalone-smartrate-deliver-by.rb @@ -0,0 +1,14 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +params = { + from_zip: '10001', + to_zip: '10002', + planned_ship_date: '2024-07-18', + carriers: ['ups'], +} + +results = client.smart_rate.estimate_delivery_date(params) + +puts results diff --git a/official/docs/ruby/v6/smartrate/retrieve-standalone-smartrate-deliver-on.rb b/official/docs/ruby/v6/smartrate/retrieve-standalone-smartrate-deliver-on.rb new file mode 100644 index 00000000..3f6a3945 --- /dev/null +++ b/official/docs/ruby/v6/smartrate/retrieve-standalone-smartrate-deliver-on.rb @@ -0,0 +1,14 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +params = { + from_zip: '10001', + to_zip: '10002', + desired_delivery_date: '2024-07-18', + carriers: ['ups'], +} + +results = client.smart_rate.recommend_ship_date(params) + +puts results diff --git a/official/docs/ruby/v6/smartrate/retrieve-time-in-transit-statistics.rb b/official/docs/ruby/v6/smartrate/retrieve-time-in-transit-statistics.rb new file mode 100644 index 00000000..969bb1d7 --- /dev/null +++ b/official/docs/ruby/v6/smartrate/retrieve-time-in-transit-statistics.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipment = client.shipment.get_smart_rates('shp_...') + +puts shipment diff --git a/official/docs/ruby/v6/tax-identifiers/create.rb b/official/docs/ruby/v6/tax-identifiers/create.rb new file mode 100644 index 00000000..08d1c007 --- /dev/null +++ b/official/docs/ruby/v6/tax-identifiers/create.rb @@ -0,0 +1,46 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +shipment = client.shipment.create( + to_address: { + name: 'Dr. Steve Brule', + street1: '179 N Harbor Dr', + city: 'Redondo Beach', + state: 'CA', + zip: '90277', + country: 'US', + phone: '8573875756', + email: 'dr_steve_brule@gmail.com', + }, + from_address: { + name: 'EasyPost', + street1: '417 Montgomery Street', + street2: '5th Floor', + city: 'San Francisco', + state: 'CA', + zip: '94104', + country: 'US', + phone: '4153334445', + email: 'support@easypost.com', + }, + parcel: { + length: 20.2, + width: 10.9, + height: 5, + weight: 65.9, + }, + customs_info: { + id: 'cstinfo_...', + }, + tax_identifiers: [ + { + entity: 'SENDER', + tax_id: 'GB123456789', + tax_id_type: 'EORI', + issuing_country: 'GB', + }, + ], +) + +puts shipment diff --git a/official/docs/ruby/v6/trackers/create.rb b/official/docs/ruby/v6/trackers/create.rb new file mode 100644 index 00000000..a7754070 --- /dev/null +++ b/official/docs/ruby/v6/trackers/create.rb @@ -0,0 +1,10 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +tracker = client.tracker.create( + tracking_code: 'EZ1000000001', + carrier: 'USPS', +) + +puts tracker diff --git a/official/docs/ruby/v6/trackers/list.rb b/official/docs/ruby/v6/trackers/list.rb new file mode 100644 index 00000000..88b57efa --- /dev/null +++ b/official/docs/ruby/v6/trackers/list.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +trackers = client.tracker.all( + page_size: 5, +) + +puts trackers diff --git a/official/docs/ruby/v6/trackers/retrieve.rb b/official/docs/ruby/v6/trackers/retrieve.rb new file mode 100644 index 00000000..3d6a1323 --- /dev/null +++ b/official/docs/ruby/v6/trackers/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +tracker = client.tracker.retrieve('trk_...') + +puts tracker diff --git a/official/docs/ruby/v6/users/retrieve.rb b/official/docs/ruby/v6/users/retrieve.rb new file mode 100644 index 00000000..4e850aab --- /dev/null +++ b/official/docs/ruby/v6/users/retrieve.rb @@ -0,0 +1,11 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +# Retrieve the authenticated user +user = client.user.retrieve_me + +# Retrieve a child user +user = client.user.retrieve('user_...') + +puts user diff --git a/official/docs/ruby/v6/users/update.rb b/official/docs/ruby/v6/users/update.rb new file mode 100644 index 00000000..60a335e2 --- /dev/null +++ b/official/docs/ruby/v6/users/update.rb @@ -0,0 +1,9 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +retrieved_user = client.user.retrieve_me + +user = client.user.update(retrieved_user.id, recharge_amount: '50.00') + +puts user diff --git a/official/docs/ruby/v6/webhooks/create.rb b/official/docs/ruby/v6/webhooks/create.rb new file mode 100644 index 00000000..b6f580bf --- /dev/null +++ b/official/docs/ruby/v6/webhooks/create.rb @@ -0,0 +1,10 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +webhook = client.webhook.create( + url: 'example.com', + webhook_secret: 'A1B2C3', +) + +puts webhook diff --git a/official/docs/ruby/v6/webhooks/delete.rb b/official/docs/ruby/v6/webhooks/delete.rb new file mode 100644 index 00000000..34028215 --- /dev/null +++ b/official/docs/ruby/v6/webhooks/delete.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +webhook = client.webhook.retrieve('hook_...') + +client.webhook.delete(webhook.id) diff --git a/official/docs/ruby/v6/webhooks/list.rb b/official/docs/ruby/v6/webhooks/list.rb new file mode 100644 index 00000000..c728ff1f --- /dev/null +++ b/official/docs/ruby/v6/webhooks/list.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +webhooks = client.webhook.all + +puts webhooks diff --git a/official/docs/ruby/v6/webhooks/retrieve.rb b/official/docs/ruby/v6/webhooks/retrieve.rb new file mode 100644 index 00000000..532403e8 --- /dev/null +++ b/official/docs/ruby/v6/webhooks/retrieve.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +webhook = client.webhook.retrieve('hook_...') + +puts webhook diff --git a/official/docs/ruby/v6/webhooks/update.rb b/official/docs/ruby/v6/webhooks/update.rb new file mode 100644 index 00000000..37224dfb --- /dev/null +++ b/official/docs/ruby/v6/webhooks/update.rb @@ -0,0 +1,7 @@ +require 'easypost' + +client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') + +webhook = client.webhook.update('hook_...') + +puts webhook diff --git a/official/guides/errors-guide/ruby/catch-error.rb b/official/guides/errors-guide/ruby/catch-error.rb index 724483fa..8b52bd01 100644 --- a/official/guides/errors-guide/ruby/catch-error.rb +++ b/official/guides/errors-guide/ruby/catch-error.rb @@ -2,8 +2,19 @@ client = EasyPost::Client.new(api_key: 'EASYPOST_API_KEY') +# When the `errors` key is returned as an array of FieldError objects begin - client.address.create({ strict_verify: true }) + # Simulate a request with missing parameters + client.shipment.create({}) rescue EasyPost::Errors::Api::ApiError => e - puts e.code + puts e.errors[0]['message'] +end + +# When the `errors` key is returned as an array of strings +begin + client.claim.create( + tracking_code: '123', # Simulate a request with an invalid tracking code + ) +rescue EasyPost::Errors::Api::ApiError => e + puts e.errors[0] end From 0205dc8d79be1c6886341d6f8f7aec08a6463f8b Mon Sep 17 00:00:00 2001 From: Justintime50 <39606064+Justintime50@users.noreply.github.com> Date: Thu, 8 May 2025 14:19:39 -0600 Subject: [PATCH 2/3] fix: ruby endshipper example arrow --- .../docs/ruby/current/endshipper/update.rb | 18 +++++++++--------- official/docs/ruby/v5/endshipper/update.rb | 18 +++++++++--------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/official/docs/ruby/current/endshipper/update.rb b/official/docs/ruby/current/endshipper/update.rb index d4548634..3903a1c1 100644 --- a/official/docs/ruby/current/endshipper/update.rb +++ b/official/docs/ruby/current/endshipper/update.rb @@ -5,15 +5,15 @@ end_shipper = client.end_shipper.update( 'es_...', { - 'name' => 'New Name', - 'street1' => '388 Townsend St', - 'street2' => 'Apt 20', - 'city' => 'San Francisco', - 'state' => 'CA', - 'zip' => '94107', - 'country' => 'US', - 'email' => 'test@example.com', - 'phone' => '5555555555', + name: 'New Name', + street1: '388 Townsend St', + street2: 'Apt 20', + city: 'San Francisco', + state: 'CA', + zip: '94107', + country: 'US', + email: 'test@example.com', + phone: '5555555555', }, ) diff --git a/official/docs/ruby/v5/endshipper/update.rb b/official/docs/ruby/v5/endshipper/update.rb index bfdd5d44..c07e6902 100644 --- a/official/docs/ruby/v5/endshipper/update.rb +++ b/official/docs/ruby/v5/endshipper/update.rb @@ -5,15 +5,15 @@ retrieved_endshipper = client.end_shipper.retrieve('es_...') update_data = { - 'name' => 'New Name', - 'street1' => '388 Townsend St', - 'street2' => 'Apt 20', - 'city' => 'San Francisco', - 'state' => 'CA', - 'zip' => '94107', - 'country' => 'US', - 'email' => 'test@example.com', - 'phone' => '5555555555', + name: 'New Name', + street1: '388 Townsend St', + street2: 'Apt 20', + city: 'San Francisco', + state: 'CA', + zip: '94107', + country: 'US', + email: 'test@example.com', + phone: '5555555555', } end_shipper = client.end_shipper.update(retrieved_endshipper.id, update_data) From f7c43036ac2a89bdb04b8e298fbbd09c8db32f1d Mon Sep 17 00:00:00 2001 From: Justintime50 <39606064+Justintime50@users.noreply.github.com> Date: Thu, 8 May 2025 14:33:25 -0600 Subject: [PATCH 3/3] fix: another endshipper arrow --- official/docs/ruby/v6/endshipper/update.rb | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/official/docs/ruby/v6/endshipper/update.rb b/official/docs/ruby/v6/endshipper/update.rb index d4548634..3903a1c1 100644 --- a/official/docs/ruby/v6/endshipper/update.rb +++ b/official/docs/ruby/v6/endshipper/update.rb @@ -5,15 +5,15 @@ end_shipper = client.end_shipper.update( 'es_...', { - 'name' => 'New Name', - 'street1' => '388 Townsend St', - 'street2' => 'Apt 20', - 'city' => 'San Francisco', - 'state' => 'CA', - 'zip' => '94107', - 'country' => 'US', - 'email' => 'test@example.com', - 'phone' => '5555555555', + name: 'New Name', + street1: '388 Townsend St', + street2: 'Apt 20', + city: 'San Francisco', + state: 'CA', + zip: '94107', + country: 'US', + email: 'test@example.com', + phone: '5555555555', }, )