easypost 6.4.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 643a95f0b48e9abedc30e67d868ec3538d8d896b9c385734966805c83e72bd90
-  data.tar.gz: a532de25388ea110f152e77205bea2104228e83e7279dc66d0b500238d5b8416
+  metadata.gz: a490b659ed5817624823ce658ac7557662d362a79d3fdcd299fda513e4d70a6d
+  data.tar.gz: bd49a9afc7da9416fcbe7f3bc6d6088a83863256a32457fb2fa0701721adca3e
 SHA512:
-  metadata.gz: 94b9cf67261d5c9bba01183812bef018d0b4918cc5f3593befdff2884095816299585bf33d86ee0de14015814c53ddd2911b9de85692c9c73421e1133cd57605
-  data.tar.gz: ba8c81ed037de3ccad7441eba06111eefb7430e69ac36169dd3409efa7965a092b18bc114d3767610dcb15453a6bfeed584073f35a986214b96f5eab4c6e2dcb
+  metadata.gz: baaaeaed6a61e88644c96a7cf4f25627cd4eb5be33f77717814836afaefd3e56915dec5adae1033772ac2fd388dc9ba84a3c27e8392a75942d9c63a3c9ff3573
+  data.tar.gz: 8ae9c41a8b377ea0de2ad14272e54247437a6c8716baba87709be6b87ebfe1fabd5729666549f1ddd1968a86ee3ad5521c8b2a9c9f8dd2cf54ecbff4d85dc06f

data/.github/CODEOWNERS

@@ -1,2 +1,2 @@
-# Ping the DevEx team for reviews on every PR
-* @EasyPost/devex
+# Ping the Shippers team for reviews on every PR
+* @EasyPost/team-shippers

data/.github/workflows/ci.yml

@@ -11,12 +11,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rubyversion: ['2.6', '2.7', '3.0', '3.1', '3.2', '3.3']
+        rubyversion: ['2.7', '3.0', '3.1', '3.2', '3.3', '3.4']
     steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v3
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.rubyversion }}
           rubygems: '3.3.0'
@@ -34,12 +32,10 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v3
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.3'
+          ruby-version: '3.4'
           rubygems: '3.3.0'
           bundler-cache: true
       - name: Install Dependencies
@@ -52,12 +48,10 @@ jobs:
     if: github.ref == 'refs/heads/master'
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout Repository
-        uses: actions/checkout@v3
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.3'
+          ruby-version: '3.4'
           rubygems: '3.3.0'
           bundler-cache: true
       - name: Install Dependencies

