amazon-pay-api-sdk-ruby 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 439cdb07dc4f4d22baaf1d26710a1163cfedd565a6d56a5d0e61b0afdcc2c981
-  data.tar.gz: 358f1dfb78f49d1270dc4a457e5664959a40aae6dec6db51476ec6e57e926853
+  metadata.gz: ec55f9f54ca4cd12db49f81319d1315c7f45a6cf523ae924bb2596665395f839
+  data.tar.gz: c3b68bae12b5784f0535fe51f5b8e1d09a31c52eb3e5d8eb5b78b443b534a975
 SHA512:
-  metadata.gz: 2e14bc560974f5c2dd0078f8b676bc9b41d7c0a02da6e9cce9fb6f2837f16ed2007261f307fffe2e5ec022813d5f8884a6783d49bbb300059717349afce8f488
-  data.tar.gz: 6181e925f7943ec0d8d89b9af328c0a89433b6ecadc897ac07d10451dd75f58fc17ef3843f4b853385e531d8581da7474496bf9199b970c8cac08a223b134133
+  metadata.gz: 46934a830919a7de8bd646a11f34dbd61dd68a808a50816cb4d976c628104cb1c25376480686324d751bc4bd465d65cd3a3b0b888e1db73c9d2df70446ef1a7b
+  data.tar.gz: f8ac26c439661578e5fc8356922d8c30fdc80ec470f9a2bd013d91c2a55ac2f6819db2ace82ed9128e2d9aba92248908eb1e8e7fec1dc15624b53941c083fc11

data/README.md

@@ -775,6 +775,7 @@ end
 ```
 
 ### Create Dispute API
+#### NOTE: This API is intended to be called only by PSPs (Payment Service Providers).
 
 ```ruby
 creation_timestamp = Time.now.to_i
@@ -812,6 +813,19 @@ else
 end
 ```
 
+### Get Dispute API
+```ruby
+response = client.get_dispute('S03-XXXXXX-XXXXXX-XXXXXX')
+if response.code.to_i == 200
+    puts "Get Dispute API Response:"
+    puts response.body
+else
+    puts "Error: Get Dispute API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
 ### Update Dispute API 
 
 ```ruby

data/lib/amazon-pay-api-sdk-ruby/constants.rb

@@ -2,7 +2,7 @@ require 'net/http'
 
 module Constants
     SDK_TYPE = "amazon-pay-api-sdk-ruby".freeze
-    SDK_VERSION = "2.0.0".freeze
+    SDK_VERSION = "2.1.0".freeze
     API_VERSION = "v2".freeze
     API_ENDPOINTS = {
       'na' => 'pay-api.amazon.com',
@@ -38,7 +38,7 @@ module Constants
     DELETE = 'DELETE'.freeze
     MAX_RETRIES = 3.freeze
     BACKOFF_TIMES = [1, 2, 4].freeze # Define backoff times for retries
-    RETRYABLE_ERROR_CODES = [408, 429, 500, 502, 503, 504].freeze
+    RETRYABLE_ERROR_CODES = [408, 425, 429, 500, 502, 503, 504].freeze
     HTTP_OK = '200'
     HTTP_SERVER_ERROR = '500'
     BUYERS_URL = 'buyers'.freeze
@@ -92,6 +92,10 @@ module Constants
       CANCELLATION_POLICY: "CancellationPolicy",
       CUSTOMER_SIGNATURE: "CustomerSignature",
       TRACKING_NUMBER: "TrackingNumber",
+      CARRIER_NAME: "CarrierName",
+      DEVICE_ID: "DeviceId",
+      DEVICE_NAME: "DeviceName",
+      DOWNLOAD_DATE_TIME: "DownloadDateTime",
       OTHER: "Other"
     }.freeze
 end

data/lib/amazon-pay-api-sdk-ruby/payment_service_provider_client.rb

@@ -1,8 +1,8 @@
 module PaymentServiceProviderClient
     # API to create dispute. 
     # The createDispute operation is used to notify Amazon of a newly created chargeback dispute by a buyer on a
-    # transaction processed by the PSP (Payment Service Provider), ensuring the dispute is properly accounted for in the Amazon Pay systems.
-    # @see https://developer.amazon.com/docs/amazon-pay-apis/dispute.html/#create-dispute
+    # transaction processed only by the PSP (Payment Service Provider), ensuring the dispute is properly accounted for in the Amazon Pay systems.
+    # NOTE: This API is intended to be called only by PSPs (Payment Service Providers).
     # @param {Object} payload - The payload containing statusDetails.
     # @param {Object} headers - Requires : x-amz-pay-idempotency-key, Optional headers for the request, such as authorization tokens or custom headers.
     # @return [HTTPResponse] The response from the API call, which includes details of the dispute.
@@ -10,10 +10,17 @@ module PaymentServiceProviderClient
         api_call(Constants::DISPUTE_URLS, Constants::POST, payload: payload, headers: headers)
     end
 
+    # API to get dispute. 
+    # The getDispute operation is used to retrieve details of a chargeback dispute associated with a specific order
+    # @param {Object} headers - Optional headers for the request, such as x-amz-pay-idempotency-key, authorization tokens or custom headers.
+    # @return [HTTPResponse] The response from the API call, which includes details of the dispute.
+    def get_dispute(dispute_id, headers: {});    
+        api_call("#{Constants::DISPUTE_URLS}/#{dispute_id}", Constants::GET, headers: headers)
+    end
+
     # API to update dispute. 
     # The updateDispute operation is used to notify Amazon of the closure status of a chargeback dispute initiated by a
-    # buyer for orders processed by a partner PSP (Payment Service Provider), ensuring proper accounting within the Amazon systems.
-    # @see https://developer.amazon.com/docs/amazon-pay-apis/dispute.html/#update-dispute
+    # buyer for orders, ensuring proper accounting within the Amazon systems.
     # @param {String} dispute_id - The unique ID of the dispute to retrieve.
     # @param {Object} payload - The payload containing statusDetails.
     # @param {Object} headers - Optional headers for the request, such as x-amz-pay-idempotency-key, authorization tokens or custom headers.
@@ -26,7 +33,6 @@ module PaymentServiceProviderClient
     # The contestDispute operation is used by the partner, on behalf of the merchant, to formally contest a dispute
     # managed by Amazon, requiring the submission of necessary evidence files within the specified
     # Dispute Window (11 days for Chargeback, 7 days for A-Z Claims).
-    # @see https://developer.amazon.com/docs/amazon-pay-apis/dispute.html/#contest-dispute
     # @param {String} dispute_id - The unique ID of the dispute to retrieve.
     # @param {Object} payload - The payload containing statusDetails.
     # @param {Object} headers - Optional headers for the request, such as x-amz-pay-idempotency-key, authorization tokens or custom headers.
@@ -36,10 +42,9 @@ module PaymentServiceProviderClient
     end
 
     # API to upload file.
-    # The uploadFile operation is utilised by PSPs (Payment Service Provider) to upload file-based evidence when a
+    # The uploadFile operation is utilised to upload file-based evidence when a
     # merchant contests a dispute, providing the necessary reference ID to the evidence file as part of
     # the Update Dispute API process.
-    # @see https://developer.amazon.com/docs/amazon-pay-apis/file.html#upload-a-file
     # @param {Object} headers - Requires : x-amz-pay-idempotency-key, Optional headers for the request, such as authorization tokens or custom headers.
     # @return [HTTPResponse] The response from the API call, which includes details of the file.
     def upload_file(payload, headers: {});    

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amazon-pay-api-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - AmazonPay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 2025-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64