amazon-pay-api-sdk-ruby 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be95e6a94ffd92f2b63c434fae57106167e710b78e37ec2ee769055400498153
-  data.tar.gz: b37aec741850a99fb89cc241f396da9fe49e0de47f910232101ba32c8c8bafb0
+  metadata.gz: 428da5a80e49d6cf400205eea58757174f259abce2bb6cc7a83aecd0c1554f5f
+  data.tar.gz: b809960b865a226d7796e506d1712759c0db90119cd886942b5aa9d6ed125681
 SHA512:
-  metadata.gz: 82928d3a73a42da02eb620166c86056402773fd700ff6d0e717d0610ff25ef02f1c84ef9bf4cd4288b70df489d0333b30297cee3b40bfbcdb34e3a3a057816b9
-  data.tar.gz: 575aa9e43e074704128e085ac94d2dc3063d2dc4add84eebb5ea9d860c051fea17c1fe139b2339ceca0f2028a2ecd1e0cc8fb7fd48bf47d547a12d1f8a8b457e
+  metadata.gz: 70c5fb962cf91183aca482ad024752e41a11e398cc666bc87aae026cfbef0efa813b0e36d3b5352f184638efe633f6811927db2a29607b115e59fb1af05836a4
+  data.tar.gz: 4f62e310db2e153b5c3110a36498e66a81f0f99d9bed70de7c8722feb1c076392b510233df447f37663e23634a5d567b118806beadc01749947de3817efda2df

data/README.md

@@ -86,35 +86,17 @@ createMerchantAccountPayload = {
             }
         }
     },
