easypost 6.0.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d84472fd17512bf9f3c4a2a670a025e76154bbe93fffa5a8e9139309af4feac2
-  data.tar.gz: 4c7c6df535c2700e54751e878e239ba689be42faec299993a19993d6ceb2fc0f
+  metadata.gz: 643a95f0b48e9abedc30e67d868ec3538d8d896b9c385734966805c83e72bd90
+  data.tar.gz: a532de25388ea110f152e77205bea2104228e83e7279dc66d0b500238d5b8416
 SHA512:
-  metadata.gz: b7337d5099aa61da9c7bf21ce1c7d9fe9c6e9b9f011ab615949934e6e42b192785f87481cadfcbd1e244d682f323edbfd6a42e6df409b900749e92d83d474c63
-  data.tar.gz: fee3c31633179b4337ded644d83e61d4b7f776ac873954cf01b1f1c613044c8cdf46cd34b1f3a8a40333823050ff78eb0c432c6db1fe269adc113acc79efeae9
+  metadata.gz: 94b9cf67261d5c9bba01183812bef018d0b4918cc5f3593befdff2884095816299585bf33d86ee0de14015814c53ddd2911b9de85692c9c73421e1133cd57605
+  data.tar.gz: ba8c81ed037de3ccad7441eba06111eefb7430e69ac36169dd3409efa7965a092b18bc114d3767610dcb15453a6bfeed584073f35a986214b96f5eab4c6e2dcb

data/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rubyversion: ['2.6', '2.7', '3.0', '3.1', '3.2']
+        rubyversion: ['2.6', '2.7', '3.0', '3.1', '3.2', '3.3']
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
@@ -19,7 +19,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.rubyversion }}
-          rubygems: '3.0.0'
+          rubygems: '3.3.0'
           bundler-cache: true
       - name: Install Dependencies
         run: make install
@@ -39,8 +39,8 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.2'
-          rubygems: '3.0.0'
+          ruby-version: '3.3'
+          rubygems: '3.3.0'
           bundler-cache: true
       - name: Install Dependencies
         run: make install
@@ -57,8 +57,8 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.2'
-          rubygems: '3.0.0'
+          ruby-version: '3.3'
+          rubygems: '3.3.0'
           bundler-cache: true
       - name: Install Dependencies
         run: make install

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # CHANGELOG
 
