@naturalpay/sdk 0.3.0 → 0.4.0

package/src/resources/transactions.ts

@@ -7,11 +7,11 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 /**
- * Payment and transaction operations
+ * Transaction activity and history operations
  */
 export class Transactions extends APIResource {
   /**
-   * List transactions visible to your party and its delegated agents.
+   * List transactions visible to your party.
    */
   list(
     params: TransactionListParams | null | undefined = {},
@@ -85,23 +85,11 @@ export namespace TransactionListResponse {
      * Resource attributes
      */
     export interface Attributes {
-      /**
-       * Agent that initiated this transaction. Null when initiated by a human user.
-       */
-      agentId: string | null;
-
       /**
        * Amount in cents
        */
       amount: number;
 
-      /**
-       * Classification from your party's perspective. Derived from transactionType +
-       * direction: "sent"/"received" for wallet-to-wallet payments (OUTBOUND/INBOUND),
-       * "deposit"/"withdrawal" for external transfers (INBOUND/OUTBOUND).
-       */
-      category: 'sent' | 'received' | 'deposit' | 'withdrawal';
-
       /**
        * When this transaction was created
        */
@@ -112,11 +100,6 @@ export namespace TransactionListResponse {
        */
       currency: string;
 
-      /**
-       * Customer name if delegated
-       */
-      customerName: string | null;
-
       /**
        * Payment description
        */
@@ -128,41 +111,11 @@ export namespace TransactionListResponse {
       direction: 'INBOUND' | 'OUTBOUND';
 
       /**
-       * Active dispute ID when a dispute has been filed for this transaction
-       */
-      disputeId: string | null;
-
-      /**
-       * Pending escalation ID when this transaction requires approval
-       */
-      escalationId: string | null;
-
-      /**
-       * Projected funds-available time for transfers (deposits/withdrawals). Null when
-       * no MMR settlement projection has arrived yet, and null for payments.
+       * Projected funds-available time for transfers. Null when no projection exists and
+       * null for payments.
        */
       expectedAvailableAt: string | null;
 
-      /**
-       * Display name of the user or agent that initiated this transaction
-       */
-      initiatorName: string | null;
-
-      /**
-       * True if this is a delegated customer payment
-       */
-      isDelegated: boolean;
-
-      /**
-       * Recipient display name
-       */
-      recipientName: string | null;
-
-      /**
-       * Sender display name
-       */
-      senderName: string | null;
-
       /**
        * Transaction status
        */
@@ -189,19 +142,21 @@ export namespace TransactionListResponse {
       destinationParty: Relationships.DestinationParty;
 
       /**
-       * Destination wallet
+       * Source party
        */
-      destinationWallet: Relationships.DestinationWallet;
+      sourceParty: Relationships.SourceParty;
 
       /**
-       * Source party
+       * Payment that produced this transaction. Present only when the authenticated
+       * caller can access the payment resource.
        */
-      sourceParty: Relationships.SourceParty;
+      payment?: Relationships.Payment;
 
       /**
-       * Source wallet
+       * Transfer that produced this transaction. Present only when the authenticated
+       * caller can access the transfer resource.
        */
-      sourceWallet: Relationships.SourceWallet;
+      transfer?: Relationships.Transfer;
     }
 
     export namespace Relationships {
@@ -230,16 +185,16 @@ export namespace TransactionListResponse {
       }
 
       /**
-       * Destination wallet
+       * Source party
        */
-      export interface DestinationWallet {
+      export interface SourceParty {
         /**
          * Related resource identifier
          */
-        data: DestinationWallet.Data | null;
+        data: SourceParty.Data | null;
       }
 
-      export namespace DestinationWallet {
+      export namespace SourceParty {
         /**
          * Related resource identifier
          */
@@ -254,16 +209,17 @@ export namespace TransactionListResponse {
       }
 
       /**
-       * Source party
+       * Payment that produced this transaction. Present only when the authenticated
+       * caller can access the payment resource.
        */
-      export interface SourceParty {
+      export interface Payment {
         /**
          * Related resource identifier
          */
-        data: SourceParty.Data | null;
+        data: Payment.Data;
       }
 
-      export namespace SourceParty {
+      export namespace Payment {
         /**
          * Related resource identifier
          */
@@ -278,16 +234,17 @@ export namespace TransactionListResponse {
       }
 
       /**
-       * Source wallet
+       * Transfer that produced this transaction. Present only when the authenticated
+       * caller can access the transfer resource.
        */
-      export interface SourceWallet {
+      export interface Transfer {
         /**
          * Related resource identifier
          */
-        data: SourceWallet.Data | null;
+        data: Transfer.Data;
       }
 
-      export namespace SourceWallet {
+      export namespace Transfer {
         /**
          * Related resource identifier
          */
@@ -345,23 +302,11 @@ export namespace TransactionGetResponse {
      * Resource attributes
      */
     export interface Attributes {
-      /**
-       * Agent that initiated this transaction. Null when initiated by a human user.
-       */
-      agentId: string | null;
-
       /**
        * Amount in cents
        */
       amount: number;
 
-      /**
-       * Classification from your party's perspective. Derived from transactionType +
-       * direction: "sent"/"received" for wallet-to-wallet payments (OUTBOUND/INBOUND),
-       * "deposit"/"withdrawal" for external transfers (INBOUND/OUTBOUND).
-       */
-      category: 'sent' | 'received' | 'deposit' | 'withdrawal';
-
       /**
        * When this transaction was created
        */
@@ -372,11 +317,6 @@ export namespace TransactionGetResponse {
        */
       currency: string;
 
-      /**
-       * Customer name if delegated
-       */
-      customerName: string | null;
-
       /**
        * Payment description
        */
@@ -388,41 +328,11 @@ export namespace TransactionGetResponse {
       direction: 'INBOUND' | 'OUTBOUND';
 
       /**
-       * Active dispute ID when a dispute has been filed for this transaction
-       */
-      disputeId: string | null;
-
-      /**
-       * Pending escalation ID when this transaction requires approval
-       */
-      escalationId: string | null;
-
-      /**
-       * Projected funds-available time for transfers (deposits/withdrawals). Null when
-       * no MMR settlement projection has arrived yet, and null for payments.
+       * Projected funds-available time for transfers. Null when no projection exists and
+       * null for payments.
        */
       expectedAvailableAt: string | null;
 
-      /**
-       * Display name of the user or agent that initiated this transaction
-       */
-      initiatorName: string | null;
-
-      /**
-       * True if this is a delegated customer payment
-       */
-      isDelegated: boolean;
-
-      /**
-       * Recipient display name
-       */
-      recipientName: string | null;
-
-      /**
-       * Sender display name
-       */
-      senderName: string | null;
-
       /**
        * Transaction status
        */
@@ -449,19 +359,21 @@ export namespace TransactionGetResponse {
       destinationParty: Relationships.DestinationParty;
 
       /**
-       * Destination wallet
+       * Source party
        */
-      destinationWallet: Relationships.DestinationWallet;
+      sourceParty: Relationships.SourceParty;
 
       /**
-       * Source party
+       * Payment that produced this transaction. Present only when the authenticated
+       * caller can access the payment resource.
        */
-      sourceParty: Relationships.SourceParty;
+      payment?: Relationships.Payment;
 
       /**
-       * Source wallet
+       * Transfer that produced this transaction. Present only when the authenticated
+       * caller can access the transfer resource.
        */
-      sourceWallet: Relationships.SourceWallet;
+      transfer?: Relationships.Transfer;
     }
 
     export namespace Relationships {
@@ -490,16 +402,16 @@ export namespace TransactionGetResponse {
       }
 
       /**
-       * Destination wallet
+       * Source party
        */
-      export interface DestinationWallet {
+      export interface SourceParty {
         /**
          * Related resource identifier
          */
-        data: DestinationWallet.Data | null;
+        data: SourceParty.Data | null;
       }
 
-      export namespace DestinationWallet {
+      export namespace SourceParty {
         /**
          * Related resource identifier
          */
@@ -514,16 +426,17 @@ export namespace TransactionGetResponse {
       }
 
       /**
-       * Source party
+       * Payment that produced this transaction. Present only when the authenticated
+       * caller can access the payment resource.
        */
-      export interface SourceParty {
+      export interface Payment {
         /**
          * Related resource identifier
          */
-        data: SourceParty.Data | null;
+        data: Payment.Data;
       }
 
-      export namespace SourceParty {
+      export namespace Payment {
         /**
          * Related resource identifier
          */
@@ -538,16 +451,17 @@ export namespace TransactionGetResponse {
       }
 
       /**
-       * Source wallet
+       * Transfer that produced this transaction. Present only when the authenticated
+       * caller can access the transfer resource.
        */
-      export interface SourceWallet {
+      export interface Transfer {
         /**
          * Related resource identifier
          */
-        data: SourceWallet.Data | null;
+        data: Transfer.Data;
       }
 
-      export namespace SourceWallet {
+      export namespace Transfer {
         /**
          * Related resource identifier
          */