@naturalpay/sdk 0.9.0 → 0.10.0

package/src/resources/payment-requests.ts

@@ -17,7 +17,7 @@ export class PaymentRequests extends APIResource {
    * ```ts
    * const paymentRequest = await client.paymentRequests.create({
    *   amount: 1,
-   *   payer: { type: 'type', value: 'dev@stainless.com' },
+   *   payer: { type: 'email', value: 'dev@stainless.com' },
    *   'Idempotency-Key': 'Idempotency-Key',
    * });
    * ```
@@ -116,7 +116,7 @@ export class PaymentRequests extends APIResource {
    *   'prq_ecc2efdd09bd231a9ad9bd2aada37aa7',
    *   {
    *     paymentSource: {
-   *       type: 'type',
+   *       type: 'wallet',
    *       walletId: 'wal_ecc2efdd09bd231a9ad9bd2aada37aa7',
    *     },
    *     'Idempotency-Key': 'Idempotency-Key',
@@ -229,7 +229,7 @@ export namespace PaymentRequestCreateResponse {
     /**
      * Resource type
      */
-    type: string;
+    type: 'paymentRequest';
   }
 
   export namespace Data {
@@ -305,7 +305,15 @@ export namespace PaymentRequestCreateResponse {
       /**
        * Current status of the payment request
        */
-      status: 'OPEN' | 'PROCESSING' | 'COMPLETED' | 'CANCELLED' | 'DECLINED' | 'EXPIRED';
+      status:
+        | 'OPEN'
+        | 'PROCESSING'
+        | 'COMPLETED'
+        | 'FAILED'
+        | 'RETURNED'
+        | 'CANCELLED'
+        | 'DECLINED'
+        | 'EXPIRED';
 
       /**
        * ID of the transaction created by the most recent payment attempt, or null if no
@@ -355,7 +363,7 @@ export namespace PaymentRequestCreateResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'party';
         }
       }
 
@@ -379,7 +387,7 @@ export namespace PaymentRequestCreateResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'party';
         }
       }
     }
@@ -412,7 +420,7 @@ export namespace PaymentRequestListResponse {
     /**
      * Resource type
      */
-    type: string;
+    type: 'paymentRequest';
   }
 
   export namespace Data {
@@ -488,7 +496,15 @@ export namespace PaymentRequestListResponse {
       /**
        * Current status of the payment request
        */
-      status: 'OPEN' | 'PROCESSING' | 'COMPLETED' | 'CANCELLED' | 'DECLINED' | 'EXPIRED';
+      status:
+        | 'OPEN'
+        | 'PROCESSING'
+        | 'COMPLETED'
+        | 'FAILED'
+        | 'RETURNED'
+        | 'CANCELLED'
+        | 'DECLINED'
+        | 'EXPIRED';
 
       /**
        * ID of the transaction created by the most recent payment attempt, or null if no
@@ -511,6 +527,11 @@ export namespace PaymentRequestListResponse {
        */
       payerParty: Relationships.PayerParty;
 
+      /**
+       * Payment submitted for this payment request, if one exists.
+       */
+      payment: Relationships.Payment;
+
       /**
        * Party requesting the payment
        */
@@ -543,7 +564,31 @@ export namespace PaymentRequestListResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'party';
+        }
+      }
+
+      /**
+       * Payment submitted for this payment request, if one exists.
+       */
+      export interface Payment {
+        /**
+         * Related resource identifier
+         */
+        data: Payment.Data | null;
+      }
+
+      export namespace Payment {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: 'payment';
         }
       }
 
@@ -567,7 +612,7 @@ export namespace PaymentRequestListResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'party';
         }
       }
 
@@ -591,7 +636,7 @@ export namespace PaymentRequestListResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'wallet';
         }
       }
     }
@@ -634,7 +679,7 @@ export namespace PaymentRequestDeclineResponse {
     /**
      * Resource type
      */
-    type: string;
+    type: 'paymentRequest';
   }
 
   export namespace Data {
@@ -710,7 +755,15 @@ export namespace PaymentRequestDeclineResponse {
       /**
        * Current status of the payment request
        */
-      status: 'OPEN' | 'PROCESSING' | 'COMPLETED' | 'CANCELLED' | 'DECLINED' | 'EXPIRED';
+      status:
+        | 'OPEN'
+        | 'PROCESSING'
+        | 'COMPLETED'
+        | 'FAILED'
+        | 'RETURNED'
+        | 'CANCELLED'
+        | 'DECLINED'
+        | 'EXPIRED';
 
       /**
        * ID of the transaction created by the most recent payment attempt, or null if no
@@ -733,6 +786,11 @@ export namespace PaymentRequestDeclineResponse {
        */
       payerParty: Relationships.PayerParty;
 
+      /**
+       * Payment submitted for this payment request, if one exists.
+       */
+      payment: Relationships.Payment;
+
       /**
        * Party requesting the payment
        */
@@ -765,7 +823,31 @@ export namespace PaymentRequestDeclineResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'party';
+        }
+      }
+
+      /**
+       * Payment submitted for this payment request, if one exists.
+       */
+      export interface Payment {
+        /**
+         * Related resource identifier
+         */
+        data: Payment.Data | null;
+      }
+
+      export namespace Payment {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: 'payment';
         }
       }
 
