@whop/sdk 0.0.32 → 0.0.33

package/src/resources/payout-accounts.ts

@@ -0,0 +1,177 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as VerificationsAPI from './verifications';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Payout accounts
+ */
+export class PayoutAccounts extends APIResource {
+  /**
+   * Retrieves the details of an existing payout account.
+   *
+   * Required permissions:
+   *
+   * - `payout:account:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<PayoutAccountRetrieveResponse> {
+    return this._client.get(path`/payout_accounts/${id}`, options);
+  }
+}
+
+/**
+ * The granular calculated statuses reflecting payout account KYC and withdrawal
+ * readiness.
+ */
+export type PayoutAccountCalculatedStatuses =
+  | 'connected'
+  | 'disabled'
+  | 'action_required'
+  | 'pending_verification'
+  | 'verification_failed'
+  | 'not_started';
+
+/**
+ * An object representing an account used for payouts.
+ */
+export interface PayoutAccountRetrieveResponse {
+  /**
+   * The unique identifier for the payout account.
+   */
+  id: string;
+
+  /**
+   * The physical address associated with this payout account
+   */
+  address: PayoutAccountRetrieveResponse.Address | null;
+
+  /**
+   * The company's legal name
+   */
+  business_name: string | null;
+
+  /**
+   * The business representative for this payout account
+   */
+  business_representative: PayoutAccountRetrieveResponse.BusinessRepresentative | null;
+
+  /**
+   * The email address of the representative
+   */
+  email: string | null;
+
+  /**
+   * The latest verification for the connected account.
+   */
+  latest_verification: PayoutAccountRetrieveResponse.LatestVerification | null;
+
+  /**
+   * The business representative's phone
+   */
+  phone: string | null;
+
+  /**
+   * The granular calculated statuses reflecting payout account KYC and withdrawal
+   * readiness.
+   */
+  status: PayoutAccountCalculatedStatuses | null;
+}
+
+export namespace PayoutAccountRetrieveResponse {
+  /**
+   * The physical address associated with this payout account
+   */
+  export interface Address {
+    /**
+     * The city of the address.
+     */
+    city: string | null;
+
+    /**
+     * The country of the address.
+     */
+    country: string | null;
+
+    /**
+     * The line 1 of the address.
+     */
+    line1: string | null;
+
+    /**
+     * The line 2 of the address.
+     */
+    line2: string | null;
+
+    /**
+     * The postal code of the address.
+     */
+    postal_code: string | null;
+
+    /**
+     * The state of the address.
+     */
+    state: string | null;
+  }
+
+  /**
+   * The business representative for this payout account
+   */
+  export interface BusinessRepresentative {
+    /**
+     * The date of birth of the business representative in ISO 8601 format
+     * (YYYY-MM-DD).
+     */
+    date_of_birth: string | null;
+
+    /**
+     * The first name of the business representative.
+     */
+    first_name: string | null;
+
+    /**
+     * The last name of the business representative.
+     */
+    last_name: string | null;
+
+    /**
+     * The middle name of the business representative.
+     */
+    middle_name: string | null;
+  }
+
+  /**
+   * The latest verification for the connected account.
+   */
+  export interface LatestVerification {
+    /**
+     * The unique identifier for the verification.
+     */
+    id: string;
+
+    /**
+     * An error code for a verification attempt.
+     */
+    last_error_code: VerificationsAPI.VerificationErrorCode | null;
+
+    /**
+     * A human-readable explanation of the most recent verification error. Null if no
+     * error has occurred.
+     */
+    last_error_reason: string | null;
+
+    /**
+     * The current status of this verification session.
+     */
+    status: VerificationsAPI.VerificationStatus;
+  }
+}
+
+export declare namespace PayoutAccounts {
+  export {
+    type PayoutAccountCalculatedStatuses as PayoutAccountCalculatedStatuses,
+    type PayoutAccountRetrieveResponse as PayoutAccountRetrieveResponse,
+  };
+}

package/src/resources/verifications.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../core/resource';
 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';
 
@@ -19,8 +20,28 @@ export class Verifications extends APIResource {
   retrieve(id: string, options?: RequestOptions): APIPromise<VerificationRetrieveResponse> {
     return this._client.get(path`/verifications/${id}`, options);
   }
+
+  /**
+   * Returns a list of identity verifications for a payout account, ordered by most
+   * recent first.
+   *
+   * Required permissions:
+   *
+   * - `payout:account:read`
+   */
+  list(
+    query: VerificationListParams,
+    options?: RequestOptions,
+  ): PagePromise<VerificationListResponsesCursorPage, VerificationListResponse> {
+    return this._client.getAPIList('/verifications', CursorPage<VerificationListResponse>, {
+      query,
+      ...options,
+    });
+  }
 }
 
+export type VerificationListResponsesCursorPage = CursorPage<VerificationListResponse>;
+
 /**
  * An error code for a verification attempt.
  */
@@ -90,10 +111,62 @@ export interface VerificationRetrieveResponse {
   status: VerificationStatus;
 }
 
+/**
+ * An identity verification session used to confirm a person or entity's identity
+ * for payout account eligibility.
+ */
+export interface VerificationListResponse {
+  /**
+   * The unique identifier for the verification.
+   */
+  id: string;
+
+  /**
+   * An error code for a verification attempt.
+   */
+  last_error_code: VerificationErrorCode | null;
+
+  /**
+   * A human-readable explanation of the most recent verification error. Null if no
+   * error has occurred.
+   */
+  last_error_reason: string | null;
+
+  /**
+   * The current status of this verification session.
+   */
+  status: VerificationStatus;
+}
+
+export interface VerificationListParams extends CursorPageParams {
+  /**
+   * The unique identifier of the payout account to list verifications for.
+   */
+  payout_account_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | 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 Verifications {
   export {
     type VerificationErrorCode as VerificationErrorCode,
     type VerificationStatus as VerificationStatus,
     type VerificationRetrieveResponse as VerificationRetrieveResponse,
+    type VerificationListResponse as VerificationListResponse,
+    type VerificationListResponsesCursorPage as VerificationListResponsesCursorPage,
+    type VerificationListParams as VerificationListParams,
   };
 }

package/src/resources/webhooks.ts

@@ -4,6 +4,7 @@ import { APIResource } from '../core/resource';
 import * as DisputeAlertsAPI from './dispute-alerts';
 import * as DisputesAPI from './disputes';
 import * as PaymentsAPI from './payments';
+import * as PayoutAccountsAPI from './payout-accounts';
 import * as PayoutMethodsAPI from './payout-methods';
 import * as RefundsAPI from './refunds';
 import * as SetupIntentsAPI from './setup-intents';
@@ -217,6 +218,7 @@ export type WebhookEvent =
   | 'course_lesson_interaction.completed'
   | 'payout_method.created'
   | 'verification.succeeded'
+  | 'payout_account.status_updated'
   | 'payment.created'
   | 'payment.succeeded'
   | 'payment.failed'
@@ -1052,6 +1054,175 @@ export namespace VerificationSucceededWebhookEvent {
   }
 }
 
+export interface PayoutAccountStatusUpdatedWebhookEvent {
+  /**
+   * A unique ID for every single webhook request
+   */
+  id: string;
+
+  /**
+   * The API version for this webhook
+   */
+  api_version: 'v1';
+
+  /**
+   * An object representing an account used for payouts.
+   */
+  data: PayoutAccountStatusUpdatedWebhookEvent.Data;
+
+  /**
+   * The timestamp in ISO 8601 format that the webhook was sent at on the server
+   */
+  timestamp: string;
+
+  /**
+   * The webhook event type
+   */
+  type: 'payout_account.status_updated';
+
+  /**
+   * The company ID that this webhook event is associated with
+   */
+  company_id?: string | null;
+}
+
+export namespace PayoutAccountStatusUpdatedWebhookEvent {
+  /**
+   * An object representing an account used for payouts.
+   */
+  export interface Data {
+    /**
+     * The unique identifier for the payout account.
+     */
+    id: string;
+
+    /**
+     * The physical address associated with this payout account
+     */
+    address: Data.Address | null;
+
+    /**
+     * The company's legal name
+     */
+    business_name: string | null;
+
+    /**
+     * The business representative for this payout account
+     */
+    business_representative: Data.BusinessRepresentative | null;
+
+    /**
+     * The email address of the representative
+     */
+    email: string | null;
+
+    /**
+     * The latest verification for the connected account.
+     */
+    latest_verification: Data.LatestVerification | null;
+
+    /**
+     * The business representative's phone
+     */
+    phone: string | null;
+
+    /**
+     * The granular calculated statuses reflecting payout account KYC and withdrawal
+     * readiness.
+     */
+    status: PayoutAccountsAPI.PayoutAccountCalculatedStatuses | null;
+  }
+
+  export namespace Data {
+    /**
+     * The physical address associated with this payout account
+     */
+    export interface Address {
+      /**
+       * The city of the address.
+       */
+      city: string | null;
+
+      /**
+       * The country of the address.
+       */
+      country: string | null;
+
+      /**
+       * The line 1 of the address.
+       */
+      line1: string | null;
+
+      /**
+       * The line 2 of the address.
+       */
+      line2: string | null;
+
+      /**
+       * The postal code of the address.
+       */
+      postal_code: string | null;
+
+      /**
+       * The state of the address.
+       */
+      state: string | null;
+    }
+
+    /**
+     * The business representative for this payout account
+     */
+    export interface BusinessRepresentative {
+      /**
+       * The date of birth of the business representative in ISO 8601 format
+       * (YYYY-MM-DD).
+       */
+      date_of_birth: string | null;
+
+      /**
+       * The first name of the business representative.
+       */
+      first_name: string | null;
+
+      /**
+       * The last name of the business representative.
+       */
+      last_name: string | null;
+
+      /**
+       * The middle name of the business representative.
+       */
+      middle_name: string | null;
+    }
+
+    /**
+     * The latest verification for the connected account.
+     */
+    export interface LatestVerification {
+      /**
+       * The unique identifier for the verification.
+       */
+      id: string;
+
+      /**
+       * An error code for a verification attempt.
+       */
+      last_error_code: VerificationsAPI.VerificationErrorCode | null;
+
+      /**
+       * A human-readable explanation of the most recent verification error. Null if no
+       * error has occurred.
+       */
+      last_error_reason: string | null;
+
+      /**
+       * The current status of this verification session.
+       */
+      status: VerificationsAPI.VerificationStatus;
+    }
+  }
+}
+
 export interface PaymentCreatedWebhookEvent {
   /**
    * A unique ID for every single webhook request
@@ -2086,6 +2257,7 @@ export type UnwrapWebhookEvent =
   | CourseLessonInteractionCompletedWebhookEvent
   | PayoutMethodCreatedWebhookEvent
   | VerificationSucceededWebhookEvent
+  | PayoutAccountStatusUpdatedWebhookEvent
   | PaymentCreatedWebhookEvent
   | PaymentSucceededWebhookEvent
   | PaymentFailedWebhookEvent
@@ -2206,6 +2378,7 @@ export declare namespace Webhooks {
     type CourseLessonInteractionCompletedWebhookEvent as CourseLessonInteractionCompletedWebhookEvent,
     type PayoutMethodCreatedWebhookEvent as PayoutMethodCreatedWebhookEvent,
     type VerificationSucceededWebhookEvent as VerificationSucceededWebhookEvent,
+    type PayoutAccountStatusUpdatedWebhookEvent as PayoutAccountStatusUpdatedWebhookEvent,
     type PaymentCreatedWebhookEvent as PaymentCreatedWebhookEvent,
     type PaymentSucceededWebhookEvent as PaymentSucceededWebhookEvent,
     type PaymentFailedWebhookEvent as PaymentFailedWebhookEvent,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.0.32'; // x-release-please-version
+export const VERSION = '0.0.33'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.js

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

package/version.mjs

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