feat(experimental): Add declined transactions report (#1570)

* feat(experimental): add declined transactions

* feat(experimental): add schema

* Trigger build

* Update openapi.yaml

* Remove samples

* Update aggregation field

* Update fields

* Change value

* Update openapi/components/schemas/ReportDeclinedTransactions.yaml

Co-authored-by: Chris  <[email protected]>

* Update openapi/components/schemas/ReportDeclinedTransactions.yaml

Co-authored-by: Chris  <[email protected]>

* Remove required

* Update openapi/components/schemas/ReportDeclinedTransactions.yaml

Co-authored-by: Chris  <[email protected]>

---------

Co-authored-by: Alexander Shkarpetin <[email protected]>
Co-authored-by: Alexander Shkarpetin <[email protected]>
Co-authored-by: Simon Sorich <[email protected]>
Co-authored-by: Simon <[email protected]>
Co-authored-by: Chris <[email protected]>

Author: 4 people

openapi/components/schemas/ReportDeclinedTransactions.yaml

@@ -0,0 +1,24 @@
+type: object
+properties:
+  totalCount:
+    description: Total number of declined transactions.
+    type: integer
+    example: 1500
+  data:
+    type: array
+    items:
+      type: object
+      properties:
+        message:
+          description: Description or message related to the declined transactions report.
+          type: string
+          example: error
+        count:
+          description: Number of declined transactions.
+          type: integer
+          example: 500
+        percentage:
+          description: Percentage of declined transactions.
+          type: number
+          format: double
+          example: 25.0

openapi/openapi.yaml

@@ -1114,6 +1114,8 @@ paths:
     $ref: ./paths/[email protected]
   /experimental/reports/dcc-markup:
     $ref: ./paths/[email protected]
+  /experimental/reports/declined-transactions:
+    $ref: ./paths/[email protected]
   /experimental/reports/disputes:
     $ref: ./paths/[email protected]
   /experimental/reports/events-triggered:

openapi/paths/[email protected]

@@ -0,0 +1,67 @@
+servers:
+  - url: 'https://api-sandbox.rebilly.com/experimental/organizations/{organizationId}'
+    description: Sandbox server
+    variables:
+      organizationId:
+        default: unknown
+        description: |-
+          Unique organization identifier.
+          An organization is an entity that represents a company.
+          For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+  - url: 'https://api.rebilly.com/experimental/organizations/{organizationId}'
+    description: Live server
+    variables:
+      organizationId:
+        default: unknown
+        description: |-
+          Unique organization identifier.
+          An organization is an entity that represents a company.
+          For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+get:
+  x-badge: Experimental
+  x-products:
+    - Reports
+  tags:
+    - Reports
+  summary: Retrieve a declined transactions report
+  operationId: GetDeclinedTransactionsReport
+  x-sdk-operation-name: getDeclinedTransactions
+  description: Retrieves a report on declined transactions.
+  parameters:
+    - name: aggregationField
+      in: query
+      description: Report aggregation field.
+      required: true
+      schema:
+        type: string
+        enum:
+          - gatewayResponseMessage
+          - gatewayResponseOriginalMessage
+    - name: periodStart
+      in: query
+      description: Date and time when the report starts.
+      required: true
+      schema:
+        type: string
+        format: date-time
+    - name: periodEnd
+      in: query
+      description: Date and time when the report ends.
+      required: true
+      schema:
+        type: string
+        format: date-time
+    - $ref: ../components/parameters/collectionLimit.yaml
+    - $ref: ../components/parameters/collectionOffset.yaml
+    - $ref: ../components/parameters/collectionFilter.yaml
+  responses:
+    '200':
+      description: Report retrieved.
+      content:
+        application/json:
+          schema:
+            $ref: ../components/schemas/ReportDeclinedTransactions.yaml
+    '401':
+      $ref: ../components/responses/Unauthorized.yaml
+    '403':
+      $ref: ../components/responses/Forbidden.yaml