@naturalpay/sdk 0.2.0 → 0.2.1

package/src/resources/counterparties.ts

@@ -0,0 +1,187 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Counterparty management
+ */
+export class Counterparties extends APIResource {
+  /**
+   * Returns one row per counterparty with sent and received aggregates. Either side
+   * may be null when there are no payments in that direction. Pass direction=sent or
+   * direction=received to scope the list (and its pagination) to one side.
+   */
+  list(
+    params: CounterpartyListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CounterpartyListResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
+    return this._client.get('/counterparties', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface CounterpartyListResponse {
+  data: Array<CounterpartyListResponse.Data>;
+
+  meta: CounterpartyListResponse.Meta;
+}
+
+export namespace CounterpartyListResponse {
+  export interface Data {
+    /**
+     * Counterparty ID: a party id (pty_xxx), or unknown_xxx for unclaimed payments
+     */
+    id: string;
+
+    /**
+     * Counterparty attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Counterparty attributes
+     */
+    export interface Attributes {
+      /**
+       * Counterparty primary email
+       */
+      partyEmail: string | null;
+
+      /**
+       * Party ID (pty_xxx) - null for unclaimed payments
+       */
+      partyId: string | null;
+
+      /**
+       * Counterparty display name
+       */
+      partyName: string | null;
+
+      /**
+       * Counterparty party status
+       */
+      partyStatus: 'PROVISIONAL' | 'ACTIVE' | 'SUSPENDED' | 'INACTIVE' | null;
+
+      /**
+       * Aggregates for payments you received from this counterparty. Null if none.
+       */
+      received: Attributes.Received | null;
+
+      /**
+       * Aggregates for payments you sent to this counterparty. Null if none.
+       */
+      sent: Attributes.Sent | null;
+    }
+
+    export namespace Attributes {
+      /**
+       * Aggregates for payments you received from this counterparty. Null if none.
+       */
+      export interface Received {
+        /**
+         * Timestamp of first payment in this direction
+         */
+        firstAt: string;
+
+        /**
+         * Total amount in this direction, minor units (cents)
+         */
+        totalAmountMinor: number;
+
+        /**
+         * Number of payments in this direction
+         */
+        transactionCount: number;
+      }
+
+      /**
+       * Aggregates for payments you sent to this counterparty. Null if none.
+       */
+      export interface Sent {
+        /**
+         * Timestamp of first payment in this direction
+         */
+        firstAt: string;
+
+        /**
+         * Total amount in this direction, minor units (cents)
+         */
+        totalAmountMinor: number;
+
+        /**
+         * Number of payments in this direction
+         */
+        transactionCount: number;
+      }
+    }
+  }
+
+  export interface Meta {
+    pagination: Meta.Pagination;
+  }
+
+  export namespace Meta {
+    export interface Pagination {
+      hasMore: boolean;
+
+      nextCursor: string | null;
+    }
+  }
+}
+
+export interface CounterpartyListParams {
+  /**
+   * Query param: Cursor for pagination
+   */
+  cursor?: string;
+
+  /**
+   * Query param: Optional filter. When set, only counterparties with activity in
+   * that direction are returned, and pagination is scoped to that subset. Omit to
+   * return every counterparty.
+   */
+  direction?: 'sent' | 'received';
+
+  /**
+   * Query param: Maximum number of results
+   */
+  limit?: number;
+
+  /**
+   * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
+   */
+  'X-Agent-ID'?: string;
+
+  /**
+   * Header param: Required when X-Agent-ID is present. Session or conversation ID
+   * for agent observability.
+   */
+  'X-Instance-ID'?: string;
+}
+
+export declare namespace Counterparties {
+  export {
+    type CounterpartyListResponse as CounterpartyListResponse,
+    type CounterpartyListParams as CounterpartyListParams,
+  };
+}

package/src/resources/customers.ts

@@ -0,0 +1,365 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Customer management
+ */
+export class Customers extends APIResource {
+  /**
+   * List active customers you can operate on behalf of.
+   */
+  list(
+    params: CustomerListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomerListResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
+    return this._client.get('/customers', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+
+  /**
+   * List the pending customer invitations you've sent — agent invitations grouped by
+   * recipient.
+   */
+  listInvitations(
+    params: CustomerListInvitationsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomerListInvitationsResponse> {
+    const { 'X-Agent-ID': xAgentID, 'X-Instance-ID': xInstanceID, ...query } = params ?? {};
+    return this._client.get('/customers/invitations', {
+      query,
+      ...options,
+      headers: buildHeaders([
+        {
+          ...(xAgentID != null ? { 'X-Agent-ID': xAgentID } : undefined),
+          ...(xInstanceID != null ? { 'X-Instance-ID': xInstanceID } : undefined),
+        },
+        options?.headers,
+      ]),
+    });
+  }
+}
+
+export interface CustomerListResponse {
+  data: Array<CustomerListResponse.Data>;
+
+  meta: CustomerListResponse.Meta;
+}
+
+export namespace CustomerListResponse {
+  /**
+   * Customer resource for an active customer (type='customer', id=pty_xxx).
+   */
+  export interface Data {
+    /**
+     * Customer party handle (pty_xxx)
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export interface Attributes {
+      /**
+       * When the delegation was created
+       */
+      createdAt: string;
+
+      /**
+       * Customer email, if known
+       */
+      email: string | null;
+
+      /**
+       * Party info
+       */
+      party: Attributes.Party;
+
+      /**
+       * Granted permissions
+       */
+      permissions: Array<string>;
+
+      /**
+       * Status (ACTIVE, etc.)
+       */
+      status: string;
+
+      /**
+       * Why walletAvailableMinor may be null: "granted" balance is fresh; "denied"
+       * caller lacks wallets.read; "noWallet" party has not provisioned a wallet.
+       */
+      walletAccess: 'granted' | 'denied' | 'noWallet';
+
+      /**
+       * Available wallet balance in cents. Null when access is denied or no wallet
+       * exists — see walletAccess.
+       */
+      walletAvailableMinor: number | null;
+    }
+
+    export namespace Attributes {
+      /**
+       * Party info
+       */
+      export interface Party {
+        /**
+         * Party handle (pty_xxx)
+         */
+        id: string;
+
+        /**
+         * Primary email
+         */
+        email: string | null;
+
+        /**
+         * Display name, falling back to legal name when display name is unset
+         */
+        name: string;
+      }
+    }
+  }
+
+  export interface Meta {
+    pagination: Meta.Pagination;
+  }
+
+  export namespace Meta {
+    export interface Pagination {
+      hasMore: boolean;
+
+      nextCursor: string | null;
+    }
+  }
+}
+
+export interface CustomerListInvitationsResponse {
+  data: Array<CustomerListInvitationsResponse.Data>;
+
+  meta: CustomerListInvitationsResponse.Meta;
+}
+
+export namespace CustomerListInvitationsResponse {
+  /**
+   * A pending customer invitation (type='customerInvitation', id=recipient email) —
+   * a grouping of agent invitations sent to one recipient.
+   */
+  export interface Data {
+    /**
+     * Recipient email — the grouping key for the pending invitation. Stays the id even
+     * after the recipient creates an account.
+     */
+    id: string;
+
+    /**
+     * Resource attributes
+     */
+    attributes: Data.Attributes;
+
+    /**
+     * Resource type
+     */
+    type: string;
+  }
+
+  export namespace Data {
+    /**
+     * Resource attributes
+     */
+    export interface Attributes {
+      /**
+       * Pending agent delegation invitations sent to this recipient
+       */
+      agentInvitations: Array<Attributes.AgentInvitation>;
+
+      /**
+       * When the earliest agent invitation was created
+       */
+      createdAt: string;
+
+      /**
+       * Recipient email — the grouping key
+       */
+      email: string;
+
+      /**
+       * Party info (null until the recipient creates an account)
+       */
+      party: Attributes.Party | null;
+
+      /**
+       * Status (always PENDING)
+       */
+      status: string;
+
+      /**
+       * Always 'denied' for pending customers
+       */
+      walletAccess: 'granted' | 'denied' | 'noWallet';
+
+      /**
+       * Always null for pending customers
+       */
+      walletAvailableMinor: number | null;
+    }
+
+    export namespace Attributes {
+      export interface AgentInvitation {
+        /**
+         * Agent the invitation targets
+         */
+        agent: AgentInvitation.Agent;
+
+        /**
+         * When the agent invitation was created
+         */
+        createdAt: string;
+
+        /**
+         * When the agent invitation expires (null if it does not expire)
+         */
+        expiresAt: string | null;
+
+        /**
+         * Agent delegation invitation handle (adi_xxx)
+         */
+        invitationId: string;
+
+        /**
+         * Permissions the invitation requests
+         */
+        permissions: Array<string>;
+      }
+
+      export namespace AgentInvitation {
+        /**
+         * Agent the invitation targets
+         */
+        export interface Agent {
+          /**
+           * Agent handle (agt_xxx)
+           */
+          id: string;
+
+          /**
+           * Agent display name
+           */
+          name: string | null;
+        }
+      }
+
+      /**
+       * Party info (null until the recipient creates an account)
+       */
+      export interface Party {
+        /**
+         * Party handle (pty_xxx)
+         */
+        id: string;
+
+        /**
+         * Primary email
+         */
+        email: string | null;
+
+        /**
+         * Display name, falling back to legal name when display name is unset
+         */
+        name: string;
+      }
+    }
+  }
+
+  export interface Meta {
+    pagination: Meta.Pagination;
+  }
+
+  export namespace Meta {
+    export interface Pagination {
+      hasMore: boolean;
+
+      nextCursor: string | null;
+    }
+  }
+}
+
+export interface CustomerListParams {
+  /**
+   * Query param: Cursor for pagination
+   */
+  cursor?: string;
+
+  /**
+   * Query param: Maximum number of results
+   */
+  limit?: number;
+
+  /**
+   * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
+   */
+  'X-Agent-ID'?: string;
+
+  /**
+   * Header param: Required when X-Agent-ID is present. Session or conversation ID
+   * for agent observability.
+   */
+  'X-Instance-ID'?: string;
+}
+
+export interface CustomerListInvitationsParams {
+  /**
+   * Query param: Cursor for pagination
+   */
+  cursor?: string;
+
+  /**
+   * Query param: Maximum number of results
+   */
+  limit?: number;
+
+  /**
+   * Header param: Agent ID (agt_xxx) identifying which agent is making the request.
+   */
+  'X-Agent-ID'?: string;
+
+  /**
+   * Header param: Required when X-Agent-ID is present. Session or conversation ID
+   * for agent observability.
+   */
+  'X-Instance-ID'?: string;
+}
+
+export declare namespace Customers {
+  export {
+    type CustomerListResponse as CustomerListResponse,
+    type CustomerListInvitationsResponse as CustomerListInvitationsResponse,
+    type CustomerListParams as CustomerListParams,
+    type CustomerListInvitationsParams as CustomerListInvitationsParams,
+  };
+}