@flarcos/arazzo-sdk 0.1.0

package/dist/generated/open-payments-client.d.ts

@@ -0,0 +1,283 @@
+/**
+ * Open Payments Arazzo SDK — Auto-generated workflow functions
+ *
+ * Generated from Arazzo 1.0.1 workflow specifications.
+ * Do not edit manually — regenerate with: arazzo-sdk generate
+ *
+ * @generated
+ */
+import type { WorkflowResult, AuthProvider, GnapAuthConfig, ExecutionHooks, InteractionHandler } from '../runtime/types.js';
+/** Open Payments amount object */
+export interface Amount {
+    /** Amount in minor units (e.g., "2500" for $25.00) */
+    value: string;
+    /** Currency code (e.g., "USD") */
+    assetCode: string;
+    /** Asset scale (e.g., 2 for cents) */
+    assetScale: number;
+}
+export interface ListIncomingPaymentsInputs {
+    /** The wallet address to list incoming payments for */
+    walletAddressUrl: string;
+    /** The client's wallet address for GNAP identification */
+    clientWalletAddress: string;
+    /** Number of results to return (forward pagination) */
+    first?: number;
+    /** Pagination cursor from a previous response */
+    cursor?: string;
+}
+export interface ListIncomingPaymentsOutputs {
+    /** Resolved from: $steps.listIncomingPayments.outputs.incomingPayments */
+    incomingPayments: unknown;
+    /** Resolved from: $steps.listIncomingPayments.outputs.paginationEndCursor */
+    nextCursor: unknown;
+    /** Resolved from: $steps.listIncomingPayments.outputs.hasNextPage */
+    hasNextPage: boolean;
+}
+export interface ListOutgoingPaymentsInputs {
+    /** The wallet address to list outgoing payments for */
+    walletAddressUrl: string;
+    /** The client's wallet address for GNAP identification */
+    clientWalletAddress: string;
+    /** Number of results to return */
+    first?: number;
+    /** Pagination cursor */
+    cursor?: string;
+}
+export interface ListOutgoingPaymentsOutputs {
+    /** Resolved from: $steps.listOutgoingPayments.outputs.outgoingPayments */
+    outgoingPayments: unknown;
+    /** Resolved from: $steps.listOutgoingPayments.outputs.paginationEndCursor */
+    nextCursor: unknown;
+    /** Resolved from: $steps.listOutgoingPayments.outputs.hasNextPage */
+    hasNextPage: boolean;
+}
+export interface GetPaymentDetailsInputs {
+    /** Wallet address URL */
+    walletAddressUrl: string;
+    /** Client's wallet address */
+    clientWalletAddress: string;
+    /** ID of the incoming payment to retrieve */
+    incomingPaymentId?: string;
+    /** ID of the outgoing payment to retrieve */
+    outgoingPaymentId?: string;
+}
+export interface GetPaymentDetailsOutputs {
+    /** Resolved from: $steps.getIncomingPayment.outputs.incomingPayment */
+    incomingPayment: unknown;
+    /** Resolved from: $steps.getOutgoingPayment.outputs.outgoingPayment */
+    outgoingPayment: unknown;
+}
+export interface RotateAccessTokenInputs {
+    /** The `manage` URL of the access token to rotate. This was provided in the original grant response as `access_token.manage`.
+   */
+    tokenManageUrl: string;
+}
+export interface RotateAccessTokenOutputs {
+    /** Resolved from: $steps.rotateToken.outputs.newAccessTokenValue */
+    accessToken: string;
+    /** Resolved from: $steps.rotateToken.outputs.newManageUrl */
+    manageUrl: string;
+    /** Resolved from: $steps.rotateToken.outputs.expiresIn */
+    expiresIn: string;
+}
+export interface RevokeAccessTokenInputs {
+    /** The `manage` URL of the access token to revoke.
+   */
+    tokenManageUrl: string;
+}
+export interface CancelGrantInputs {
+    /** The continuation URI from the original grant response (`continue.uri`).
+   */
+    continueUri: string;
+}
+export interface SetupRecurringPaymentInputs {
+    /** Recipient's wallet address URL */
+    recipientWalletAddressUrl: string;
+    /** Sender's wallet address URL */
+    senderWalletAddressUrl: string;
+    /** Maximum debit amount per interval (minor units) */
+    debitAmountPerInterval: string;
+    /** Currency code (e.g. USD) */
+    debitAssetCode: string;
+    /** Asset scale (e.g. 2) */
+    debitAssetScale: number;
+    /** ISO 8601 repeating interval (e.g. 'R12/2024-01-01T00:00:00Z/P1M' for 12 monthly periods starting Jan 1 2024)
+   */
+    interval: string;
+    /** Client's wallet address */
+    clientWalletAddress: string;
+    /** Redirect URI after interaction */
+    finishUri?: string;
+    /** Unique nonce for the finish step */
+    finishNonce?: string;
+}
+export interface SetupRecurringPaymentOutputs {
+    /** Resolved from: $steps.continueRecurringGrant.outputs.outgoingPaymentAccessToken */
+    outgoingPaymentAccessToken: string;
+    /** Resolved from: $steps.continueRecurringGrant.outputs.outgoingPaymentManageUrl */
+    outgoingPaymentManageUrl: string;
+    /** Resolved from: $steps.createOutgoingPayment.outputs.outgoingPaymentId */
+    firstPaymentId: string;
+    /** Resolved from: $steps.createIncomingPayment.outputs.incomingPaymentUrl */
+    incomingPaymentUrl: string;
+}
+export interface OneTimePaymentFixedSendInputs {
+    /** The recipient's wallet address URL */
+    recipientWalletAddressUrl: string;
+    /** The sender's wallet address URL */
+    senderWalletAddressUrl: string;
+    /** Amount to debit in minor units (e.g. '2500' for $25.00 with scale 2) */
+    debitAmount: string;
+    /** Currency code of the sender's asset (e.g. USD) */
+    debitAssetCode: string;
+    /** Asset scale (e.g. 2 for USD cents) */
+    debitAssetScale: number;
+    /** The client's wallet address for GNAP identification */
+    clientWalletAddress: string;
+    /** URI to redirect the user to after interaction */
+    finishUri?: string;
+    /** Unique nonce for the interaction finish */
+    finishNonce?: string;
+}
+export interface OneTimePaymentFixedSendOutputs {
+    /** Resolved from: $steps.createIncomingPayment.outputs.incomingPaymentUrl */
+    incomingPaymentUrl: string;
+    /** Resolved from: $steps.createQuote.outputs.quoteId */
+    quoteId: string;
+    /** Resolved from: $steps.createOutgoingPayment.outputs.outgoingPaymentId */
+    outgoingPaymentId: string;
+    /** Resolved from: $steps.createQuote.outputs.debitAmount */
+    debitAmount: Amount;
+    /** Resolved from: $steps.createQuote.outputs.receiveAmount */
+    receiveAmount: Amount;
+}
+export interface OneTimePaymentFixedReceiveInputs {
+    /** The recipient's wallet address URL (e.g. https://wallet.example.com/alice) */
+    recipientWalletAddressUrl: string;
+    /** The sender's wallet address URL (e.g. https://wallet.example.com/bob) */
+    senderWalletAddressUrl: string;
+    /** Amount to receive in minor units (e.g. '2500' for $25.00 with scale 2) */
+    amount: string;
+    /** Currency code (e.g. USD) */
+    assetCode: string;
+    /** Asset scale (e.g. 2 for USD cents) */
+    assetScale: number;
+    /** The client's wallet address for GNAP identification */
+    clientWalletAddress: string;
+    /** URI to redirect the user to after interaction (optional, defaults to client callback) */
+    finishUri?: string;
+    /** Unique nonce for the interaction finish (optional) */
+    finishNonce?: string;
+}
+export interface OneTimePaymentFixedReceiveOutputs {
+    /** Resolved from: $steps.createIncomingPayment.outputs.incomingPaymentUrl */
+    incomingPaymentUrl: string;
+    /** Resolved from: $steps.createQuote.outputs.quoteId */
+    quoteId: string;
+    /** Resolved from: $steps.createOutgoingPayment.outputs.outgoingPaymentId */
+    outgoingPaymentId: string;
+    /** Resolved from: $steps.createQuote.outputs.debitAmount */
+    debitAmount: Amount;
+    /** Resolved from: $steps.createQuote.outputs.receiveAmount */
+    receiveAmount: Amount;
+}
+/**
+ * OpenPaymentsClient — typed workflow executor for Open Payments API.
+ *
+ * Usage:
+ * ```typescript
+ * const client = new OpenPaymentsClient({
+ *   clientWalletAddress: 'https://wallet.example.com/me',
+ *   serverUrls: {
+ *     walletAddressServer: 'https://wallet.example.com',
+ *     resourceServer: 'https://wallet.example.com',
+ *     authServer: 'https://auth.wallet.example.com',
+ *   },
+ * });
+ *
+ * const result = await client.oneTimePaymentFixedReceive({ ... });
+ * ```
+ */
+export declare class OpenPaymentsClient {
+    private serverUrls;
+    private authProvider?;
+    private hooks?;
+    private interactionHandler?;
+    constructor(options: {
+        /** Base URLs for each source description */
+        serverUrls: Record<string, string>;
+        /** GNAP auth configuration */
+        gnapConfig?: GnapAuthConfig;
+        /** Custom auth provider (overrides gnapConfig) */
+        authProvider?: AuthProvider;
+        /** Execution hooks for monitoring */
+        hooks?: ExecutionHooks;
+        /**
+         * Handler for interactive GNAP grants requiring user consent.
+         * Called when a workflow step returns an interact.redirect URL.
+         * Must return the interact_ref from the redirect callback.
+         */
+        interactionHandler?: InteractionHandler;
+    });
+    /**
+     * Set the GNAP access token for a source.
+     * Call this after obtaining tokens from grant requests.
+     */
+    setToken(sourceName: string, token: string): void;
+    /**
+     * List all incoming payments on a wallet address
+     */
+    listIncomingPayments(inputs: ListIncomingPaymentsInputs): Promise<ListIncomingPaymentsOutputs & {
+        _raw: WorkflowResult;
+    }>;
+    /**
+     * List all outgoing payments on a wallet address
+     */
+    listOutgoingPayments(inputs: ListOutgoingPaymentsInputs): Promise<ListOutgoingPaymentsOutputs & {
+        _raw: WorkflowResult;
+    }>;
+    /**
+     * Get details of a specific incoming or outgoing payment
+     */
+    getPaymentDetails(inputs: GetPaymentDetailsInputs): Promise<GetPaymentDetailsOutputs & {
+        _raw: WorkflowResult;
+    }>;
+    /**
+     * Rotate an existing GNAP access token
+     */
+    rotateAccessToken(inputs: RotateAccessTokenInputs): Promise<RotateAccessTokenOutputs & {
+        _raw: WorkflowResult;
+    }>;
+    /**
+     * Revoke an active GNAP access token
+     */
+    revokeAccessToken(inputs: RevokeAccessTokenInputs): Promise<Record<string, unknown> & {
+        _raw: WorkflowResult;
+    }>;
+    /**
+     * Cancel an active GNAP grant
+     */
+    cancelGrant(inputs: CancelGrantInputs): Promise<Record<string, unknown> & {
+        _raw: WorkflowResult;
+    }>;
+    /**
+     * Set up a recurring payment grant with interval limits
+     */
+    setupRecurringPayment(inputs: SetupRecurringPaymentInputs): Promise<SetupRecurringPaymentOutputs & {
+        _raw: WorkflowResult;
+    }>;
+    /**
+     * One-time payment with a fixed send (debit) amount
+     */
+    oneTimePaymentFixedSend(inputs: OneTimePaymentFixedSendInputs): Promise<OneTimePaymentFixedSendOutputs & {
+        _raw: WorkflowResult;
+    }>;
+    /**
+     * One-time payment with a fixed receive amount
+     */
+    oneTimePaymentFixedReceive(inputs: OneTimePaymentFixedReceiveInputs): Promise<OneTimePaymentFixedReceiveOutputs & {
+        _raw: WorkflowResult;
+    }>;
+}
+//# sourceMappingURL=open-payments-client.d.ts.map

