@whop/sdk 0.0.1-canary.0

package/src/resources/chat-channels.ts

@@ -0,0 +1,207 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+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 ChatChannels extends APIResource {
+  /**
+   * Retrieves a chat channel
+   *
+   * Required permissions:
+   *
+   * - `chat:read`
+   *
+   * @example
+   * ```ts
+   * const chatChannel = await client.chatChannels.retrieve(
+   *   'id',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.ChatChannel> {
+    return this._client.get(path`/chat_channels/${id}`, options);
+  }
+
+  /**
+   * Updates a chat channel
+   *
+   * Required permissions:
+   *
+   * - `chat:moderate`
+   *
+   * @example
+   * ```ts
+   * const chatChannel = await client.chatChannels.update('id');
+   * ```
+   */
+  update(
+    id: string,
+    body: ChatChannelUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.ChatChannel> {
+    return this._client.patch(path`/chat_channels/${id}`, { body, ...options });
+  }
+
+  /**
+   * Lists chat channels inside a company
+   *
+   * Required permissions:
+   *
+   * - `chat:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const chatChannelListResponse of client.chatChannels.list(
+   *   { company_id: 'biz_xxxxxxxxxxxxxx' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: ChatChannelListParams,
+    options?: RequestOptions,
+  ): PagePromise<ChatChannelListResponsesCursorPage, ChatChannelListResponse> {
+    return this._client.getAPIList('/chat_channels', CursorPage<ChatChannelListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type ChatChannelListResponsesCursorPage = CursorPage<ChatChannelListResponse>;
+
+/**
+ * Represents a Chat feed
+ */
+export interface ChatChannelListResponse {
+  /**
+   * The unique identifier for the entity
+   */
+  id: string;
+
+  /**
+   * Whether or not media is banned in this chat
+   */
+  ban_media: boolean;
+
+  /**
+   * Whether or not URLs are banned in this chat
+   */
+  ban_urls: boolean;
+
+  /**
+   * List of banned words in this chat
+   */
+  banned_words: Array<string>;
+
+  /**
+   * The experience for this chat
+   */
+  experience: ChatChannelListResponse.Experience;
+
+  /**
+   * The number of seconds a user needs to wait before posting again, if any
+   */
+  user_posts_cooldown_seconds: number | null;
+
+  /**
+   * Who can post on this chat
+   */
+  who_can_post: Shared.WhoCanPost;
+
+  /**
+   * Who can react on this chat
+   */
+  who_can_react: Shared.WhoCanReact;
+}
+
+export namespace ChatChannelListResponse {
+  /**
+   * The experience for this chat
+   */
+  export interface Experience {
+    /**
+     * The unique ID representing this experience
+     */
+    id: string;
+
+    /**
+     * The written name of the description.
+     */
+    name: string;
+  }
+}
+
+export interface ChatChannelUpdateParams {
+  /**
+   * Whether media uploads are banned in this chat
+   */
+  ban_media?: boolean | null;
+
+  /**
+   * Whether URLs are banned in this chat
+   */
+  ban_urls?: boolean | null;
+
+  /**
+   * List of banned words for this chat
+   */
+  banned_words?: Array<string> | null;
+
+  /**
+   * The cooldown period in seconds between user posts
+   */
+  user_posts_cooldown_seconds?: number | null;
+
+  /**
+   * Who can post on a chat feed
+   */
+  who_can_post?: Shared.WhoCanPost | null;
+
+  /**
+   * Who can react on a chat feed
+   */
+  who_can_react?: Shared.WhoCanReact | null;
+}
+
+export interface ChatChannelListParams extends CursorPageParams {
+  /**
+   * The ID of the company to list chat channels for
+   */
+  company_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;
+
+  /**
+   * If provided, only chat channels connected to this product are returned
+   */
+  product_id?: string | null;
+}
+
+export declare namespace ChatChannels {
+  export {
+    type ChatChannelListResponse as ChatChannelListResponse,
+    type ChatChannelListResponsesCursorPage as ChatChannelListResponsesCursorPage,
+    type ChatChannelUpdateParams as ChatChannelUpdateParams,
+    type ChatChannelListParams as ChatChannelListParams,
+  };
+}

package/src/resources/checkout-configurations.ts

@@ -0,0 +1,397 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+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 CheckoutConfigurations extends APIResource {
+  /**
+   * Creates a new checkout session
+   *
+   * Required permissions:
+   *
+   * - `checkout_configuration:create`
+   * - `plan:create`
+   *
+   * @example
+   * ```ts
+   * const checkoutConfiguration =
+   *   await client.checkoutConfigurations.create();
+   * ```
+   */
+  create(
+    body: CheckoutConfigurationCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.CheckoutConfiguration> {
+    return this._client.post('/checkout_configurations', { body, ...options });
+  }
+
+  /**
+   * Retrieves a checkout configuration by ID
+   *
+   * Required permissions:
+   *
+   * - `checkout_configuration:basic:read`
+   *
+   * @example
+   * ```ts
+   * const checkoutConfiguration =
+   *   await client.checkoutConfigurations.retrieve(
+   *     'ch_xxxxxxxxxxxxxxx',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.CheckoutConfiguration> {
+    return this._client.get(path`/checkout_configurations/${id}`, options);
+  }
+
+  /**
+   * Lists checkout configurations
+   *
+   * Required permissions:
+   *
+   * - `checkout_configuration:basic:read`
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const checkoutConfigurationListResponse of client.checkoutConfigurations.list(
+   *   { company_id: 'biz_xxxxxxxxxxxxxx' },
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: CheckoutConfigurationListParams,
+    options?: RequestOptions,
+  ): PagePromise<CheckoutConfigurationListResponsesCursorPage, CheckoutConfigurationListResponse> {
+    return this._client.getAPIList(
+      '/checkout_configurations',
+      CursorPage<CheckoutConfigurationListResponse>,
+      { query, ...options },
+    );
+  }
+}
+
+export type CheckoutConfigurationListResponsesCursorPage = CursorPage<CheckoutConfigurationListResponse>;
+
+/**
+ * A checkout session
+ */
+export interface CheckoutConfigurationListResponse {
+  /**
+   * The ID of the checkout session
+   */
+  id: string;
+
+  /**
+   * The affiliate code to use for the checkout session
+   */
+  affiliate_code: string;
+
+  /**
+   * The ID of the company to use for the checkout session
+   */
+  company_id: string;
+
+  /**
+   * The metadata to use for the checkout session
+   */
+  metadata: { [key: string]: unknown };
+
+  /**
+   * The plan to use for the checkout session
+   */
+  plan: CheckoutConfigurationListResponse.Plan;
+
+  /**
+   * The URL to redirect the user to after the checkout session is created
+   */
+  purchase_url: string;
+
+  /**
+   * The URL to redirect the user to after the checkout session is created
+   */
+  redirect_url: string;
+}
+
+export namespace CheckoutConfigurationListResponse {
+  /**
+   * The plan to use for the checkout session
+   */
+  export interface Plan {
+    /**
+     * The internal ID of the plan.
+     */
+    id: string;
+
+    /**
+     * The interval at which the plan charges (renewal plans).
+     */
+    billing_period: number | null;
+
+    /**
+     * The respective currency identifier for the plan.
+     */
+    currency: Shared.Currency;
+
+    /**
+     * The interval at which the plan charges (expiration plans).
+     */
+    expiration_days: number | null;
+
+    /**
+     * The price a person has to pay for a plan on the initial purchase.
+     */
+    initial_price: number;
+
+    /**
+     * Indicates if the plan is a one time payment or recurring.
+     */
+    plan_type: Shared.PlanType;
+
+    /**
+     * This is the release method the business uses to sell this plan.
+     */
+    release_method: Shared.ReleaseMethod;
+
+    /**
+     * The price a person has to pay for a plan on the renewal purchase.
+     */
+    renewal_price: number;
+
+    /**
+     * The number of free trial days added before a renewal plan.
+     */
+    trial_period_days: number | null;
+
+    /**
+     * Shows or hides the plan from public/business view.
+     */
+    visibility: Shared.Visibility;
+  }
+}
+
+export interface CheckoutConfigurationCreateParams {
+  /**
+   * The affiliate code to use for the checkout session
+   */
+  affiliate_code?: string | null;
+
+  /**
+   * The metadata to use for the checkout session
+   */
+  metadata?: { [key: string]: unknown } | null;
+
+  /**
+   * Pass this object to create a new plan for this checkout session
+   */
+  plan?: CheckoutConfigurationCreateParams.Plan | null;
+
+  /**
+   * The ID of the plan to use for the checkout session
+   */
+  plan_id?: string | null;
+
+  /**
+   * The URL to redirect the user to after the checkout session is created
+   */
+  redirect_url?: string | null;
+}
+
+export namespace CheckoutConfigurationCreateParams {
+  /**
+   * Pass this object to create a new plan for this checkout session
+   */
+  export interface Plan {
+    /**
+     * The company the plan should be created for.
+     */
+    company_id: string;
+
+    /**
+     * The interval at which the plan charges (renewal plans).
+     */
+    billing_period?: number | null;
+
+    /**
+     * The available currencies on the platform
+     */
+    currency?: Shared.Currency | null;
+
+    /**
+     * An array of custom field objects.
+     */
+    custom_fields?: Array<Plan.CustomField> | null;
+
+    /**
+     * The description of the plan.
+     */
+    description?: string | null;
+
+    /**
+     * The interval at which the plan charges (expiration plans).
+     */
+    expiration_days?: number | null;
+
+    /**
+     * Whether to force the creation of a new plan even if one with the same attributes
+     * already exists.
+     */
+    force_create_new_plan?: boolean | null;
+
+    /**
+     * An image for the plan. This will be visible on the product page to customers.
+     */
+    image?: Plan.Image | null;
+
+    /**
+     * An additional amount charged upon first purchase.
+     */
+    initial_price?: number | null;
+
+    /**
+     * A personal description or notes section for the business.
+     */
+    internal_notes?: string | null;
+
+    /**
+     * Whether or not the tax is included in a plan's price (or if it hasn't been set
+     * up)
+     */
+    override_tax_type?: Shared.TaxType | null;
+
+    /**
+     * The type of plan that can be attached to an access pass
+     */
+    plan_type?: Shared.PlanType | null;
+
+    /**
+     * The product the plan is related to.
+     */
+    product_id?: string | null;
+
+    /**
+     * The methods of how a plan can be released.
+     */
+    release_method?: Shared.ReleaseMethod | null;
+
+    /**
+     * The amount the customer is charged every billing period.
+     */
+    renewal_price?: number | null;
+
+    /**
+     * The title of the plan. This will be visible on the product page to customers.
+     */
+    title?: string | null;
+
+    /**
+     * The number of free trial days added before a renewal plan.
+     */
+    trial_period_days?: number | null;
+
+    /**
+     * Visibility of a resource
+     */
+    visibility?: Shared.Visibility | null;
+  }
+
+  export namespace Plan {
+    export interface CustomField {
+      /**
+       * The type of the custom field.
+       */
+      field_type: 'text';
+
+      /**
+       * The name of the custom field.
+       */
+      name: string;
+
+      /**
+       * The ID of the custom field (if being updated)
+       */
+      id?: string | null;
+
+      /**
+       * The order of the field.
+       */
+      order?: number | null;
+
+      /**
+       * The placeholder value of the field.
+       */
+      placeholder?: string | null;
+
+      /**
+       * Whether or not the field is required.
+       */
+      required?: boolean | null;
+    }
+
+    /**
+     * An image for the plan. This will be visible on the product page to customers.
+     */
+    export interface Image {
+      /**
+       * The ID of an existing attachment object. Use this when updating a resource and
+       * keeping a subset of the attachments. Don't use this unless you know what you're
+       * doing.
+       */
+      id?: string | null;
+
+      /**
+       * This ID should be used the first time you upload an attachment. It is the ID of
+       * the direct upload that was created when uploading the file to S3 via the
+       * mediaDirectUpload mutation.
+       */
+      direct_upload_id?: string | null;
+    }
+  }
+}
+
+export interface CheckoutConfigurationListParams extends CursorPageParams {
+  /**
+   * The ID of the company to list checkout configurations for
+   */
+  company_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  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;
+
+  /**
+   * The ID of the plan to filter checkout configurations by
+   */
+  plan_id?: string | null;
+}
+
+export declare namespace CheckoutConfigurations {
+  export {
+    type CheckoutConfigurationListResponse as CheckoutConfigurationListResponse,
+    type CheckoutConfigurationListResponsesCursorPage as CheckoutConfigurationListResponsesCursorPage,
+    type CheckoutConfigurationCreateParams as CheckoutConfigurationCreateParams,
+    type CheckoutConfigurationListParams as CheckoutConfigurationListParams,
+  };
+}

package/src/resources/companies.ts

@@ -0,0 +1,20 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Companies extends APIResource {
+  /**
+   * Retrieves an company by ID or its url route
+   *
+   * Required permissions:
+   *
+   * - `company:basic:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Company> {
+    return this._client.get(path`/companies/${id}`, options);
+  }
+}

package/src/resources/course-lesson-interactions.ts

@@ -0,0 +1,85 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { CourseLessonInteractionListItemsCursorPage } 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 CourseLessonInteractions extends APIResource {
+  /**
+   * Retrieves a course lesson interaction by ID
+   *
+   * Required permissions:
+   *
+   * - `course_lesson_interaction:read`
+   * - `courses:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.CourseLessonInteraction> {
+    return this._client.get(path`/course_lesson_interactions/${id}`, options);
+  }
+
+  /**
+   * Lists course lesson interactions
+   *
+   * Required permissions:
+   *
+   * - `course_lesson_interaction:read`
+   * - `courses:read`
+   */
+  list(
+    query: CourseLessonInteractionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<CourseLessonInteractionListItemsCursorPage, Shared.CourseLessonInteractionListItem> {
+    return this._client.getAPIList(
+      '/course_lesson_interactions',
+      CursorPage<Shared.CourseLessonInteractionListItem>,
+      { query, ...options },
+    );
+  }
+}
+
+export interface CourseLessonInteractionListParams extends CursorPageParams {
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Whether the lesson has been completed by the user
+   */
+  completed?: boolean | null;
+
+  /**
+   * The ID of the course to list course lesson interactions for
+   */
+  course_id?: string | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+
+  /**
+   * The ID of the lesson to list course lesson interactions for
+   */
+  lesson_id?: string | null;
+
+  /**
+   * The ID of the user to list course lesson interactions for
+   */
+  user_id?: string | null;
+}
+
+export declare namespace CourseLessonInteractions {
+  export { type CourseLessonInteractionListParams as CourseLessonInteractionListParams };
+}
+
+export { type CourseLessonInteractionListItemsCursorPage };