@whop/sdk 0.0.9 → 0.0.10

package/resources/setup-intents.d.mts

@@ -0,0 +1,359 @@
+import { APIResource } from "../core/resource.mjs";
+import * as PaymentsAPI from "./payments.mjs";
+import * as Shared from "./shared.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class SetupIntents extends APIResource {
+    /**
+     * Retrieves a Setup Intent by ID
+     *
+     * Required permissions:
+     *
+     * - `payment:setup_intent:read`
+     * - `member:basic:read`
+     * - `member:email:read`
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<SetupIntent>;
+    /**
+     * Lists Setup Intents
+     *
+     * Required permissions:
+     *
+     * - `payment:setup_intent:read`
+     * - `member:basic:read`
+     * - `member:email:read`
+     */
+    list(query: SetupIntentListParams, options?: RequestOptions): PagePromise<SetupIntentListResponsesCursorPage, SetupIntentListResponse>;
+}
+export type SetupIntentListResponsesCursorPage = CursorPage<SetupIntentListResponse>;
+/**
+ * An object representing a setup intent, which is a flow for allowing a customer
+ * to add a payment method to their account without making a purchase.
+ */
+export interface SetupIntent {
+    /**
+     * The setup intent ID
+     */
+    id: string;
+    /**
+     * The checkout configuration associated with the setup intent
+     */
+    checkout_configuration: SetupIntent.CheckoutConfiguration | null;
+    /**
+     * The company of the setup intent
+     */
+    company: SetupIntent.Company | null;
+    /**
+     * The datetime the payment was created
+     */
+    created_at: string;
+    /**
+     * The error message, if any.
+     */
+    error_message: string | null;
+    /**
+     * The member connected to the setup intent
+     */
+    member: SetupIntent.Member | null;
+    /**
+     * The metadata associated with the setup intent
+     */
+    metadata: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The payment token created during the setup, if available.
+     */
+    payment_token: SetupIntent.PaymentToken | null;
+    /**
+     * The status of the setup intent
+     */
+    status: SetupIntentStatus;
+}
+export declare namespace SetupIntent {
+    /**
+     * The checkout configuration associated with the setup intent
+     */
+    interface CheckoutConfiguration {
+        /**
+         * The ID of the checkout configuration
+         */
+        id: string;
+    }
+    /**
+     * The company of the setup intent
+     */
+    interface Company {
+        /**
+         * The ID (tag) of the company.
+         */
+        id: string;
+    }
+    /**
+     * The member connected to the setup intent
+     */
+    interface Member {
+        /**
+         * The ID of the member
+         */
+        id: string;
+        /**
+         * The user for this member, if any.
+         */
+        user: Member.User | null;
+    }
+    namespace Member {
+        /**
+         * The user for this member, if any.
+         */
+        interface User {
+            /**
+             * The internal ID of the user account.
+             */
+            id: string;
+            /**
+             * The digital mailing address of the user.
+             */
+            email: string | null;
+            /**
+             * The user's full name.
+             */
+            name: string | null;
+            /**
+             * The whop username.
+             */
+            username: string;
+        }
+    }
+    /**
+     * The payment token created during the setup, if available.
+     */
+    interface PaymentToken {
+        /**
+         * The ID of the payment token
+         */
+        id: string;
+        /**
+         * The card data associated with the payment token, if its a debit or credit card
+         * token.
+         */
+        card: PaymentToken.Card | null;
+        /**
+         * The date and time the payment token was created
+         */
+        created_at: string;
+        /**
+         * The payment method type of the payment token
+         */
+        payment_method_type: PaymentsAPI.PaymentMethodTypes;
+    }
+    namespace PaymentToken {
+        /**
+         * The card data associated with the payment token, if its a debit or credit card
+         * token.
+         */
+        interface Card {
+            /**
+             * Possible card brands that a payment token can have
+             */
+            brand: PaymentsAPI.CardBrands | null;
+            /**
+             * Card expiration month, like 03 for March.
+             */
+            exp_month: number | null;
+            /**
+             * Card expiration year, like 27 for 2027.
+             */
+            exp_year: number | null;
+            /**
+             * Last four digits of the card.
+             */
+            last4: string | null;
+        }
+    }
+}
+/**
+ * The status of the setup intent.
+ */
+export type SetupIntentStatus = 'processing' | 'succeeded' | 'canceled' | 'requires_action';
+/**
+ * An object representing a setup intent, which is a flow for allowing a customer
+ * to add a payment method to their account without making a purchase.
+ */
+export interface SetupIntentListResponse {
+    /**
+     * The setup intent ID
+     */
+    id: string;
+    /**
+     * The checkout configuration associated with the setup intent
+     */
+    checkout_configuration: SetupIntentListResponse.CheckoutConfiguration | null;
+    /**
+     * The company of the setup intent
+     */
+    company: SetupIntentListResponse.Company | null;
+    /**
+     * The datetime the payment was created
+     */
+    created_at: string;
+    /**
+     * The error message, if any.
+     */
+    error_message: string | null;
+    /**
+     * The member connected to the setup intent
+     */
+    member: SetupIntentListResponse.Member | null;
+    /**
+     * The metadata associated with the setup intent
+     */
+    metadata: {
+        [key: string]: unknown;
+    } | null;
+    /**
+     * The payment token created during the setup, if available.
+     */
+    payment_token: SetupIntentListResponse.PaymentToken | null;
+    /**
+     * The status of the setup intent
+     */
+    status: SetupIntentStatus;
+}
+export declare namespace SetupIntentListResponse {
+    /**
+     * The checkout configuration associated with the setup intent
+     */
+    interface CheckoutConfiguration {
+        /**
+         * The ID of the checkout configuration
+         */
+        id: string;
+    }
+    /**
+     * The company of the setup intent
+     */
+    interface Company {
+        /**
+         * The ID (tag) of the company.
+         */
+        id: string;
+    }
+    /**
+     * The member connected to the setup intent
+     */
+    interface Member {
+        /**
+         * The ID of the member
+         */
+        id: string;
+        /**
+         * The user for this member, if any.
+         */
+        user: Member.User | null;
+    }
+    namespace Member {
+        /**
+         * The user for this member, if any.
+         */
+        interface User {
+            /**
+             * The internal ID of the user account.
+             */
+            id: string;
+            /**
+             * The digital mailing address of the user.
+             */
+            email: string | null;
+            /**
+             * The user's full name.
+             */
+            name: string | null;
+            /**
+             * The whop username.
+             */
+            username: string;
+        }
+    }
+    /**
+     * The payment token created during the setup, if available.
+     */
+    interface PaymentToken {
+        /**
+         * The ID of the payment token
+         */
+        id: string;
+        /**
+         * The card data associated with the payment token, if its a debit or credit card
+         * token.
+         */
+        card: PaymentToken.Card | null;
+        /**
+         * The date and time the payment token was created
+         */
+        created_at: string;
+        /**
+         * The payment method type of the payment token
+         */
+        payment_method_type: PaymentsAPI.PaymentMethodTypes;
+    }
+    namespace PaymentToken {
+        /**
+         * The card data associated with the payment token, if its a debit or credit card
+         * token.
+         */
+        interface Card {
+            /**
+             * Possible card brands that a payment token can have
+             */
+            brand: PaymentsAPI.CardBrands | null;
+            /**
+             * Card expiration month, like 03 for March.
+             */
+            exp_month: number | null;
+            /**
+             * Card expiration year, like 27 for 2027.
+             */
+            exp_year: number | null;
+            /**
+             * Last four digits of the card.
+             */
+            last4: string | null;
+        }
+    }
+}
+export interface SetupIntentListParams extends CursorPageParams {
+    /**
+     * The ID of the company to list setup intents for
+     */
+    company_id: string;
+    /**
+     * Returns the elements in the list that come before the specified cursor.
+     */
+    before?: string | null;
+    /**
+     * The minimum creation date to filter by
+     */
+    created_after?: string | null;
+    /**
+     * The maximum creation date to filter by
+     */
+    created_before?: string | null;
+    /**
+     * The direction of the sort.
+     */
+    direction?: Shared.Direction | null;
+    /**
+     * Returns the first _n_ elements from the list.
+     */
+    first?: number | null;
+    /**
+     * Returns the last _n_ elements from the list.
+     */
+    last?: number | null;
+}
+export declare namespace SetupIntents {
+    export { type SetupIntent as SetupIntent, type SetupIntentStatus as SetupIntentStatus, type SetupIntentListResponse as SetupIntentListResponse, type SetupIntentListResponsesCursorPage as SetupIntentListResponsesCursorPage, type SetupIntentListParams as SetupIntentListParams, };
+}
+//# sourceMappingURL=setup-intents.d.mts.map