@@ -789,7 +871,7 @@ export namespace PaymentRequestDeclineResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'party';
         }
       }
 
@@ -813,7 +895,7 @@ export namespace PaymentRequestDeclineResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'wallet';
         }
       }
     }
@@ -828,14 +910,216 @@ export namespace PaymentRequestFulfillResponse {
   export interface Data {
     id: string;
 
+    /**
+     * Resource attributes
+     */
     attributes: Data.Attributes;
 
-    type: string;
+    /**
+     * Resource relationships
+     */
+    relationships: Data.Relationships;
+
+    type: 'payment';
   }
 
   export namespace Data {
+    /**
+     * Resource attributes
+     */
     export interface Attributes {
-      outcome: 'processing' | 'failed' | 'completed' | 'in_review';
+      /**
+       * Amount in cents
+       */
+      amount: number;
+
+      /**
+       * When this payment was created
+       */
+      createdAt: string;
+
+      /**
+       * Currency code
+       */
+      currency: string;
+
+      /**
+       * Payment description
+       */
+      description: string | null;
+
+      /**
+       * Payment status
+       */
+      status:
+        | 'CREATED'
+        | 'PROCESSING'
+        | 'PENDING_CLAIM'
+        | 'IN_REVIEW'
+        | 'COMPLETED'
+        | 'FAILED'
+        | 'RETURNED'
+        | 'APPROVAL_DENIED'
+        | 'CANCELLED';
+
+      /**
+       * When this payment was last updated
+       */
+      updatedAt: string | null;
+    }
+
+    /**
+     * Resource relationships
+     */
+    export interface Relationships {
+      /**
+       * Payment request that produced this payment, when applicable.
+       */
+      paymentRequest: Relationships.PaymentRequest;
+
+      /**
+       * Recipient party for this payment, when known.
+       */
+      recipient: Relationships.Recipient;
+
+      /**
+       * Recipient agent when the caller addressed an agent ID. Null otherwise, including
+       * when the recipient was addressed as an email, phone, or party ID.
+       */
+      recipientAgent: Relationships.RecipientAgent;
+
+      /**
+       * Party that initiated the payment
+       */
+      sender: Relationships.Sender;
+
+      /**
+       * Sender-side transaction row for this payment, when available.
+       */
+      transaction: Relationships.Transaction;
+    }
+
+    export namespace Relationships {
+      /**
+       * Payment request that produced this payment, when applicable.
+       */
+      export interface PaymentRequest {
+        /**
+         * Related resource identifier
+         */
+        data: PaymentRequest.Data | null;
+      }
+
+      export namespace PaymentRequest {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: 'paymentRequest';
+        }
+      }
+
+      /**
+       * Recipient party for this payment, when known.
+       */
+      export interface Recipient {
+        /**
+         * Related resource identifier
+         */
+        data: Recipient.Data | null;
+      }
+
+      export namespace Recipient {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: 'party';
+        }
+      }
+
+      /**
+       * Recipient agent when the caller addressed an agent ID. Null otherwise, including
+       * when the recipient was addressed as an email, phone, or party ID.
+       */
+      export interface RecipientAgent {
+        /**
+         * Related resource identifier
+         */
+        data: RecipientAgent.Data | null;
+      }
+
+      export namespace RecipientAgent {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: 'agent';
+        }
+      }
+
+      /**
+       * Party that initiated the payment
+       */
+      export interface Sender {
+        /**
+         * Related resource identifier
+         */
+        data: Sender.Data;
+      }
+
+      export namespace Sender {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: 'party';
+        }
+      }
+
+      /**
+       * Sender-side transaction row for this payment, when available.
+       */
+      export interface Transaction {
+        /**
+         * Related resource identifier
+         */
+        data: Transaction.Data | null;
+      }
+
+      export namespace Transaction {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: 'transaction';
+        }
+      }
     }
   }
 }
@@ -864,7 +1148,7 @@ export namespace PaymentRequestGetResponse {
     /**
      * Resource type
      */
-    type: string;
+    type: 'paymentRequest';
   }
 
   export namespace Data {
@@ -940,7 +1224,15 @@ export namespace PaymentRequestGetResponse {
       /**
        * Current status of the payment request
        */
-      status: 'OPEN' | 'PROCESSING' | 'COMPLETED' | 'CANCELLED' | 'DECLINED' | 'EXPIRED';
+      status:
+        | 'OPEN'
+        | 'PROCESSING'
+        | 'COMPLETED'
+        | 'FAILED'
+        | 'RETURNED'
+        | 'CANCELLED'
+        | 'DECLINED'
+        | 'EXPIRED';
 
       /**
        * ID of the transaction created by the most recent payment attempt, or null if no
@@ -963,6 +1255,11 @@ export namespace PaymentRequestGetResponse {
        */
       payerParty: Relationships.PayerParty;
 
+      /**
+       * Payment submitted for this payment request, if one exists.
+       */
+      payment: Relationships.Payment;
+
       /**
        * Party requesting the payment
        */
@@ -995,7 +1292,31 @@ export namespace PaymentRequestGetResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'party';
+        }
+      }
+
+      /**
+       * Payment submitted for this payment request, if one exists.
+       */
+      export interface Payment {
+        /**
+         * Related resource identifier
+         */
+        data: Payment.Data | null;
+      }
+
+      export namespace Payment {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: 'payment';
         }
       }
 
