@whop/sdk 0.0.9 → 0.0.10

package/src/resources/setup-intents.ts

@@ -0,0 +1,435 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as PaymentsAPI from './payments';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export 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> {
+    return this._client.get(path`/setup_intents/${id}`, options);
+  }
+
+  /**
+   * Lists Setup Intents
+   *
+   * Required permissions:
+   *
+   * - `payment:setup_intent:read`
+   * - `member:basic:read`
+   * - `member:email:read`
+   */
+  list(
+    query: SetupIntentListParams,
+    options?: RequestOptions,
+  ): PagePromise<SetupIntentListResponsesCursorPage, SetupIntentListResponse> {
+    return this._client.getAPIList('/setup_intents', CursorPage<SetupIntentListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+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 namespace SetupIntent {
+  /**
+   * The checkout configuration associated with the setup intent
+   */
+  export interface CheckoutConfiguration {
+    /**
+     * The ID of the checkout configuration
+     */
+    id: string;
+  }
+
+  /**
+   * The company of the setup intent
+   */
+  export interface Company {
+    /**
+     * The ID (tag) of the company.
+     */
+    id: string;
+  }
+
+  /**
+   * The member connected to the setup intent
+   */
+  export interface Member {
+    /**
+     * The ID of the member
+     */
+    id: string;
+
+    /**
+     * The user for this member, if any.
+     */
+    user: Member.User | null;
+  }
+
+  export namespace Member {
+    /**
+     * The user for this member, if any.
+     */
+    export 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.
+   */
+  export 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;
+  }
+
+  export namespace PaymentToken {
+    /**
+     * The card data associated with the payment token, if its a debit or credit card
+     * token.
+     */
+    export 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 namespace SetupIntentListResponse {
+  /**
+   * The checkout configuration associated with the setup intent
+   */
+  export interface CheckoutConfiguration {
+    /**
+     * The ID of the checkout configuration
+     */
+    id: string;
+  }
+
+  /**
+   * The company of the setup intent
+   */
+  export interface Company {
+    /**
+     * The ID (tag) of the company.
+     */
+    id: string;
+  }
+
+  /**
+   * The member connected to the setup intent
+   */
+  export interface Member {
+    /**
+     * The ID of the member
+     */
+    id: string;
+
+    /**
+     * The user for this member, if any.
+     */
+    user: Member.User | null;
+  }
+
+  export namespace Member {
+    /**
+     * The user for this member, if any.
+     */
+    export 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.
+   */
+  export 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;
+  }
+
+  export namespace PaymentToken {
+    /**
+     * The card data associated with the payment token, if its a debit or credit card
+     * token.
+     */
+    export 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,
+  };
+}

package/src/resources/shared.ts

@@ -2173,6 +2173,11 @@ export interface Payment {
    */
   payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
 
+  /**
+   * The payment token used for the payment, if available.
+   */
+  payment_token: Payment.PaymentToken | null;
+
   /**
    * The plan attached to this payment.
    */
@@ -2339,6 +2344,60 @@ export namespace Payment {
     status: Shared.MembershipStatus;
   }
 
+  /**
+   * The payment token used for the payment, if available.
+   */
+  export 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;
+  }
+
+  export namespace PaymentToken {
+    /**
+     * The card data associated with the payment token, if its a debit or credit card
+     * token.
+     */
+    export 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 plan attached to this payment.
    */

package/src/resources/webhooks.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../core/resource';
 import * as DisputesAPI from './disputes';
 import * as PaymentsAPI from './payments';
 import * as RefundsAPI from './refunds';
+import * as SetupIntentsAPI from './setup-intents';
 import * as Shared from './shared';
 import { Webhook } from 'standardwebhooks';
 
@@ -294,6 +295,90 @@ export interface EntryDeletedWebhookEvent {
   type: 'entry.deleted';
 }
 
+export interface SetupIntentRequiresActionWebhookEvent {
+  /**
+   * A unique ID for every single webhook request
+   */
+  id: string;
+
+  /**
+   * The API version for this webhook
+   */
+  api_version: 'v1';
+
+  /**
+   * 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.
+   */
+  data: SetupIntentsAPI.SetupIntent;
+
+  /**
+   * The timestamp in ISO 8601 format that the webhook was sent at on the server
+   */
+  timestamp: string;
+
+  /**
+   * The webhook event type
+   */
+  type: 'setup_intent.requires_action';
+}
+
+export interface SetupIntentSucceededWebhookEvent {
+  /**
+   * A unique ID for every single webhook request
+   */
+  id: string;
+
+  /**
+   * The API version for this webhook
+   */
+  api_version: 'v1';
+
+  /**
+   * 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.
+   */
+  data: SetupIntentsAPI.SetupIntent;
+
+  /**
+   * The timestamp in ISO 8601 format that the webhook was sent at on the server
+   */
+  timestamp: string;
+
+  /**
+   * The webhook event type
+   */
+  type: 'setup_intent.succeeded';
+}
+
+export interface SetupIntentCanceledWebhookEvent {
+  /**
+   * A unique ID for every single webhook request
+   */
+  id: string;
+
+  /**
+   * The API version for this webhook
+   */
+  api_version: 'v1';
+
+  /**
+   * 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.
+   */
+  data: SetupIntentsAPI.SetupIntent;
+
+  /**
+   * The timestamp in ISO 8601 format that the webhook was sent at on the server
+   */
+  timestamp: string;
+
+  /**
+   * The webhook event type
+   */
+  type: 'setup_intent.canceled';
+}
+
 export interface CourseLessonInteractionCompletedWebhookEvent {
   /**
    * A unique ID for every single webhook request
@@ -923,6 +1008,9 @@ export type UnwrapWebhookEvent =
   | EntryApprovedWebhookEvent
   | EntryDeniedWebhookEvent
   | EntryDeletedWebhookEvent
+  | SetupIntentRequiresActionWebhookEvent
+  | SetupIntentSucceededWebhookEvent
+  | SetupIntentCanceledWebhookEvent
   | CourseLessonInteractionCompletedWebhookEvent
   | PaymentSucceededWebhookEvent
   | PaymentFailedWebhookEvent
@@ -944,6 +1032,9 @@ export declare namespace Webhooks {
     type EntryApprovedWebhookEvent as EntryApprovedWebhookEvent,
     type EntryDeniedWebhookEvent as EntryDeniedWebhookEvent,
     type EntryDeletedWebhookEvent as EntryDeletedWebhookEvent,
+    type SetupIntentRequiresActionWebhookEvent as SetupIntentRequiresActionWebhookEvent,
+    type SetupIntentSucceededWebhookEvent as SetupIntentSucceededWebhookEvent,
+    type SetupIntentCanceledWebhookEvent as SetupIntentCanceledWebhookEvent,
     type CourseLessonInteractionCompletedWebhookEvent as CourseLessonInteractionCompletedWebhookEvent,
     type PaymentSucceededWebhookEvent as PaymentSucceededWebhookEvent,
     type PaymentFailedWebhookEvent as PaymentFailedWebhookEvent,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.9'; // x-release-please-version
+export const VERSION = '0.0.10'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.9";
+export declare const VERSION = "0.0.10";
 //# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.0.9";
+export declare const VERSION = "0.0.10";
 //# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.0.9'; // x-release-please-version
+exports.VERSION = '0.0.10'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.0.9'; // x-release-please-version
+export const VERSION = '0.0.10'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}