package/resources/setup-intents.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-intents.d.mts","sourceRoot":"","sources":["../src/resources/setup-intents.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIvE;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,uBAAuB,CAAC;CAM5E;AAED,MAAM,MAAM,kCAAkC,GAAG,UAAU,CAAC,uBAAuB,CAAC,CAAC;AAErF;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,sBAAsB,EAAE,WAAW,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAEjE;;OAEG;IACH,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC,MAAM,GAAG,IAAI,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,aAAa,EAAE,WAAW,CAAC,YAAY,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;CAC3B;AAED,yBAAiB,WAAW,CAAC;IAC3B;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;KAC1B;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,IAAI,EAAE,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,mBAAmB,EAAE,WAAW,CAAC,kBAAkB,CAAC;KACrD;IAED,UAAiB,YAAY,CAAC;QAC5B;;;WAGG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,KAAK,EAAE,WAAW,CAAC,UAAU,GAAG,IAAI,CAAC;YAErC;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,WAAW,GAAG,UAAU,GAAG,iBAAiB,CAAC;AAE5F;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,sBAAsB,EAAE,uBAAuB,CAAC,qBAAqB,GAAG,IAAI,CAAC;IAE7E;;OAEG;IACH,OAAO,EAAE,uBAAuB,CAAC,OAAO,GAAG,IAAI,CAAC;IAEhD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,uBAAuB,CAAC,MAAM,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,aAAa,EAAE,uBAAuB,CAAC,YAAY,GAAG,IAAI,CAAC;IAE3D;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;CAC3B;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;KAC1B;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;YAErB;;eAEG;YACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YAEpB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,IAAI,EAAE,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,mBAAmB,EAAE,WAAW,CAAC,kBAAkB,CAAC;KACrD;IAED,UAAiB,YAAY,CAAC;QAC5B;;;WAGG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,KAAK,EAAE,WAAW,CAAC,UAAU,GAAG,IAAI,CAAC;YAErC;;eAEG;YACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;YAEzB;;eAEG;YACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB;;eAEG;YACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}