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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff292f2eaf06b442175de16106fb31f54042337f11af7653609bf436eb34133a
-  data.tar.gz: b752565c83f486c960878d54fd204c6f70c543544d5574a5f820c5210e8f857d
+  metadata.gz: 428da5a80e49d6cf400205eea58757174f259abce2bb6cc7a83aecd0c1554f5f
+  data.tar.gz: b809960b865a226d7796e506d1712759c0db90119cd886942b5aa9d6ed125681
 SHA512:
-  metadata.gz: f45eaed130252eb5e06094fefd1cbc16d923a14c5248250118264ab29db0992bfc2c0bd3d4c820f7019aa2bae43241f3cdc0b5f148500724af32cbef454827d8
-  data.tar.gz: 8e867a51a1ffacd9eaee7c39c4217d0466dc3b651be3a89e71b0b8f0899696748be58cc6390d5b53a4417ede4368968919b9cc38ce662bcc1cabe8f0c47f873c
+  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"
                 }
             }
@@ -205,9 +187,11 @@ 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}"
@@ -610,4 +594,154 @@ else
     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
@@ -266,4 +265,93 @@ class AmazonPayClient
     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

@@ -2,7 +2,7 @@ require 'net/http'
 
 module Constants
     SDK_TYPE = "amazon-pay-api-sdk-ruby".freeze
-    SDK_VERSION = "1.1.0".freeze
+    SDK_VERSION = "1.2.0".freeze
     API_VERSION = "v2".freeze
     API_ENDPOINTS = {
       'na' => 'pay-api.amazon.com',
@@ -46,4 +46,8 @@ module Constants
     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.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - AmazonPay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-19 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64