data/.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: release
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch: ~
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          rubygems: '3.3.0'
+          bundler-cache: true
+      - name: Build Package
+        run: make install build
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+          gem push dist/*.gem
+        env:
+          RUBYGEMS_API_KEY: '${{secrets.RUBYGEMS_API_KEY}}'
+      - name: Upload assets to release
+        uses: AButler/upload-release-assets@v3.0
+        with:
+          files: 'dist/*'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # CHANGELOG
 
+## v7.0.0 (2025-04-28)
+
+See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-6x-to-70) for more details.
+
+- Adds Ruby 3.4 support
+- Adds the following functions to assist ReferralCustomers add credit cards and bank accounts:
+  - `beta_referral_customer.create_credit_card_client_secret`
+  - `beta_referral_customer.create_bank_account_client_secret`
+  - `referral_customer.add_credit_card_from_stripe`
+  - `referral_customer.add_bank_account_from_stripe`
+- Routes `AmazonShippingAccount` to the proper create endpoint
+- Fixes error parsing
+  - Allows for alternative format of `errors` field
+  - Corrects available properties of an `EasyPostError` and `ApiError` (`code` and `field` removed from `EasyPostError`, `message` unfurled and explicitly added to `ApiError`)
+  - Removes unused `Error` model
+- Corrects the HTTP verb for updating a brand from `GET` to `PATCH`
+- Removes deprecated `create_list` tracker endpoint function as it is no longer available via API
+- Removes deprecated `user.all_api_keys` and `user.api_keys`, use `api_key.all` and `api_key.retrieve_api_keys_for_user` respectively
+- Removes unmaintained and undocumented `irb`
+- Removes unused `Rakefile`
+- Bumps all dev dependencies
+
+## v6.4.1 (2024-08-09)
+
+- Send GET requests as query parameters instead of JSON body parameters
+- Fix get_next_page_of_children function for User service with correct filter key
+
 ## v6.4.0 (2024-07-24)
 
 - Adds new `Claim` service for filing claims on EasyPost shipments and insurances
@@ -25,6 +52,8 @@
 
 ## v6.0.0 (2023-12-06)
 
+See our [Upgrade Guide](UPGRADE_GUIDE.md#upgrading-from-5x-to-60) for more details.
+
 - Removes `with_carbon_offset` parameter from `create`, `buy` and `regenerate_rates` methods in the shipment service since now EasyPost offers carbon neutral shipments by default for free
 - Fixes a bug where the original filtering criteria of `all` calls wasn't passed along to `get_next_page` calls. Now, these are persisted via `_params` key on response objects
 - Removes the undocumented `create_and_buy` function from the Batch service. The proper usage is to create a batch first and buy it separately

data/Makefile

@@ -13,15 +13,14 @@ clean:
 	rm -rf coverage doc *.gem dist
 
 ## coverage - Generate a test coverage report
-coverage:
-	make test
+coverage: test
 
 ## docs - Generate documentation for the library
 docs:
 	bundle exec rdoc lib -o docs --title "EasyPost Ruby Docs"
 
 ## install-styleguide - Import the style guides (Unix only)
-install-styleguide: | update-examples-submodule
+install-styleguide: | init-examples-submodule
 	sh examples/symlink_directory_files.sh examples/style_guides/ruby .
 
 ## init-examples-submodule - Initialize the examples submodule

data/UPGRADE_GUIDE.md

@@ -2,12 +2,47 @@
 
 Use the following guide to assist in the upgrade process of the `easypost-ruby` library between major versions.
 
+- [Upgrading from 6.x to 7.0](#upgrading-from-6x-to-70)
 - [Upgrading from 5.x to 6.0](#upgrading-from-5x-to-60)
 - [Upgrading from 4.x to 5.0](#upgrading-from-4x-to-50)
 - [Upgrading from 3.x to 4.0](#upgrading-from-3x-to-40)
 
+## Upgrading from 6.x to 7.0
+
+### 7.0 High Impact Changes
+
+- [Error Parsing](#70-error-parsing)
+
+### 7.0 Medium Impact Changes
+
+- [Deprecations](#70-deprecations)
+
+## 7.0 Error Parsing
+
+*Likelihood of Impact: **High***
+
+The `errors` key of an error response can return either a list of `FieldError` objects or a list of strings. The error parsing has been expanded to include both formats. As such, you will now need to check for the format of the `errors` field and handle the errors appropriately for the type that is returned.
+
+The `Error` model has been removed since it is unused and we directly assign properties of an error response to the `ApiError` type.
+
+The `code` and `field` properties of an `EasyPostError` have been removed as they only belong to the `ApiError` type.
+
+## 7.0 Deprecations
+
+*Likelihood of Impact: **Medium***
+
+The following deprecated functions have been removed:
+
+- `tracker.create_list` (trackers must be created individually moving forward)
+- `user.all_api_keys` (use `api_key.all`)
+- `user.api_keys` (use `api_key.retrieve_api_keys_for_user`)
+
+The `irb` has been removed from this library.
+
 ## Upgrading from 5.x to 6.0
 
+**NOTICE:** v6 is deprecated.
+
 ### 6.0 High Impact Changes
 
 - [Carbon Offset Removed](#60-carbon-offset-removed)
@@ -156,18 +191,18 @@ Empty API response functions for `delete` return `true` instead of empty object
 
 ### 4.0 High Impact Changes
 
-* [Updating Dependencies](#40-updating-dependencies)
+- [Updating Dependencies](#40-updating-dependencies)
 
 ### 4.0 Medium Impact Changes
 
-* [Removal of `get_rates` Shipment Method](#40-removal-of-getrates-shipment-method)
+- [Removal of `get_rates` Shipment Method](#40-removal-of-getrates-shipment-method)
 
 ### 4.0 Low Impact Changes
 
-* [Removal of `Print` and `PrintJob` Objects](#40-removal-of-print-and-printjob-objects)
-* [Removal of `stamp_and_barcode_by_reference` Batch Method](#40-removal-of-stampandbarcodebyreference-batch-method)
-* [Removal of `Address.verify` Parameters](#40-removal-of-addressverify-parameters)
-* [Removal of the `http_status` Property on EasyPost::Error](#40-removal-of-httpstatus-property-on-easyposterror)
+- [Removal of `Print` and `PrintJob` Objects](#40-removal-of-print-and-printjob-objects)
+- [Removal of `stamp_and_barcode_by_reference` Batch Method](#40-removal-of-stampandbarcodebyreference-batch-method)
+- [Removal of `Address.verify` Parameters](#40-removal-of-addressverify-parameters)
+- [Removal of the `http_status` Property on EasyPost::Error](#40-removal-of-httpstatus-property-on-easyposterror)
 
 ## 4.0 Updating Dependencies
 

data/VERSION

@@ -1 +1 @@
-6.4.0
+7.0.0

data/easypost.gemspec

@@ -17,21 +17,23 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(docs|examples|spec)/})
   end
-  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.6'
+  spec.required_ruby_version = '>= 2.7'
 
-  spec.add_development_dependency 'brakeman', '~> 5.4'
-  spec.add_development_dependency 'faraday', '~> 2.7.5' # used for integration tests
-  spec.add_development_dependency 'pry', '~> 0.14'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rdoc', '~> 6.5'
-  spec.add_development_dependency 'rspec', '~> 3.12'
-  spec.add_development_dependency 'rubocop', '~> 1.49'
-  spec.add_development_dependency 'rubocop-rspec', '2.19' # pin to 2.19 because latest version doesn't support Ruby 2.6
+  spec.add_development_dependency 'abbrev', '~> 0.1'
+  spec.add_development_dependency 'benchmark', '~> 0.4'
+  spec.add_development_dependency 'bigdecimal', '~> 3'
+  spec.add_development_dependency 'brakeman', '~> 5.4' # can't upgrade to 6.x, requires Ruby 3.0
+  spec.add_development_dependency 'faraday', '~> 2.8' # can't upgrade to 2.9, requires Ruby 3.0
+  spec.add_development_dependency 'logger', '~> 1'
+  spec.add_development_dependency 'ostruct', '~> 0.6'
+  spec.add_development_dependency 'rdoc', '~> 6.12'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'rubocop', '= 1.72' # TODO: v1.73 no longer packages certain plugins and will require changes
+  spec.add_development_dependency 'rubocop-rspec', '= 2.31' # can't upgrade to 3.0, requires easycop config changes
   spec.add_development_dependency 'simplecov', '~> 0.22'
   spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
-  spec.add_development_dependency 'typhoeus', '~> 1.4.0' # used for integration tests
-  spec.add_development_dependency 'vcr', '~> 6.1'
-  spec.add_development_dependency 'webmock', '~> 3.18'
+  spec.add_development_dependency 'typhoeus', '~> 1.4'
+  spec.add_development_dependency 'vcr', '~> 6.3'
+  spec.add_development_dependency 'webmock', '~> 3.25'
 end

data/lib/easypost/client.rb

@@ -74,17 +74,17 @@ class EasyPost::Client
   #
   # @param method [Symbol] the HTTP Verb (get, method, put, post, etc.)
   # @param endpoint [String] URI path of the resource
-  # @param body [Object] (nil) object to be dumped to JSON
+  # @param params [Object] (nil) object to be used as the request parameters
   # @param api_version [String] the version of API to hit
-  # @raise [EasyPost::Error] if the response has a non-2xx status code
+  # @raise [EasyPost::Errors::EasyPostError] if the response has a non-2xx status code
   # @return [Hash] JSON object parsed from the response body
   def make_request(
     method,
     endpoint,
-    body = nil,
+    params = nil,
     api_version = EasyPost::InternalUtilities::Constants::API_VERSION
   )
-    response = @http_client.request(method, endpoint, nil, body, api_version)
+    response = @http_client.request(method, endpoint, nil, params, api_version)
 
     potential_error = EasyPost::Errors::ApiError.handle_api_error(response)
     raise potential_error unless potential_error.nil?

data/lib/easypost/connection.rb

@@ -7,7 +7,7 @@ EasyPost::Connection = Struct.new(:uri, :config, keyword_init: true) do
   # @param path [String] URI path of the resource
   # @param requested_api_key [String] ({EasyPost.api_key}) key set Authorization header.
   # @param body [String] (nil) body of the request
-  # @raise [EasyPost::Error] if the response has a non-2xx status code
+  # @raise [EasyPost::Errors::EasyPostError] if the response has a non-2xx status code
   # @return [Hash] JSON object parsed from the response body
   def call(method, path, api_key = nil, body = nil)
     raise EasyPost::Errors::MissingParameterError.new('api_key') if api_key.nil?

data/lib/easypost/errors/api/api_error.rb

@@ -4,10 +4,13 @@ require_relative '../easy_post_error'
 require 'easypost/constants'
 
 class EasyPost::Errors::ApiError < EasyPost::Errors::EasyPostError
-  attr_reader :status_code, :code, :errors
+  attr_reader :message, :status_code, :code, :errors
 
   def initialize(message, status_code = nil, error_code = nil, sub_errors = nil)
     super message
+    message_list = []
+    EasyPost::Errors::ApiError.collect_error_messages(message, message_list)
+    @message = message_list.join(', ')
     @status_code = status_code
     @code = error_code
     @errors = sub_errors
@@ -46,12 +49,9 @@ class EasyPost::Errors::ApiError < EasyPost::Errors::EasyPostError
     # Try to parse the response body as JSON
     begin
       error_data = JSON.parse(response.body)['error']
-
       error_message = error_data['message']
       error_type = error_data['code']
-      errors = error_data['errors']&.map do |error|
-        EasyPost::Models::Error.from_api_error_response(error)
-      end
+      errors = error_data['errors']
     rescue StandardError
       error_message = response.code.to_s
       error_type = EasyPost::Constants::API_ERROR_DETAILS_PARSING_ERROR

data/lib/easypost/http_client.rb

@@ -14,26 +14,35 @@ class EasyPost::HttpClient
     method,
     path,
     headers = nil,
-    body = nil,
+    params = nil,
     api_version = EasyPost::InternalUtilities::Constants::API_VERSION
   )
     # Remove leading slash from path.
     path = path[1..] if path[0] == '/'
 
-    uri = URI.parse("#{@base_url}/#{api_version}/#{path}")
     headers = @config[:headers].merge(headers || {})
-    serialized_body = JSON.dump(EasyPost::InternalUtilities.objects_to_ids(body)) if body
     open_timeout = @config[:open_timeout]
     read_timeout = @config[:read_timeout]
     request_timestamp = Time.now
     request_uuid = SecureRandom.uuid
 
+    uri = URI.parse("#{@base_url}/#{api_version}/#{path}")
+    serialized_body = nil
+
+    if params
+      if [:get, :delete].include?(method)
+        uri.query = URI.encode_www_form(params)
+      elsif params
+        serialized_body = JSON.dump(EasyPost::InternalUtilities.objects_to_ids(params))
+      end
+    end
+
     if EasyPost::Hooks.any_subscribers?(:request)
       request_context = EasyPost::Hooks::RequestContext.new(
         method: method,
         path: uri.to_s,
         headers: headers,
-        request_body: body,
+        request_body: serialized_body,
         request_timestamp: request_timestamp,
         request_uuid: request_uuid,
       )

data/lib/easypost/models.rb

@@ -14,7 +14,6 @@ require_relative 'models/claim'
 require_relative 'models/customs_info'
 require_relative 'models/customs_item'
 require_relative 'models/end_shipper'
-require_relative 'models/error'
 require_relative 'models/event'
 require_relative 'models/insurance'
 require_relative 'models/order'

data/lib/easypost/services/address.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::Address < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Address
+  MODEL_CLASS = EasyPost::Models::Address # :nodoc:
 
   # Create an address.
   def create(params = {})

data/lib/easypost/services/batch.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::Batch < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Batch
+  MODEL_CLASS = EasyPost::Models::Batch # :nodoc:
 
   # Create a Batch.
   def create(params = {})

data/lib/easypost/services/beta_referral_customer.rb

@@ -41,4 +41,19 @@ class EasyPost::Services::BetaReferralCustomer < EasyPost::Services::Service
 
     EasyPost::InternalUtilities::Json.convert_json_to_object(response)
   end
+
+  # Creates a client secret to use with Stripe when adding a credit card.
+  def create_credit_card_client_secret
+    response = @client.make_request(:post, 'setup_intents', nil, 'beta')
+
+    EasyPost::InternalUtilities::Json.convert_json_to_object(response)
+  end
+
+  # Creates a client secret to use with Stripe when adding a bank account.
+  def create_bank_account_client_secret(return_url = nil)
+    params = return_url ? { return_url: return_url } : nil
+    response = @client.make_request(:post, 'financial_connections_sessions', params, 'beta')
+
+    EasyPost::InternalUtilities::Json.convert_json_to_object(response)
+  end
 end

data/lib/easypost/services/carrier_account.rb

@@ -3,7 +3,8 @@
 class EasyPost::Services::CarrierAccount < EasyPost::Services::Service
   CUSTOM_WORKFLOW_CARRIER_TYPES = %w[FedexAccount FedexSmartpostAccount].freeze
   UPS_OAUTH_CARRIER_ACCOUNT_TYPES = %w[UpsAccount UpsMailInnovationsAccount UpsSurepostAccount].freeze
-  MODEL_CLASS = EasyPost::Models::CarrierAccount
+  CARRIER_ACCOUNT_TYPES_WITH_CUSTOM_OAUTH = %w[AmazonShippingAccount].freeze
+  MODEL_CLASS = EasyPost::Models::CarrierAccount # :nodoc:
 
   # Create a carrier account
   def create(params = {})
@@ -15,6 +16,8 @@ class EasyPost::Services::CarrierAccount < EasyPost::Services::Service
                    'carrier_accounts/register'
                  elsif UPS_OAUTH_CARRIER_ACCOUNT_TYPES.include?(carrier_account_type)
                    'ups_oauth_registrations'
+                 elsif CARRIER_ACCOUNT_TYPES_WITH_CUSTOM_OAUTH.include?(carrier_account_type)
+                   'carrier_accounts/register_oauth'
                  else
                    'carrier_accounts'
                  end
@@ -63,6 +66,8 @@ class EasyPost::Services::CarrierAccount < EasyPost::Services::Service
   def select_top_layer_key(carrier_account_type)
     if UPS_OAUTH_CARRIER_ACCOUNT_TYPES.include?(carrier_account_type)
       'ups_oauth_registrations'
+    elsif CARRIER_ACCOUNT_TYPES_WITH_CUSTOM_OAUTH.include?(carrier_account_type)
+      'carrier_account_oauth_registrations'
     else
       'carrier_account'
     end

data/lib/easypost/services/carrier_type.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::CarrierType < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::CarrierType
+  MODEL_CLASS = EasyPost::Models::CarrierType # :nodoc:
 
   # Retrieve all carrier types
   def all

data/lib/easypost/services/claim.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::Claim < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Claim
+  MODEL_CLASS = EasyPost::Models::Claim # :nodoc:
 
   # Create an Claim object
   def create(params = {})

data/lib/easypost/services/customs_info.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::CustomsInfo < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::CustomsInfo
+  MODEL_CLASS = EasyPost::Models::CustomsInfo # :nodoc:
 
   # Create a CustomsInfo object
   def create(params)

data/lib/easypost/services/customs_item.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::CustomsItem < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::CustomsItem
+  MODEL_CLASS = EasyPost::Models::CustomsItem # :nodoc:
 
   # Create a CustomsItem object
   def create(params)

data/lib/easypost/services/end_shipper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::EndShipper < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::EndShipper
+  MODEL_CLASS = EasyPost::Models::EndShipper # :nodoc:
 
   # Create an EndShipper object.
   def create(params = {})

data/lib/easypost/services/event.rb

@@ -3,7 +3,7 @@
 require 'json'
 
 class EasyPost::Services::Event < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Event
+  MODEL_CLASS = EasyPost::Models::Event # :nodoc:
 
   # Retrieve an Event object
   def retrieve(id)

data/lib/easypost/services/insurance.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::Insurance < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Insurance
+  MODEL_CLASS = EasyPost::Models::Insurance # :nodoc:
 
   # Create an Insurance object
   def create(params = {})

data/lib/easypost/services/order.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::Order < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Order
+  MODEL_CLASS = EasyPost::Models::Order # :nodoc:
 
   # Create an Order object
   def create(params = {})

data/lib/easypost/services/parcel.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::Parcel < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Parcel
+  MODEL_CLASS = EasyPost::Models::Parcel # :nodoc:
 
   # Create a Parcel object
   def create(params = {})

data/lib/easypost/services/pickup.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::Pickup < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Pickup
+  MODEL_CLASS = EasyPost::Models::Pickup # :nodoc:
 
   # Create a Pickup object
   def create(params = {})

data/lib/easypost/services/referral_customer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::ReferralCustomer < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::User
+  MODEL_CLASS = EasyPost::Models::User # :nodoc:
 
   # Create a referral customer. This function requires the Partner User's API key.
   def create(params = {})
@@ -40,7 +40,7 @@ class EasyPost::Services::ReferralCustomer < EasyPost::Services::Service
     all(params)
   end
 
-  # Add credit card to a referral customer. This function requires the ReferralCustomer Customer's API key.
+  # Add a credit card to EasyPost for a ReferralCustomer without needing a Stripe account. This function requires the ReferralCustomer User's API key.
   def add_credit_card(referral_api_key, number, expiration_month, expiration_year, cvc, priority = 'primary')
     easypost_stripe_api_key = retrieve_easypost_stripe_api_key
 
@@ -59,6 +59,41 @@ class EasyPost::Services::ReferralCustomer < EasyPost::Services::Service
     create_easypost_credit_card(referral_api_key, stripe_credit_card_token, priority)
   end
 
+  # Add a credit card to EasyPost for a ReferralCustomer with a payment method ID from Stripe. This function requires the ReferralCustomer User's API key.
+  def add_credit_card_from_stripe(referral_api_key, payment_method_id, priority = 'primary')
+    params = {
+      credit_card: {
+        payment_method_id: payment_method_id,
+        priority: priority,
+      },
+    }
+    referral_client = EasyPost::Client.new(api_key: referral_api_key)
+    response = referral_client.make_request(
+      :post,
+      'credit_cards',
+      params,
+    )
+
+    EasyPost::InternalUtilities::Json.convert_json_to_object(response)
+  end
+
+  # Add a bank account to EasyPost for a ReferralCustomer. This function requires the ReferralCustomer User's API key.
+  def add_bank_account_from_stripe(referral_api_key, financial_connections_id, mandate_data, priority = 'primary')
+    params = {
+      financial_connections_id: financial_connections_id,
+      mandate_data: mandate_data,
+      priority: priority,
+    }
+    referral_client = EasyPost::Client.new(api_key: referral_api_key)
+    response = referral_client.make_request(
+      :post,
+      'bank_accounts',
+      params,
+    )
+
+    EasyPost::InternalUtilities::Json.convert_json_to_object(response)
+  end
+
   private
 
   # Retrieve EasyPost's Stripe public API key.

data/lib/easypost/services/refund.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::Refund < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Refund
+  MODEL_CLASS = EasyPost::Models::Refund # :nodoc:
 
   # Create a Refund object
   def create(params = {})

data/lib/easypost/services/report.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::Report < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Report
+  MODEL_CLASS = EasyPost::Models::Report # :nodoc:
 
   # Create a Report
   def create(params = {})
     unless params[:type]
-      raise ArgumentError, "Missing 'type' parameter in params" # TODO: replace the error in the error-handling overhaul PR
+      raise EasyPost::Errors::MISSING_REQUIRED_PARAMETER.new('type')
     end
 
     type = params.delete(:type)
@@ -26,7 +26,7 @@ class EasyPost::Services::Report < EasyPost::Services::Service
   # Retrieve all Report objects
   def all(params = {})
     unless params[:type]
-      raise ArgumentError, "Missing 'type' parameter in params" # TODO: replace the error in the error-handling overhaul PR
+      raise EasyPost::Errors::MISSING_REQUIRED_PARAMETER.new('type')
     end
 
     type = params.delete(:type)

data/lib/easypost/services/scan_form.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::ScanForm < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::ScanForm
+  MODEL_CLASS = EasyPost::Models::ScanForm # :nodoc:
 
   # Create a ScanForm.
   def create(params = {})

data/lib/easypost/services/shipment.rb

@@ -3,7 +3,7 @@
 require 'set'
 
 class EasyPost::Services::Shipment < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Shipment
+  MODEL_CLASS = EasyPost::Models::Shipment # :nodoc:
 
   # Create a Shipment.
   def create(params = {})

data/lib/easypost/services/tracker.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::Tracker < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Tracker
+  MODEL_CLASS = EasyPost::Models::Tracker # :nodoc:
 
   # Create a Tracker
   def create(params = {})
@@ -29,15 +29,6 @@ class EasyPost::Services::Tracker < EasyPost::Services::Service
     get_all_helper('trackers', MODEL_CLASS, params, filters)
   end
 
-  # Create multiple Tracker objects in bulk.
-  # <b>DEPRECATED:</b> Please use <tt>create</tt> instead. This function will be removed in a future release.
-  def create_list(params = {})
-    wrapped_params = { 'trackers' => params }
-
-    @client.make_request(:post, 'trackers/create_list', wrapped_params)
-    true # This endpoint does not return a response so we return true here instead
-  end
-
   # Get the next page of trackers.
   def get_next_page(collection, page_size = nil)
     raise EasyPost::Errors::EndOfPaginationError.new unless more_pages?(collection)

data/lib/easypost/services/user.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::User < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::User
+  MODEL_CLASS = EasyPost::Models::User # :nodoc:
 
   # Create a child User.
   def create(params = {})
@@ -39,42 +39,10 @@ class EasyPost::Services::User < EasyPost::Services::Service
     true
   end
 
-  # Retrieve a list of all ApiKey objects.
-  def all_api_keys
-    warn '[DEPRECATION] `all_api_keys` is deprecated. Please use `all` in the `api_key` service instead.'
-    response = @client.make_request(:get, 'api_keys')
-
-    EasyPost::InternalUtilities::Json.convert_json_to_object(response, EasyPost::Models::ApiKey)
-  end
-
-  # Retrieve a list of ApiKey objects (works for the authenticated user or a child user).
-  def api_keys(id)
-    warn '[DEPRECATION] `api_keys` is deprecated.
-Please use `retrieve_api_keys_for_user` in the `api_key` service instead.'
-
-    api_keys = all_api_keys
-
-    if api_keys.id == id
-      # This function was called on the authenticated user
-      my_api_keys = api_keys.keys
-    else
-      # This function was called on a child user (authenticated as parent, only return this child user's details).
-      my_api_keys = []
-      api_keys.children.each do |child|
-        if child.id == id
-          my_api_keys = child.keys
-          break
-        end
-      end
-    end
-
-    my_api_keys
-  end
-
   # Update the Brand of a User.
   def update_brand(id, params = {})
     wrapped_params = { brand: params }
-    response = @client.make_request(:get, "users/#{id}/brand", wrapped_params)
+    response = @client.make_request(:patch, "users/#{id}/brand", wrapped_params)
 
     EasyPost::InternalUtilities::Json.convert_json_to_object(response, EasyPost::Models::Brand)
   end
@@ -90,7 +58,7 @@ Please use `retrieve_api_keys_for_user` in the `api_key` service instead.'
   def get_next_page_of_children(collection, page_size = nil)
     raise EasyPost::Errors::EndOfPaginationError.new unless more_pages?(collection)
 
-    params = { before_id: collection.children.last.id }
+    params = { after_id: collection.children.last.id }
     params[:page_size] = page_size unless page_size.nil?
 
     all_children(params)

data/lib/easypost/services/webhook.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::Webhook < EasyPost::Services::Service
-  MODEL_CLASS = EasyPost::Models::Webhook
+  MODEL_CLASS = EasyPost::Models::Webhook # :nodoc:
 
   # Create a Webhook.
   def create(params = {})

metadata

@@ -1,15 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 7.0.0
 platform: ruby
 authors:
 - EasyPost Developers
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: abbrev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: brakeman
   requirement: !ruby/object:Gem::Requirement
@@ -30,98 +71,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.5
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.5
+        version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.5'
+        version: '6.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.5'
+        version: '6.12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.49'
+        version: '1.72'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.49'
+        version: '1.72'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '2.19'
+        version: '2.31'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '2.19'
+        version: '2.31'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -156,46 +197,45 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.3'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.18'
+        version: '3.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.18'
+        version: '3.25'
 description: Client library for accessing the EasyPost shipping API via Ruby.
 email: oss@easypost.com
-executables:
-- easypost-irb
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -205,6 +245,7 @@ files:
 - ".github/ISSUE_TEMPLATE/feature_request.yml"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".gitmodules"
 - CHANGELOG.md
@@ -212,10 +253,8 @@ files:
 - LICENSE
 - Makefile
 - README.md
-- Rakefile
 - UPGRADE_GUIDE.md
 - VERSION
-- bin/easypost-irb
 - easypost.gemspec
 - lib/easypost.rb
 - lib/easypost/client.rb
@@ -266,7 +305,6 @@ files:
 - lib/easypost/models/customs_info.rb
 - lib/easypost/models/customs_item.rb
 - lib/easypost/models/end_shipper.rb
-- lib/easypost/models/error.rb
 - lib/easypost/models/event.rb
 - lib/easypost/models/insurance.rb
 - lib/easypost/models/order.rb
@@ -326,7 +364,6 @@ homepage: https://www.easypost.com/docs
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -334,15 +371,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: EasyPost Ruby Client Library
 test_files: []

data/Rakefile

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'

data/bin/easypost-irb

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
-
-libs = ' -r irb/completion'
-libs << " -r #{"#{File.dirname(__FILE__)}/../lib/easypost"}"
-puts 'Initializing EasyPost...'
-exec "#{irb} #{libs} --simple-prompt"

data/lib/easypost/models/error.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-# EasyPost Error object.
-class EasyPost::Models::Error
-  attr_reader :code, :field, :message
-
-  # Initialize a new EasyPost Error
-  def initialize(code, field = nil, message = nil)
-    @code = code
-    @field = field
-    @message = message
-  end
-
-  # Create an EasyPost Error from an API error response.
-  def self.from_api_error_response(data)
-    code = data['code']
-    field = data['field'] || nil
-    message = data['message'] || nil
-    EasyPost::Models::Error.new(code, field, message)
-  end
-end