Add claims API functions (#308)

* Add claims API functions

* Switch to GA

* rename variable

Author: jchen293

CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Next Release
+
+- 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

examples

@@ -42,6 +42,7 @@ def initialize(api_key:, read_timeout: 60, open_timeout: 30, api_base: 'https://
     EasyPost::Services::CarrierAccount,
     EasyPost::Services::CarrierMetadata,
     EasyPost::Services::CarrierType,
+    EasyPost::Services::Claim,
     EasyPost::Services::CustomsInfo,
     EasyPost::Services::CustomsItem,
     EasyPost::Services::EndShipper,

lib/easypost/client.rb

@@ -10,6 +10,7 @@ module EasyPost::Models
 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'

lib/easypost/models.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

lib/easypost/models/claim.rb

@@ -14,6 +14,7 @@ module EasyPost::Services
 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'

lib/easypost/services.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

lib/easypost/services/claim.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,