@@ -1019,7 +1340,7 @@ export namespace PaymentRequestGetResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'party';
         }
       }
 
@@ -1043,7 +1364,7 @@ export namespace PaymentRequestGetResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'wallet';
         }
       }
     }
@@ -1076,7 +1397,7 @@ export namespace PaymentRequestListIncomingResponse {
     /**
      * Resource type
      */
-    type: string;
+    type: 'paymentRequest';
   }
 
   export namespace Data {
@@ -1152,7 +1473,15 @@ export namespace PaymentRequestListIncomingResponse {
       /**
        * Current status of the payment request
        */
-      status: 'OPEN' | 'PROCESSING' | 'COMPLETED' | 'CANCELLED' | 'DECLINED' | 'EXPIRED';
+      status:
+        | 'OPEN'
+        | 'PROCESSING'
+        | 'COMPLETED'
+        | 'FAILED'
+        | 'RETURNED'
+        | 'CANCELLED'
+        | 'DECLINED'
+        | 'EXPIRED';
 
       /**
        * ID of the transaction created by the most recent payment attempt, or null if no
@@ -1175,6 +1504,11 @@ export namespace PaymentRequestListIncomingResponse {
        */
       payerParty: Relationships.PayerParty;
 
+      /**
+       * Payment submitted for this payment request, if one exists.
+       */
+      payment: Relationships.Payment;
+
       /**
        * Party requesting the payment
        */
@@ -1207,7 +1541,31 @@ export namespace PaymentRequestListIncomingResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'party';
+        }
+      }
+
+      /**
+       * Payment submitted for this payment request, if one exists.
+       */
+      export interface Payment {
+        /**
+         * Related resource identifier
+         */
+        data: Payment.Data | null;
+      }
+
+      export namespace Payment {
+        /**
+         * Related resource identifier
+         */
+        export interface Data {
+          id: string;
+
+          /**
+           * Resource type
+           */
+          type: 'payment';
         }
       }
 
@@ -1231,7 +1589,7 @@ export namespace PaymentRequestListIncomingResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'party';
         }
       }
 
@@ -1255,7 +1613,7 @@ export namespace PaymentRequestListIncomingResponse {
           /**
            * Resource type
            */
-          type: string;
+          type: 'wallet';
         }
       }
     }
@@ -1284,7 +1642,11 @@ export interface PaymentRequestCreateParams {
    * Body param: Who pays — exactly one typed email, phone, party ID, or agent ID
    * value.
    */
-  payer: PaymentRequestCreateParams.UnionMember0 | PaymentRequestCreateParams.UnionMember1;
+  payer:
+    | PaymentRequestCreateParams.UnionMember0
+    | PaymentRequestCreateParams.UnionMember1
+    | PaymentRequestCreateParams.UnionMember2
+    | PaymentRequestCreateParams.UnionMember3;
 
   /**
    * Header param: Unique key for idempotent request handling. If a request with the
@@ -1339,7 +1701,7 @@ export interface PaymentRequestCreateParams {
 
 export namespace PaymentRequestCreateParams {
   export interface UnionMember0 {
-    type: string;
+    type: 'email';
 
     /**
      * Email address
@@ -1348,7 +1710,7 @@ export namespace PaymentRequestCreateParams {
   }
 
   export interface UnionMember1 {
-    type: string;
+    type: 'phone';
 
     /**
      * Phone number in E.164 format
@@ -1356,6 +1718,24 @@ export namespace PaymentRequestCreateParams {
     value: string;
   }
 
+  export interface UnionMember2 {
+    type: 'party_id';
+
+    /**
+     * Natural party ID (pty\_\*)
+     */
+    value: string;
+  }
+
+  export interface UnionMember3 {
+    type: 'agent_id';
+
+    /**
+     * Natural agent ID (agt\_\*)
+     */
+    value: string;
+  }
+
   /**
    * If provided, immediately deliver the payment link to the payer via the named
    * channel
@@ -1436,7 +1816,7 @@ export interface PaymentRequestFulfillParams {
 
 export namespace PaymentRequestFulfillParams {
   export interface UnionMember0 {
-    type: string;
+    type: 'wallet';
 
     walletId: string;
   }
@@ -1444,7 +1824,7 @@ export namespace PaymentRequestFulfillParams {
   export interface UnionMember1 {
     externalAccountId: string;
 
-    type: string;
+    type: 'external_account';
   }
 }