package/dist/generated/open-payments-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"open-payments-client.d.ts","sourceRoot":"","sources":["../../src/generated/open-payments-client.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAEV,cAAc,EACd,YAAY,EACZ,cAAc,EACd,cAAc,EACd,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAM7B,kCAAkC;AAClC,MAAM,WAAW,MAAM;IACrB,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,UAAU,EAAE,MAAM,CAAC;CACpB;AAGD,MAAM,WAAW,0BAA0B;IACzC,uDAAuD;IACvD,gBAAgB,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,mBAAmB,EAAE,MAAM,CAAC;IAC5B,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C,0EAA0E;IAC1E,gBAAgB,EAAE,OAAO,CAAC;IAC1B,6EAA6E;IAC7E,UAAU,EAAE,OAAO,CAAC;IACpB,qEAAqE;IACrE,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACzC,uDAAuD;IACvD,gBAAgB,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C,0EAA0E;IAC1E,gBAAgB,EAAE,OAAO,CAAC;IAC1B,6EAA6E;IAC7E,UAAU,EAAE,OAAO,CAAC;IACpB,qEAAqE;IACrE,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,uBAAuB;IACtC,yBAAyB;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,8BAA8B;IAC9B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,6CAA6C;IAC7C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,6CAA6C;IAC7C,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,wBAAwB;IACvC,uEAAuE;IACvE,eAAe,EAAE,OAAO,CAAC;IACzB,uEAAuE;IACvE,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,uBAAuB;IACtC;KACC;IACD,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC,oEAAoE;IACpE,WAAW,EAAE,MAAM,CAAC;IACpB,6DAA6D;IAC7D,SAAS,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC;KACC;IACD,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC;KACC;IACD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,2BAA2B;IAC1C,qCAAqC;IACrC,yBAAyB,EAAE,MAAM,CAAC;IAClC,kCAAkC;IAClC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,sDAAsD;IACtD,sBAAsB,EAAE,MAAM,CAAC;IAC/B,+BAA+B;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,2BAA2B;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB;KACC;IACD,QAAQ,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,qCAAqC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uCAAuC;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,4BAA4B;IAC3C,sFAAsF;IACtF,0BAA0B,EAAE,MAAM,CAAC;IACnC,oFAAoF;IACpF,wBAAwB,EAAE,MAAM,CAAC;IACjC,4EAA4E;IAC5E,cAAc,EAAE,MAAM,CAAC;IACvB,6EAA6E;IAC7E,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,6BAA6B;IAC5C,yCAAyC;IACzC,yBAAyB,EAAE,MAAM,CAAC;IAClC,sCAAsC;IACtC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,2EAA2E;IAC3E,WAAW,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,cAAc,EAAE,MAAM,CAAC;IACvB,yCAAyC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,0DAA0D;IAC1D,mBAAmB,EAAE,MAAM,CAAC;IAC5B,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8CAA8C;IAC9C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,8BAA8B;IAC7C,6EAA6E;IAC7E,kBAAkB,EAAE,MAAM,CAAC;IAC3B,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAC;IAChB,4EAA4E;IAC5E,iBAAiB,EAAE,MAAM,CAAC;IAC1B,4DAA4D;IAC5D,WAAW,EAAE,MAAM,CAAC;IACpB,8DAA8D;IAC9D,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,gCAAgC;IAC/C,iFAAiF;IACjF,yBAAyB,EAAE,MAAM,CAAC;IAClC,4EAA4E;IAC5E,sBAAsB,EAAE,MAAM,CAAC;IAC/B,6EAA6E;IAC7E,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,0DAA0D;IAC1D,mBAAmB,EAAE,MAAM,CAAC;IAC5B,4FAA4F;IAC5F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iCAAiC;IAChD,6EAA6E;IAC7E,kBAAkB,EAAE,MAAM,CAAC;IAC3B,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAC;IAChB,4EAA4E;IAC5E,iBAAiB,EAAE,MAAM,CAAC;IAC1B,4DAA4D;IAC5D,WAAW,EAAE,MAAM,CAAC;IACpB,8DAA8D;IAC9D,aAAa,EAAE,MAAM,CAAC;CACvB;AAGD;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,UAAU,CAAyB;IAC3C,OAAO,CAAC,YAAY,CAAC,CAAe;IACpC,OAAO,CAAC,KAAK,CAAC,CAAiB;IAC/B,OAAO,CAAC,kBAAkB,CAAC,CAAqB;gBAEpC,OAAO,EAAE;QACnB,4CAA4C;QAC5C,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACnC,8BAA8B;QAC9B,UAAU,CAAC,EAAE,cAAc,CAAC;QAC5B,kDAAkD;QAClD,YAAY,CAAC,EAAE,YAAY,CAAC;QAC5B,qCAAqC;QACrC,KAAK,CAAC,EAAE,cAAc,CAAC;QACvB;;;;WAIG;QACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;KACzC;IAYD;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAOjD;;OAEG;IACG,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,2BAA2B,GAAG;QAAE,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC;IA0I/H;;OAEG;IACG,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,2BAA2B,GAAG;QAAE,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC;IAwI/H;;OAEG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,GAAG;QAAE,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC;IAqJtH;;OAEG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,GAAG;QAAE,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC;IAsEtH;;OAEG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QAAE,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC;IA4DrH;;OAEG;IACG,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QAAE,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC;IA4DzG;;OAEG;IACG,qBAAqB,CAAC,MAAM,EAAE,2BAA2B,GAAG,OAAO,CAAC,4BAA4B,GAAG;QAAE,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC;IAkUlI;;OAEG;IACG,uBAAuB,CAAC,MAAM,EAAE,6BAA6B,GAAG,OAAO,CAAC,8BAA8B,GAAG;QAAE,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC;IA0TxI;;OAEG;IACG,0BAA0B,CAAC,MAAM,EAAE,gCAAgC,GAAG,OAAO,CAAC,iCAAiC,GAAG;QAAE,IAAI,EAAE,cAAc,CAAA;KAAE,CAAC;CAgUlJ"}