-    "beneficiaryOwners": [
-        {
-            "personId": "BO1",
-            "personFullName": "ABC ABC",
+     "beneficiaryOwners": [{
+            "personFullName": "Rufus Rufus",
             "residentialAddress": {
-                "addressLine1": "122, ABC XYZ",
-                "addressLine2": "XYZ",
-                "city": "XYZ",
-                "stateOrRegion": "XYZ",
-                "postalCode": "123456",
+                "addressLine1": "4-7, Sunny Mansion 203",
+                "addressLine2": "Boren Ave",
+                "city": "Chiryushi",
+                "stateOrRegion": "AICHI",
+                "postalCode": "4720021",
                 "countryCode": "JP",
                 "phoneNumber": {
-                    "countryCode": "123",
-                    "number": "2062062061"
-                }
-            }
-        },
-        {
-            "personId": "BO2",
-            "personFullName": "ABC ABC",
-            "residentialAddress": {
-                "addressLine1": "122, ABC XYZ",
-                "addressLine2": "XYZ",
-                "city": "XYZ",
-                "stateOrRegion": "XYZ",
-                "postalCode": "123456",
-                "countryCode": "JP",
-                "phoneNumber": {
-                    "countryCode": "123",
+                    "countryCode": "81",
                     "number": "2062062061"
                 }
             }
@@ -135,7 +117,7 @@ createMerchantAccountPayload = {
         "storeName": "ABC ABC",
         "privacyPolicyUrl": "http://www.abc.com/privacy",
         "storeStatus": {
-            "state": "Active",
+            "state": "ACTIVE",
             "reasonCode": nil
         }
     },
@@ -146,11 +128,7 @@ createMerchantAccountPayload = {
     }
 }
 
-createMerchantAccountHeader = {
-    "x-amz-pay-Idempotency-Key": "idempotency-key"
-}
-
-response = client.create_merchant_account(createMerchantAccountPayload, headers: createMerchantAccountHeader)
+response = client.create_merchant_account(createMerchantAccountPayload, headers: {})
 if response.code.to_i == 201 || response.code.to_i == 200
     puts "Create Merchant Account API Response:"
     puts response.body
@@ -183,7 +161,9 @@ updateMerchantAccountPayload = {
     }
 }
 
-updateMerchantAccountHeader = {}
+updateMerchantAccountHeader = {
+    "x-amz-pay-authToken" : "AUTH_TOKEN"
+}
 
 response = client.update_merchant_account('XXXXXXXXX', updateMerchantAccountPayload, headers: updateMerchantAccountHeader)
 if response.code.to_i == 200
@@ -207,12 +187,561 @@ merchantAccountClaimPayload = {
 }
 
 response = client.merchant_account_claim('XXXXXXXXX', merchantAccountClaimPayload, headers: {})
-if response.code.to_i == 303
+if response.code.to_i == 303 || response.code.to_i == 200
     puts "Merchant Account Claim API Response:"
     puts response.body
+    puts "Headers:"
+    puts response.to_hash.to_json
 else
     puts "Error: Merchant Account Claim API"
     puts "Status: #{response.code}"
     puts response.body
 end
+```
+
+### Generate Button Signature
+
+```ruby
+def button_payload = {
+    "webCheckoutDetails": {
+        "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
+    },
+    "storeId": "amzn1.application-oa2-client.xxxxxxxxxxxx",
+    "scopes": ["name", "email", "phoneNumber", "billingAddress"],
+    "deliverySpecifications": {
+        "specialRestrictions": ["RestrictPOBoxes"],
+        "addressRestrictions": {
+            "type": "Allowed",
+            "restrictions": {
+                "US": {
+                    "statesOrRegions": ["WA"],
+                    "zipCodes": ["95050", "93405"]
+                },
+                "GB": {
+                    "zipCodes": ["72046", "72047"]
+                },
+                "IN": {
+                    "statesOrRegions": ["AP"]
+                },
+                "JP": {}
+            }
+        }
+    }
+}  
+
+response = client.generate_button_signature(button_payload)
+puts "Button Signature:"
+puts response
+```
+
+### Get Buyer
+
+```ruby
+response = client.get_buyer('BUYER_TOKEN', headers: {})
+if response.code.to_i == 200
+    puts "Get Buyer API Response:"
+    puts response.body
+else
+    puts "Error: Get Buyer API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Create Checkout Session
+
+```ruby
+require 'securerandom'
+
+def createCheckoutSessionPayload = {
+    "webCheckoutDetails": {
+        "checkoutReviewReturnUrl": "https://a.com/merchant-review-page"
+    },
+    "storeId": "amzn1.application-oa2-client.xxxxxxxxxxxxx",
+    "scopes": ["name", "email", "phoneNumber", "billingAddress"],
+    "deliverySpecifications": {
+        "specialRestrictions": ["RestrictPOBoxes"],
+        "addressRestrictions": {
+            "type": "Allowed",
+            "restrictions": {
+                "US": {
+                    "statesOrRegions": ["WA"],
+                    "zipCodes": ["95050", "93405"]
+                },
+                "GB": {
+                    "zipCodes": ["72046", "72047"]
+                },
+                "IN": {
+                    "statesOrRegions": ["AP"]
+                },
+                "JP": {}
+            }
+        }
+    }
+}
+
+def create_checkout_session_header = {
+    "x-amz-pay-Idempotency-Key": SecureRandom.uuid
+}
+
+response = client.create_checkout_session(createCheckoutSessionPayload, headers: create_checkout_session_header)
+if response.code.to_i == 201 || response.code.to_i == 200
+    puts "Create Checkout Session API Response:"
+    puts response.body
+else
+    puts "Error: Create Checkout Session API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Get Checkout Session
+
+```ruby
+response = client.get_checkout_session("checkout_session_id", headers: {})
+if response.code.to_i == 200
+    puts "Get Checkout Session API Response:"
+    puts response.body
+else
+    puts "Error: Get Checkout Session API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Update Checkout Session
+
+```ruby
+def update_checkout_session_payload = {
+    "paymentDetails": {
+        "paymentIntent": "AuthorizeWithCapture",
+        "canHandlePendingAuthorization":false,
+        "softDescriptor": "Descriptor",
+        "chargeAmount": {
+            "amount": "1",
+            "currencyCode": "USD"
+        }
+     },
+    "merchantMetadata": {
+        "merchantReferenceId": "Merchant reference ID",
+        "merchantStoreName": "Merchant store name",
+        "noteToBuyer": "Note to buyer",
+        "customInformation": "Custom information"
+    }
+}
+
+response = client.update_checkout_session("checkout_session_id", update_checkout_session_payload, headers: {})
+if response.code.to_i == 200
+    puts "Update Checkout Session API Response:"
+    puts response.body
+else
+    puts "Error: Update Checkout Session API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Complete Checkout Session
+
+```ruby
+def complete_checkout_session_payload = {
+    "chargeAmount": {
+        "amount": "10.00",
+        "currencyCode": "USD"
+    }
+}
+
+response = client.complete_checkout_session("checkout_session_id", complete_checkout_session_payload, headers: {})
+if response.code.to_i == 200
+    puts "Complete Checkout Session API Response:"
+    puts response.body
+else
+    puts "Error: Complete Checkout Session API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Finalize Checkout Session
+
+```ruby
+def finalize_checkout_session_payload = {
+    "shippingAddress": {
+        "name": "Susy S",
+        "addressLine1": "11 Ditka Ave",
+        "addressLine2": "Suite 2500",
+        "city": "Chicago",
+        "county": nil,
+        "district": nil,
+        "stateOrRegion": "IL",
+        "postalCode": "60602",
+        "countryCode": "US",
+        "phoneNumber": "800-000-0000"
+    },
+    "billingAddress": {
+        "name": "Susy S",
+        "addressLine1": "11 Ditka Ave",
+        "addressLine2": "Suite 2500",
+        "city": "Chicago",
+        "county": null,
+        "district": null,
+        "stateOrRegion": "IL",
+        "postalCode": "60602",
+        "countryCode": "US",
+        "phoneNumber": "800-000-0000"
+    },
+    "chargeAmount": {
+        "amount": "10",
+        "currencyCode": "USD"
+    },
+    "paymentIntent": "Confirm"
+}
+
+response = client.finalize_checkout_session("checkout_session_id", finalize_checkout_session_payload, headers: {})
+if response.code.to_i == 200 || response.code.to_i == 202
+    puts "Finalize Checkout Session API Response:"
+    puts response.body
+else
+    puts "Error: Finalize Checkout Session API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Get Charge Permission
+
+```ruby
+response = client.get_charge_permission("charge_permission_id", headers: {})
+if response.code.to_i == 200
+    puts "Get Charge Permission API Response:"
+    puts response.body
+else
+    puts "Error: Get Charge Permission API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Update Charge Permission
+
+```ruby
+def update_charge_permission_payload = {
+    "merchantMetadata": {
+        "merchantReferenceId": "32-41-323141-32",
+        "merchantStoreName": "ShangameshestStoreFront",
+        "noteToBuyer": "Some Note to buyer",
+        "customInformation": ""    
+     }  
+}
+
+response = client.update_charge_permission("charge_permission_id", update_charge_permission_payload, headers: {})
+if response.code.to_i == 200
+    puts "Update Charge Permission API Response:"
+    puts response.body
+else
+    puts "Error: Update Charge Permission API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Close Charge Permission
+
+```ruby
+def close_charge_permission = {
+    "closureReason": "No more charges required for Store",
+    "cancelPendingCharges": false
+}
+
+response = client.close_charge_permission("charge_permission_id", close_charge_permission, headers: {})
+if response.code.to_i == 200
+    puts "Close Charge Permission API Response:"
+    puts response.body
+else
+    puts "Error: Close Charge Permission API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Create Charge
+
+```ruby
+require 'securerandom'
+
+def create_charge_payload = {
+    "chargePermissionId": "S01-XXXXXX-XXXXXX",
+    "chargeAmount": {
+        "amount": "10.00",
+        "currencyCode": "USD"
+    },
+    "captureNow": true, 
+    "softDescriptor": "Descriptor",
+    "canHandlePendingAuthorization": false 
+}
+
+def create_charge_header = {
+    "x-amz-pay-Idempotency-Key": SecureRandom.uuid
+}
+
+response = client.create_charge(create_charge_payload, headers: create_charge_header)
+if response.code.to_i == 201 || response.code.to_i == 200
+    puts "Create Charge Response:"
+    puts response.body
+else
+    puts "Error: Create Charge API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Get Charge
+
+```ruby
+response = client.get_charge('S01-XXXXXX-XXXXXX-XXXXXX', headers: {})
+if response.code.to_i == 200
+    puts "Get Charge Response:"
+    puts response.body
+else
+    puts "Error: Get Charge API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Capture Charge
+
+```ruby
+require 'securerandom'
+
+def capture_charge_payload = {
+    "captureAmount": {
+        "amount": "1.00",
+        "currencyCode": "USD"
+    },
+    "softDescriptor": "Descriptor"
+}
+
+def capture_charge_header = {
+    "x-amz-pay-Idempotency-Key": SecureRandom.uuid
+}
+
+response = client.capture_charge('S01-XXXXXX-XXXXXX-XXXXXX', capture_charge_payload, headers: capture_charge_header)
+if response.code.to_i == 200
+    puts "Capture Charge Response:"
+    puts response.body
+else
+    puts "Error: Capture Charge API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Cancel Charge
+
+```ruby
+def cancel_charge_payload = {
+    "cancellationReason": "Charge Cancellation Reason"
+}
+
+response = client.cancel_charge('S01-XXXXXX-XXXXXX-XXXXXX', cancel_charge_payload, headers: {})
+if response.code.to_i == 200
+    puts "Cancel Charge Response:"
+    puts response.body
+else
+    puts "Error: Cancel Charge API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Create Refund
+
+```ruby
+def create_refund_payload = {
+    "chargeId": "S01-XXXXXX-XXXXXX-XXXXXX",
+    "refundAmount": {
+        "amount": "1.00",
+        "currencyCode": "USD"
+    },
+    "softDescriptor": "Descriptor"
+}
+
+def create_refund_header = {
+    "x-amz-pay-Idempotency-Key": SecureRandom.uuid
+}
+
+response = client.create_refund(create_refund_payload, headers: create_refund_header)
+if response.code.to_i == 201 || response.code.to_i == 200
+    puts "Create Refund Response:"
+    puts response.body
+else
+    puts "Error: Create Refund API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Get Refund
+
+```ruby
+response = client.get_refund('S01-XXXXXX-XXXXXX-XXXXXX', headers: {})
+if response.code.to_i == 200
+    puts "Get Refund Response:"
+    puts response.body
+else
+    puts "Error: Get Refund API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Get Reports
+
+```ruby
+response = client.get_reports(query_params: {})
+if response.code.to_i == 200
+    puts "Get Reports Response:"
+    puts response.body
+else
+    puts "Error: Get Reports API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Get Report By Id
+
+```ruby
+def report_id = "123456789"
+response = client.get_report_by_id(report_id, headers: {})
+if response.code.to_i == 200
+    puts "Get Report By Id Response:"
+    puts response.body
+else
+    puts "Error: Get Report By Id API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Create Report
+
+```ruby
+def create_report_payload = {
+    "reportType": "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SANDBOX_SETTLEMENT_DATA_",
+    "startTime": "20240810T000000Z",
+    "endTime": "20240815T000000Z"
+}
+response = client.create_report(create_report_payload, headers: {"x-amz-pay-Idempotency-Key": SecureRandom.uuid})
+if response.code.to_i == 201
+    puts "Create Report Response:"
+    puts response.body
+else
+    puts "Error: Create Report API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Get Report Document
+
+
+```ruby
+def report_document_id = "123456789"
+response = client.get_report_document(report_document_id, headers: {})
+if response.code.to_i == 200
+    puts "Get Report Document Response:"
+    puts response.body
+else
+    puts "Error: Get Report Document API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Get Report Schedules
+
+```ruby
+def query_params = {
+    "reportType": "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SANDBOX_SETTLEMENT_DATA_",
+}
+response = client.get_report_schedules(query_params: query_params, headers: {})
+if response.code.to_i == 200
+    puts "Get Report Schedules Response:"
+    puts response.body
+else
+    puts "Error: Get Report Schedules API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Get Report Schedule By ID
+
+```ruby
+def report_schedule_id = "123456789"
+response = client.get_report_schedule_by_id(report_schedule_id, headers: {})
+if response.code.to_i == 200
+    puts "Get Report Schedule By ID Response:"
+    puts response.body
+else
+    puts "Error: Get Report Schedule By ID API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Create Report Schedule
+
+```ruby
+def create_report_schdule_payload = {
+    "reportType": "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SANDBOX_SETTLEMENT_DATA_",
+    "scheduleFrequency": "P1D",
+    "nextReportCreationTime": "20241001T000000Z"
+}
+response = client.create_report_schedule(create_report_schdule_payload, headers: {"x-amz-pay-Idempotency-Key": SecureRandom.uuid}, query_params: {})
+if response.code.to_i == 201
+    puts "Create Report Schedule Response:"
+    puts response.body
+else
+    puts "Error: Create Report Schedule API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+#### Cancel Report Schedule
+
+```ruby
+def report_schedule_id = "123456789"
+response = client.cancel_report_schedule(report_schedule_id, headers: {})
+if response.code.to_i == 200
+    puts "Cancel Report Schedule Schedule Response:"
+    puts response.body
+else
+    puts "Error: Cancel Report Schedule Schedule API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
+```
+
+### Get Disbursements
+
+```ruby
+def query_params = {
+    "startTime": '20240810T000000Z',
+    "endTime": '20240815T000000Z'
+    "pageSize": "30",
+    "nextToken": ""
+}
+response = client.get_disbursements(query_params: {}, headers: {})
+if response.code.to_i == 200
+    puts "Get Disbursements Response:"
+    puts response.body
+else
+    puts "Error: Get Disbursements API"
+    puts "Status: #{response.code}"
+    puts response.body
+end
 ```

data/lib/amazon_pay/client.rb

@@ -47,7 +47,6 @@ class AmazonPayClient
 
         # Increment the retry counter
         retries += 1
-        print "Retrying\n"
         # Raise an exception to force a retry
         raise "Transient error: #{response.code}" # Force retry
       end
@@ -99,4 +98,260 @@ class AmazonPayClient
   def merchant_account_claim(merchant_account_id, payload, headers: {})
     api_call("#{Constants::MERCHANT_ACCOUNTS_BASE_URL}/#{merchant_account_id}/claim", Constants::POST, payload: payload, headers: headers)
   end
+
+  # Generates a signature for the given payload
+  # This method is used to generate a signature for an Amazon Pay button payload.
+  # The payload can be provided as either a String or a Hash. If a Hash is provided, it is converted to a JSON string before signing.
+  # @param {Object|String} payload - The payload to be signed, which can be a JSON string or a Hash.
+  # @return {String} The signature for the provided payload.
+  def generate_button_signature(payload)
+    @helper.sign(payload.is_a?(String) ? payload : JSON.generate(payload))
+  end
+
+  # API to retrieve Buyer information
+  # Fetches details of a Buyer using the buyer token provided.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/buyer.html#get-buyer
+  # @param {String} buyer_token - The unique token associated with the Buyer.
+  # @param {Object} headers - Optional headers for the request, such as authorization tokens or custom headers.
+  # @return [HTTPResponse] The response from the API call, which includes the details of the Buyer, such as name, email, and address.
+  def get_buyer(buyer_token, headers: {})
+    api_call("#{Constants::BUYERS_URL}/#{buyer_token}", Constants::GET, headers: headers)
+  end
+
+  # API to create a CheckoutSession object
+  # Creates a new CheckoutSession object.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/checkout-session.html#create-checkout-session
+  # @param {Object} payload - The payload for the request. This should include all the required fields such as chargeAmount, currencyCode, etc.
+  # @param {Object} headers - Optional headers for the request, such as authorization tokens or custom headers.
+  # @return [HTTPResponse] The response from the API call, which includes the details of the newly created CheckoutSession.
+  def create_checkout_session(payload, headers: {})
+    api_call(Constants::CHECKOUT_SESSION_URL, Constants::POST, payload: payload, headers: headers)
+  end
+
+  # API to get a CheckoutSession object
+  # Retrieves details of a previously created CheckoutSession object.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/checkout-session.html#get-checkout-session
+  # @param {String} checkout_session_id - The unique identifier for the CheckoutSession.
+  # @param {Object} headers - Optional headers for the request.
+  # @return [HTTPResponse] The response from the API call, which includes the details of the CheckoutSession object.{Object} [headers=null] - The headers for the request
+  def get_checkout_session(checkout_session_id, headers: {})
+    api_call("#{Constants::CHECKOUT_SESSION_URL}/#{checkout_session_id}", Constants::GET, headers: headers)
+  end
+
+  # API to update a CheckoutSession object
+  # Updates a previously created CheckoutSession object with new information.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/checkout-session.html#update-checkout-session
+  # @param {String} checkout_session_id - The unique identifier for the CheckoutSession.
+  # @param {Object} payload - The payload for the request. This should include the fields that need to be updated.
+  # @param {Object} headers - Optional headers for the request.
+  # @return [HTTPResponse] The response from the API call, which includes the updated details of the CheckoutSession.
+  def update_checkout_session(checkout_session_id, payload, headers: {})
+    api_call("#{Constants::CHECKOUT_SESSION_URL}/#{checkout_session_id}", Constants::PATCH, payload: payload, headers: headers)
+  end
+
+  # API to complete a Checkout Session
+  # Confirms the completion of buyer checkout.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/checkout-session.html#complete-checkout-session
+  # @param {String} checkout_session_id - The unique identifier for the CheckoutSession.
+  # @param {Object} payload - The payload for the request, typically including fields like chargeAmount, currencyCode, etc.
+  # @param {Object} headers - Optional headers for the request.
+  # @return [HTTPResponse] The response from the API call, which confirms the completion of the checkout process.
+  def complete_checkout_session(checkout_session_id, payload, headers: {})
+    api_call("#{Constants::CHECKOUT_SESSION_URL}/#{checkout_session_id}/complete", Constants::POST, payload: payload, headers: headers)
+  end
+
+  # API to finalize a Checkout Session
+  # Finalizes the checkout process by confirming the payment and completing the session.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/checkout-session.html#finalize-checkout-session
+  # @param {String} checkout_session_id - The unique ID of the checkout session that needs to be finalized.
+  # @param {Object} payload - The payload for the request, typically including payment confirmation details.
+  # @param {Object} headers - Optional headers for the request, such as authorization tokens or custom headers.
+  # @return [HTTPResponse] The response from the API call, indicating the success or failure of the checkout finalization.
+  def finalize_checkout_session(checkout_session_id, payload, headers: {})
+    api_call("#{Constants::CHECKOUT_SESSION_URL}/#{checkout_session_id}/finalize", Constants::POST, payload: payload, headers: headers)
+  end
+
+  # API to retrieve a Charge Permission object
+  # Fetches details of a Charge Permission, which is associated with a Checkout Session.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/charge-permission.html#get-charge-permission
+  # @param {String} charge_permission_id - The unique identifier for the Charge Permission.
+  # @param {Object} headers - Optional headers for the request.
+  # @return [HTTPResponse] The response from the API call, including the details of the Charge Permission.
+  def get_charge_permission(charge_permission_id, headers: {})
+    api_call("#{Constants::CHARGE_PERMISSIONS_URL}/#{charge_permission_id}", Constants::GET, headers: headers)
+  end
+
+  # API to update a Charge Permission object
+  # Updates a previously created Charge Permission with new information.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/charge-permission.html#update-charge-permission
+  # @param {String} charge_permission_id - The unique identifier for the Charge Permission.
+  # @param {Object} payload - The payload for the request. This should include the fields that need to be updated.
+  # @param {Object} headers - Optional headers for the request.
+  # @return [HTTPResponse] The response from the API call, including the updated details of the Charge Permission.
+  def update_charge_permission(charge_permission_id, payload, headers: {})
+    api_call("#{Constants::CHARGE_PERMISSIONS_URL}/#{charge_permission_id}", Constants::PATCH, payload: payload, headers: headers)
+  end
+
+  # API to close a Charge Permission object
+  # Closes a Charge Permission, preventing further charges.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/charge-permission.html#close-charge-permission
+  # @param {String} charge_permission_id - The unique identifier for the Charge Permission.
+  # @param {Object} payload - The payload for the request, typically including a reason for closure.
+  # @param {Object} headers - Optional headers for the request.
+  # @return [HTTPResponse] The response from the API call, confirming the closure of the Charge Permission.
+  def close_charge_permission(charge_permission_id, payload, headers: {})
+    api_call("#{Constants::CHARGE_PERMISSIONS_URL}/#{charge_permission_id}/close", Constants::DELETE, payload: payload, headers: headers)
+  end
+
+  # API to create a new charge
+  # Initiates a new charge with the provided payment details.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/charge.html#create-charge
+  # @param {Object} payload - The payload containing payment details, such as the amount and currency.
+  # @param {Object} headers - 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 created charge.
+  def create_charge(payload, headers: {})
+    api_call(Constants::CHARGES_URL, Constants::POST, payload: payload, headers: headers)
+  end
+
+  # API to retrieve charge details
+  # Retrieves details of an existing charge using its unique charge ID.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/charge.html#get-charge
+  # @param {String} charge_id - The unique ID of the charge to retrieve.
+  # @param {Object} headers - 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 requested charge.
+  def get_charge(charge_id, headers: {})
+    api_call("#{Constants::CHARGES_URL}/#{charge_id}", Constants::GET, headers: headers)
+  end
+
+  # API to capture a charge
+  # Captures an authorized charge to collect the funds.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/charge.html#capture-charge
+  # @param {String} charge_id - The unique ID of the charge to capture.
+  # @param {Object} payload - The payload containing capture details, such as the amount to capture.
+  # @param {Object} headers - 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 captured charge.
+  def capture_charge(charge_id, payload, headers: {})
+    api_call("#{Constants::CHARGES_URL}/#{charge_id}/capture", Constants::POST, payload: payload, headers: headers)
+  end
+
+  # API to cancel a charge
+  # Cancels an existing charge, preventing it from being captured.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/charge.html#cancel-charge
+  # @param {String} charge_id - The unique ID of the charge to cancel.
+  # @param {Object} payload - The payload containing cancellation details.
+  # @param {Object} headers - Optional headers for the request, such as authorization tokens or custom headers.
+  # @return [HTTPResponse] The response from the API call, which confirms the cancellation of the charge.
+  def cancel_charge(charge_id, payload, headers: {})
+    api_call("#{Constants::CHARGES_URL}/#{charge_id}/cancel", Constants::DELETE, payload: payload, headers: headers)
+  end
+
+  # API to create a refund
+  # Initiates a new refund for a previously captured charge.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/refund.html#create-refund
+  # @param {Object} payload - The payload containing refund details, such as the amount and currency.
+  # @param {Object} headers - 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 created refund.
+  def create_refund(payload, headers: {})
+    api_call(Constants::REFUNDS_URL, Constants::POST, payload: payload, headers: headers)
+  end
+
+  # API to retrieve refund details
+  # Retrieves details of an existing refund using its unique refund ID.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/refund.html#get-refund
+  # @param {String} refund_id - The unique ID of the refund to retrieve.
+  # @param {Object} headers - 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 requested refund.
+  def get_refund(refund_id, headers: {})
+    api_call("#{Constants::REFUNDS_URL}/#{refund_id}", Constants::GET, headers: headers)
+  end
+
+  # API to retrieve a list of reports
+  # Retrieves a list of reports based on the provided query parameters.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/reports.html#get-reports
+  # @param {Object} headers - Optional headers for the request, such as authorization tokens or custom headers.
+  # @param {Object} query_params - Query parameters to filter the reports, such as report type or processing status.
+  # @return [HTTPResponse] The response from the API call, which includes a list of reports matching the criteria.
+  def get_reports(headers: {}, query_params: {})
+    api_call(Constants::REPORTS, Constants::GET, headers: headers, query_params: query_params)
+  end
+
+  # API to retrieve a specific report by ID
+  # Retrieves details of a specific report using its unique report ID.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/reports.html#get-report-by-id
+  # @param {String} report_id - The unique ID of the report to retrieve.
+  # @param {Object} headers - 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 requested report.
+  def get_report_by_id(report_id, headers: {})
+    api_call("#{Constants::REPORTS}/#{report_id}", Constants::GET, headers: headers)
+  end
+
+  # API to create a new report
+  # Creates a new report based on the provided payload.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/reports.html#create-report
+  # @param {Object} payload - The payload containing data required to generate the report.
+  # @param {Object} headers - Optional headers for the request, such as authorization tokens or custom headers.
+  # @return [HTTPResponse] The response from the API call, which includes confirmation and details of the created report.
+  def create_report(payload, headers: {})
+    api_call(Constants::REPORTS, Constants::POST, payload: payload, headers: headers)
+  end
+
+  # API to retrieve a specific report document by ID
+  # Retrieves the content of a specific report document using its unique report document ID.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/reports.html#get-report-document
+  # @param {String} report_document_id - The unique ID of the report document to retrieve.
+  # @param {Object} headers - Optional headers for the request, such as authorization tokens or custom headers.
+  # @return [HTTPResponse] The response from the API call, which includes the content of the requested report document.
+  def get_report_document(report_document_id, headers: {})
+    api_call("#{Constants::REPORT_DOCUMENTS}/#{report_document_id}", Constants::GET, headers: headers)
+  end
+
+  # API to retrieve a list of report schedules
+  # Retrieves a list of report schedules based on the provided query parameters.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/reports.html#get-report-schedules
+  # @param {Object} headers - Optional headers for the request, such as authorization tokens or custom headers.
+  # @param {Object} query_params - Query parameters to filter the report schedules, such as schedule type or status.
+  # @return [HTTPResponse] The response from the API call, which includes a list of report schedules matching the criteria.
+  def get_report_schedules(headers: {}, query_params: {})
+    api_call(Constants::REPORT_SCHEDULES, Constants::GET, headers: headers, query_params: query_params)
+  end
+
+  # API to retrieve a specific report schedule by ID
+  # Retrieves details of a specific report schedule using its unique report schedule ID.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/reports.html#get-report-schedule-by-id
+  # @param {String} report_schedule_id - The unique ID of the report schedule to retrieve.
+  # @param {Object} headers - 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 requested report schedule.
+  def get_report_schedule_by_id(report_schedule_id, headers: {})
+    api_call("#{Constants::REPORT_SCHEDULES}/#{report_schedule_id}", Constants::GET, headers: headers)
+  end
+
+  # API to create a new report schedule
+  # Creates a new report schedule based on the provided payload.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/reports.html#create-report-schedule
+  # @param {Object} payload - The payload containing data required to set up the report schedule.
+  # @param {Object} headers - Optional headers for the request, such as authorization tokens or custom headers.
+  # @return [HTTPResponse] The response from the API call, which includes confirmation and details of the created report schedule.
+  def create_report_schedule(payload, headers: {}, query_params: {})
+    api_call(Constants::REPORT_SCHEDULES, Constants::POST, payload: payload, headers: headers, query_params: query_params)
+  end
+
+  # API to cancel an existing report schedule by ID
+  # Cancels a specific report schedule using its unique report schedule ID.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/reports.html#cancel-report-schedule
+  # @param {String} report_schedule_id - The unique ID of the report schedule to cancel.
+  # @param {Object} headers - Optional headers for the request, such as authorization tokens or custom headers.
+  # @return [HTTPResponse] The response from the API call, which includes confirmation of the cancellation.
+  def cancel_report_schedule(report_schedule_id, headers: {})
+    api_call("#{Constants::REPORT_SCHEDULES}/#{report_schedule_id}", Constants::DELETE, headers: headers)
+  end
+
+  # API to retrieve a list of disbursements
+  # Retrieves a list of disbursements based on the provided query parameters.
+  # @see https://developer.amazon.com/docs/amazon-pay-api-v2/reports.html#get-disbursements
+  # @param {Object} headers - Optional headers for the request, such as authorization tokens or custom headers.
+  # @param {Object} query_params - Query parameters to filter the disbursements, such as date range or status.
+  # @return [HTTPResponse] The response from the API call, which includes a list of disbursements matching the criteria.
+  def get_disbursements(headers: {}, query_params: {})
+    api_call(Constants::DISBURSEMENTS, Constants::GET, headers: headers, query_params: query_params)
+  end
 end

data/lib/amazon_pay/constants.rb

@@ -1,8 +1,8 @@
 require 'net/http'
 
 module Constants
-    SDK_TYPE = "MerchantOnboarding-Ruby".freeze
-    SDK_VERSION = "1.0.0".freeze
+    SDK_TYPE = "amazon-pay-api-sdk-ruby".freeze
+    SDK_VERSION = "1.2.0".freeze
     API_VERSION = "v2".freeze
     API_ENDPOINTS = {
       'na' => 'pay-api.amazon.com',
@@ -32,11 +32,22 @@ module Constants
     LIVE = 'LIVE-'
     SANDBOX = 'SANDBOX-'
     MERCHANT_ACCOUNTS_BASE_URL = 'merchantAccounts'.freeze
+    GET = 'GET'.freeze
     POST = 'POST'.freeze
     PATCH = 'PATCH'.freeze
+    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
     HTTP_OK = '200'
     HTTP_SERVER_ERROR = '500'
+    BUYERS_URL = 'buyers'.freeze
+    CHECKOUT_SESSION_URL = 'checkoutSessions'.freeze
+    CHARGE_PERMISSIONS_URL = 'chargePermissions'.freeze
+    CHARGES_URL = 'charges'.freeze
+    REFUNDS_URL = 'refunds'.freeze
+    REPORTS = 'reports'.freeze
+    REPORT_SCHEDULES = 'report-schedules'.freeze
+    REPORT_DOCUMENTS = 'report-documents'.freeze
+    DISBURSEMENTS = 'disbursements'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amazon-pay-api-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - AmazonPay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-05 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: This is an AmazonPay Ruby SDK