+## v6.4.0 (2024-07-24)
+
+- Adds new `Claim` service for filing claims on EasyPost shipments and insurances
+
+## v6.3.0 (2024-07-12)
+
+- Adds new `shipment.recommend_ship_date`, `smartrate.recommend_ship_date`, and `smartrate.estimate_delivery_date` functions
+- Routes `UpsAccount`, `UpsMailInnovationsAccount`, and `UpsSurepostAccount` create/update requests to the new `/ups_oauth_registrations` endpoint
+  - Starting `2024-08-05`, UPS accounts will require a new payload to register or update. See [UPS OAuth 2.0 Update](https://support.easypost.com/hc/en-us/articles/26635027512717-UPS-OAuth-2-0-Update?utm_medium=email&_hsenc=p2ANqtz-96MmFtWICOzy9sKRbbcZSiMovZSrY3MSX1_bgY9N3f9yLVfWQdLhjAGq-SmNcOnDIS6GYhZ0OApjDBrGkKyLLMx1z6_TFOVp6-wllhEFQINrkuRuc&_hsmi=313130292&utm_content=313130292&utm_source=hs_email) for more details
+
+## v6.2.0 (2024-04-10)
+
+- Fix payment method funding and deletion failures due to undetermined payment method type
+- Add `refund` function in Insurance service for requesting a refund for standalone insurance.
+
+## v6.1.1 (2024-01-23)
+
+- Fix issues funding wallet due to invalid internal function call
+
+## v6.1.0 (2024-01-08)
+
+- Add `all_children` and `get_next_page_of_children` in `user` service
+
 ## v6.0.0 (2023-12-06)
 
 - 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

data/Makefile

@@ -24,8 +24,13 @@ docs:
 install-styleguide: | update-examples-submodule
 	sh examples/symlink_directory_files.sh examples/style_guides/ruby .
 
+## init-examples-submodule - Initialize the examples submodule
+init-examples-submodule:
+	git submodule init
+	git submodule update
+
 ## install - Install globally from source
-install: | update-examples-submodule
+install: | init-examples-submodule
 	bundle install
 
 ## lint - Lint the project
@@ -40,8 +45,9 @@ publish:
 
 ## release - Cuts a release for the project on GitHub (requires GitHub CLI)
 # tag = The associated tag title of the release
+# target = Target branch or full commit SHA
 release:
-	gh release create ${tag} dist/*
+	gh release create ${tag} dist/* --target ${target}
 
 ## rubocop - lints the project with rubocop
 rubocop:

data/README.md

@@ -163,7 +163,7 @@ If you're using a custom HTTP connection, keep in mind that the `response_data`
 
 ## Documentation
 
-API documentation can be found at: <https://easypost.com/docs/api>.
+API documentation can be found at: <https://docs.easypost.com>.
 
 Library documentation can be found on the web at: <https://easypost.github.io/easypost-ruby/> or by building them locally via the `make docs` command.
 

data/VERSION

@@ -1 +1 @@
-6.0.0
+6.4.0

data/easypost.gemspec

@@ -24,7 +24,6 @@ Gem::Specification.new do |spec|
   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 'psych', '~> 5.1'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rdoc', '~> 6.5'
   spec.add_development_dependency 'rspec', '~> 3.12'

data/lib/easypost/client.rb

@@ -42,6 +42,7 @@ class EasyPost::Client
     EasyPost::Services::CarrierAccount,
     EasyPost::Services::CarrierMetadata,
     EasyPost::Services::CarrierType,
+    EasyPost::Services::Claim,
     EasyPost::Services::CustomsInfo,
     EasyPost::Services::CustomsItem,
     EasyPost::Services::EndShipper,
@@ -56,6 +57,7 @@ class EasyPost::Client
     EasyPost::Services::Report,
     EasyPost::Services::ScanForm,
     EasyPost::Services::Shipment,
+    EasyPost::Services::SmartRate,
     EasyPost::Services::Tracker,
     EasyPost::Services::User,
     EasyPost::Services::Webhook,

data/lib/easypost/models/claim.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# The Claim object has all the details for the filed claims
+class EasyPost::Models::Claim < EasyPost::Models::EasyPostObject
+end

data/lib/easypost/models.rb

@@ -10,6 +10,7 @@ require_relative 'models/batch'
 require_relative 'models/brand'
 require_relative 'models/carrier_account'
 require_relative 'models/carrier_type'
+require_relative 'models/claim'
 require_relative 'models/customs_info'
 require_relative 'models/customs_item'
 require_relative 'models/end_shipper'

data/lib/easypost/services/base.rb

@@ -10,8 +10,11 @@ class EasyPost::Services::Service
 
   protected
 
-  def get_all_helper(endpoint, cls, params, filters = nil)
-    response = @client.make_request(:get, endpoint, params)
+  def get_all_helper(endpoint, cls, params, filters = nil, beta = false)
+    response = @client.make_request(
+      :get, endpoint, params,
+      beta ? 'beta' : EasyPost::InternalUtilities::Constants::API_VERSION,
+    )
 
     response[EasyPost::InternalUtilities::Constants::FILTERS_KEY] = filters unless filters.nil?
 

data/lib/easypost/services/billing.rb

@@ -3,43 +3,9 @@
 require 'easypost/constants'
 
 class EasyPost::Services::Billing < EasyPost::Services::Service
-  # Get payment method info (type of the payment method and ID of the payment method)
-  def self.get_payment_method_info(priority)
-    payment_methods = EasyPost::Services::Billing.retrieve_payment_methods
-    payment_method_map = {
-      'primary' => 'primary_payment_method',
-      'secondary' => 'secondary_payment_method',
-    }
-
-    payment_method_to_use = payment_method_map[priority]
-
-    error_string = EasyPost::Constants::INVALID_PAYMENT_METHOD
-    suggestion = "Please use a valid payment method: #{payment_method_map.keys.join(', ')}"
-    if payment_methods[payment_method_to_use].nil?
-      raise EasyPost::Errors::InvalidParameterError.new(
-        error_string,
-        suggestion,
-      )
-    end
-
-    payment_method_id = payment_methods[payment_method_to_use]['id']
-
-    unless payment_method_id.nil?
-      if payment_method_id.start_with?('card_')
-        endpoint = '/v2/credit_cards'
-      elsif payment_method_id.start_with?('bank_')
-        endpoint = '/v2/bank_accounts'
-      else
-        raise EasyPost::Errors::InvalidObjectError.new(error_string)
-      end
-    end
-
-    [endpoint, payment_method_id]
-  end
-
   # Fund your EasyPost wallet by charging your primary or secondary card on file.
   def fund_wallet(amount, priority = 'primary')
-    payment_info = EasyPost::Services::Billing.get_payment_method_info(priority.downcase)
+    payment_info = get_payment_method_info(priority.downcase)
     endpoint = payment_info[0]
     payment_id = payment_info[1]
 
@@ -52,7 +18,7 @@ class EasyPost::Services::Billing < EasyPost::Services::Service
 
   # Delete a payment method.
   def delete_payment_method(priority)
-    payment_info = EasyPost::Services::Billing.get_payment_method_info(priority.downcase)
+    payment_info = get_payment_method_info(priority.downcase)
     endpoint = payment_info[0]
     payment_id = payment_info[1]
 
@@ -64,7 +30,7 @@ class EasyPost::Services::Billing < EasyPost::Services::Service
 
   # Retrieve all payment methods.
   def retrieve_payment_methods
-    response = @client.make_request(:get, '/v2/payment_methods')
+    response = @client.make_request(:get, '/payment_methods')
     payment_methods = EasyPost::InternalUtilities::Json.convert_json_to_object(response)
 
     if payment_methods['id'].nil?
@@ -73,4 +39,40 @@ class EasyPost::Services::Billing < EasyPost::Services::Service
 
     payment_methods
   end
+
+  private
+
+  # Get payment method info (type of the payment method and ID of the payment method)
+  def get_payment_method_info(priority)
+    payment_methods = retrieve_payment_methods
+    payment_method_map = {
+      'primary' => 'primary_payment_method',
+      'secondary' => 'secondary_payment_method',
+    }
+
+    payment_method_to_use = payment_method_map[priority]
+
+    error_string = EasyPost::Constants::INVALID_PAYMENT_METHOD
+    suggestion = "Please use a valid payment method: #{payment_method_map.keys.join(', ')}"
+    if payment_methods[payment_method_to_use].nil?
+      raise EasyPost::Errors::InvalidParameterError.new(
+        error_string,
+        suggestion,
+      )
+    end
+
+    payment_method_id = payment_methods[payment_method_to_use]['id']
+    payment_method_object_type = payment_methods[payment_method_to_use]['object']
+
+    if payment_method_object_type == 'CreditCard'
+
+      endpoint = '/credit_cards'
+    elsif payment_method_object_type == 'BankAccount'
+      endpoint = '/bank_accounts'
+    else
+      raise EasyPost::Errors::InvalidObjectError.new(error_string)
+    end
+
+    [endpoint, payment_method_id]
+  end
 end

data/lib/easypost/services/carrier_account.rb

@@ -1,16 +1,20 @@
 # frozen_string_literal: true
 
 class EasyPost::Services::CarrierAccount < EasyPost::Services::Service
-  CUSTOM_WORKFLOW_CARRIER_TYPES = %w[UpsAccount FedexAccount FedexSmartpostAccount].freeze
+  CUSTOM_WORKFLOW_CARRIER_TYPES = %w[FedexAccount FedexSmartpostAccount].freeze
+  UPS_OAUTH_CARRIER_ACCOUNT_TYPES = %w[UpsAccount UpsMailInnovationsAccount UpsSurepostAccount].freeze
   MODEL_CLASS = EasyPost::Models::CarrierAccount
 
   # Create a carrier account
   def create(params = {})
-    wrapped_params = { carrier_account: params }
+    carrier_account_type = params[:type]
+    wrapped_params = { select_top_layer_key(carrier_account_type).to_sym => params }
 
     # For UPS and FedEx the endpoint is different
-    create_url = if CUSTOM_WORKFLOW_CARRIER_TYPES.include?(params[:type])
+    create_url = if CUSTOM_WORKFLOW_CARRIER_TYPES.include?(carrier_account_type)
                    'carrier_accounts/register'
+                 elsif UPS_OAUTH_CARRIER_ACCOUNT_TYPES.include?(carrier_account_type)
+                   'ups_oauth_registrations'
                  else
                    'carrier_accounts'
                  end
@@ -33,8 +37,14 @@ class EasyPost::Services::CarrierAccount < EasyPost::Services::Service
 
   # Update a carrier account
   def update(id, params = {})
-    wrapped_params = { carrier_account: params }
-    response = @client.make_request(:put, "carrier_accounts/#{id}", wrapped_params)
+    carrier_account = retrieve(id)
+    wrapped_params = { select_top_layer_key(carrier_account[:type]).to_sym => params }
+    update_url = if UPS_OAUTH_CARRIER_ACCOUNT_TYPES.include?(params[:type])
+                   'ups_oauth_registrations/'
+                 else
+                   'carrier_accounts/'
+                 end
+    response = @client.make_request(:put, "#{update_url}#{id}", wrapped_params)
 
     EasyPost::InternalUtilities::Json.convert_json_to_object(response, MODEL_CLASS)
   end
@@ -46,4 +56,15 @@ class EasyPost::Services::CarrierAccount < EasyPost::Services::Service
     # Return true if succeeds, an error will be thrown if it fails
     true
   end
+
+  private
+
+  # Select the top-layer key for the carrier account creation/update request based on the carrier type.
+  def select_top_layer_key(carrier_account_type)
+    if UPS_OAUTH_CARRIER_ACCOUNT_TYPES.include?(carrier_account_type)
+      'ups_oauth_registrations'
+    else
+      'carrier_account'
+    end
+  end
 end

data/lib/easypost/services/claim.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class EasyPost::Services::Claim < EasyPost::Services::Service
+  MODEL_CLASS = EasyPost::Models::Claim
+
+  # Create an Claim object
+  def create(params = {})
+    response = @client.make_request(:post, 'claims', params)
+
+    EasyPost::InternalUtilities::Json.convert_json_to_object(response, MODEL_CLASS)
+  end
+
+  # Retrieve an Claim object
+  def retrieve(id)
+    response = @client.make_request(:get, "claims/#{id}", nil)
+
+    EasyPost::InternalUtilities::Json.convert_json_to_object(response, MODEL_CLASS)
+  end
+
+  # Retrieve all Claim objects
+  def all(params = {})
+    filters = { key: 'claims' }
+
+    get_all_helper('claims', MODEL_CLASS, params, filters)
+  end
+
+  # Get the next page of claims.
+  def get_next_page(collection, page_size = nil)
+    raise EasyPost::Errors::EndOfPaginationError.new unless more_pages?(collection)
+
+    params = { before_id: collection.claims.last.id }
+    params[:page_size] = page_size unless page_size.nil?
+
+    all(params)
+  end
+
+  # Cancel a filed claim
+  def cancel(id)
+    response = @client.make_request(:post, "claims/#{id}/cancel", nil)
+
+    EasyPost::InternalUtilities::Json.convert_json_to_object(response, MODEL_CLASS)
+  end
+end

data/lib/easypost/services/insurance.rb

@@ -34,4 +34,11 @@ class EasyPost::Services::Insurance < EasyPost::Services::Service
 
     all(params)
   end
+
+  # Refund an Insurance object
+  def refund(id)
+    response = @client.make_request(:post, "insurances/#{id}/refund")
+
+    EasyPost::InternalUtilities::Json.convert_json_to_object(response, MODEL_CLASS)
+  end
 end

data/lib/easypost/services/shipment.rb

@@ -118,4 +118,13 @@ class EasyPost::Services::Shipment < EasyPost::Services::Service
 
     EasyPost::InternalUtilities::Json.convert_json_to_object(response, MODEL_CLASS).rates
   end
+
+  # Retrieve a recommended ship date for an existing Shipment via the Precision Shipping API, based on a specific desired delivery date.
+  def recommend_ship_date(id, desired_delivery_date)
+    url = "shipments/#{id}/smartrate/precision_shipping"
+    params = { desired_delivery_date: desired_delivery_date }
+    response = @client.make_request(:get, url, params)
+
+    EasyPost::InternalUtilities::Json.convert_json_to_object(response, MODEL_CLASS).rates
+  end
 end

data/lib/easypost/services/smart_rate.rb

@@ -0,0 +1,19 @@
+class EasyPost::Services::SmartRate < EasyPost::Services::Service
+  # Retrieve the estimated delivery date of each carrier-service level combination via the
+  # Smart Deliver By API, based on a specific ship date and origin-destination postal code pair.
+  def estimate_delivery_date(params = {})
+    url = 'smartrate/deliver_by'
+
+    response = @client.make_request(:post, url, params)
+    EasyPost::InternalUtilities::Json.convert_json_to_object(response, EasyPost::Models::EasyPostObject)
+  end
+
+  # Retrieve a recommended ship date for each carrier-service level combination via the
+  # Smart Deliver On API, based on a specific delivery date and origin-destination postal code pair.
+  def recommend_ship_date(params = {})
+    url = 'smartrate/deliver_on'
+
+    response = @client.make_request(:post, url, params)
+    EasyPost::InternalUtilities::Json.convert_json_to_object(response, EasyPost::Models::EasyPostObject)
+  end
+end

data/lib/easypost/services/tracker.rb

@@ -30,6 +30,7 @@ class EasyPost::Services::Tracker < EasyPost::Services::Service
   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 }
 

data/lib/easypost/services/user.rb

@@ -78,4 +78,21 @@ Please use `retrieve_api_keys_for_user` in the `api_key` service instead.'
 
     EasyPost::InternalUtilities::Json.convert_json_to_object(response, EasyPost::Models::Brand)
   end
+
+  # Retrieve all child Users.
+  def all_children(params = {})
+    filters = { key: 'children' }
+
+    get_all_helper('users/children', EasyPost::Models::User, params, filters)
+  end
+
+  # Get the next page of child users.
+  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[:page_size] = page_size unless page_size.nil?
+
+    all_children(params)
+  end
 end

data/lib/easypost/services.rb

@@ -14,6 +14,7 @@ require_relative 'services/billing'
 require_relative 'services/carrier_account'
 require_relative 'services/carrier_metadata'
 require_relative 'services/carrier_type'
+require_relative 'services/claim'
 require_relative 'services/customs_info'
 require_relative 'services/customs_item'
 require_relative 'services/end_shipper'
@@ -28,6 +29,7 @@ require_relative 'services/refund'
 require_relative 'services/report'
 require_relative 'services/scan_form'
 require_relative 'services/shipment'
+require_relative 'services/smart_rate'
 require_relative 'services/tracker'
 require_relative 'services/user'
 require_relative 'services/webhook'

data/lib/easypost/utilities/static_mapper.rb

@@ -11,6 +11,7 @@ module EasyPost::InternalUtilities::StaticMapper
     'brd' => EasyPost::Models::Brand,
     'ca' => EasyPost::Models::CarrierAccount,
     'card' => EasyPost::Models::PaymentMethod,
+    'clm' => EasyPost::Models::Claim,
     'cstinfo' => EasyPost::Models::CustomsInfo,
     'cstitem' => EasyPost::Models::CustomsItem,
     'es' => EasyPost::Models::EndShipper,
@@ -43,6 +44,7 @@ module EasyPost::InternalUtilities::StaticMapper
     'Batch' => EasyPost::Models::Batch,
     'Brand' => EasyPost::Models::Brand,
     'CarrierAccount' => EasyPost::Models::CarrierAccount,
+    'Claim' => EasyPost::Models::Claim,
     'CreditCard' => EasyPost::Models::PaymentMethod,
     'CustomsInfo' => EasyPost::Models::CustomsInfo,
     'CustomsItem' => EasyPost::Models::CustomsItem,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.4.0
 platform: ruby
 authors:
 - EasyPost Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: psych
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -276,6 +262,7 @@ files:
 - lib/easypost/models/brand.rb
 - lib/easypost/models/carrier_account.rb
 - lib/easypost/models/carrier_type.rb
+- lib/easypost/models/claim.rb
 - lib/easypost/models/customs_info.rb
 - lib/easypost/models/customs_item.rb
 - lib/easypost/models/end_shipper.rb
@@ -310,6 +297,7 @@ files:
 - lib/easypost/services/carrier_account.rb
 - lib/easypost/services/carrier_metadata.rb
 - lib/easypost/services/carrier_type.rb
+- lib/easypost/services/claim.rb
 - lib/easypost/services/customs_info.rb
 - lib/easypost/services/customs_item.rb
 - lib/easypost/services/end_shipper.rb
@@ -324,6 +312,7 @@ files:
 - lib/easypost/services/report.rb
 - lib/easypost/services/scan_form.rb
 - lib/easypost/services/shipment.rb
+- lib/easypost/services/smart_rate.rb
 - lib/easypost/services/tracker.rb
 - lib/easypost/services/user.rb
 - lib/easypost/services/webhook.rb
@@ -352,7 +341,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: EasyPost Ruby Client Library