@whop/sdk 0.0.1-canary.0

package/resources/support-channels.d.mts

@@ -0,0 +1,151 @@
+import { APIResource } from "../core/resource.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 SupportChannels extends APIResource {
+    /**
+     * Create a new support channel for a user in a company. If one already exists, it
+     * will return the existing one.
+     *
+     * Required permissions:
+     *
+     * - `support_chat:create`
+     *
+     * @example
+     * ```ts
+     * const supportChannel = await client.supportChannels.create({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     *   user_id: 'user_xxxxxxxxxxxxx',
+     * });
+     * ```
+     */
+    create(body: SupportChannelCreateParams, options?: RequestOptions): APIPromise<Shared.SupportChannel>;
+    /**
+     * Retrieves a support channel
+     *
+     * Required permissions:
+     *
+     * - `support_chat:read`
+     *
+     * @example
+     * ```ts
+     * const supportChannel =
+     *   await client.supportChannels.retrieve('id');
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Shared.SupportChannel>;
+    /**
+     * Lists chat channels inside a company
+     *
+     * Required permissions:
+     *
+     * - `support_chat:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const supportChannelListResponse of client.supportChannels.list(
+     *   { company_id: 'biz_xxxxxxxxxxxxxx' },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query: SupportChannelListParams, options?: RequestOptions): PagePromise<SupportChannelListResponsesCursorPage, SupportChannelListResponse>;
+}
+export type SupportChannelListResponsesCursorPage = CursorPage<SupportChannelListResponse>;
+/**
+ * Represents a DM channel
+ */
+export interface SupportChannelListResponse {
+    /**
+     * The unique identifier for the entity
+     */
+    id: string;
+    /**
+     * The bot ID if this is a support chat
+     */
+    company_id: string | null;
+    /**
+     * The custom name of the DM channel, if any
+     */
+    custom_name: string | null;
+    /**
+     * The customer user if this is a support chat
+     */
+    customer_user: SupportChannelListResponse.CustomerUser | null;
+    /**
+     * When the last message was sent
+     */
+    last_message_at: string | null;
+    /**
+     * When the support ticket was resolved (null if unresolved)
+     */
+    resolved_at: string | null;
+}
+export declare namespace SupportChannelListResponse {
+    /**
+     * The customer user if this is a support chat
+     */
+    interface CustomerUser {
+        /**
+         * The internal ID of the user.
+         */
+        id: string;
+        /**
+         * The name of the user from their Whop account.
+         */
+        name: string | null;
+        /**
+         * The username of the user from their Whop account.
+         */
+        username: string;
+    }
+}
+export interface SupportChannelCreateParams {
+    /**
+     * The ID of the company to create the support chat in
+     */
+    company_id: string;
+    /**
+     * The ID of the user to create the support chat for
+     */
+    user_id: string;
+}
+export interface SupportChannelListParams 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;
+    /**
+     * 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;
+    /**
+     * Filter for tickets where customer sent the last message (needs response) AND not
+     * resolved. Set to true to only return open channels, false to only return
+     * resolved channels.
+     */
+    open?: boolean | null;
+    /**
+     * Sort options for message channels
+     */
+    order?: 'created_at' | 'last_post_sent_at' | null;
+}
+export declare namespace SupportChannels {
+    export { type SupportChannelListResponse as SupportChannelListResponse, type SupportChannelListResponsesCursorPage as SupportChannelListResponsesCursorPage, type SupportChannelCreateParams as SupportChannelCreateParams, type SupportChannelListParams as SupportChannelListParams, };
+}
+//# sourceMappingURL=support-channels.d.mts.map

package/resources/support-channels.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"support-channels.d.mts","sourceRoot":"","sources":["../src/resources/support-channels.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIrG;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIjF;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,0BAA0B,CAAC;CAMlF;AAED,MAAM,MAAM,qCAAqC,GAAG,UAAU,CAAC,0BAA0B,CAAC,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,0BAA0B,CAAC,YAAY,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAChE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;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;IAErB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,IAAI,CAAC;CACnD;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/support-channels.d.ts

@@ -0,0 +1,151 @@
+import { APIResource } from "../core/resource.js";
+import * as Shared from "./shared.js";
+import { APIPromise } from "../core/api-promise.js";
+import { CursorPage, type CursorPageParams, PagePromise } from "../core/pagination.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class SupportChannels extends APIResource {
+    /**
+     * Create a new support channel for a user in a company. If one already exists, it
+     * will return the existing one.
+     *
+     * Required permissions:
+     *
+     * - `support_chat:create`
+     *
+     * @example
+     * ```ts
+     * const supportChannel = await client.supportChannels.create({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     *   user_id: 'user_xxxxxxxxxxxxx',
+     * });
+     * ```
+     */
+    create(body: SupportChannelCreateParams, options?: RequestOptions): APIPromise<Shared.SupportChannel>;
+    /**
+     * Retrieves a support channel
+     *
+     * Required permissions:
+     *
+     * - `support_chat:read`
+     *
+     * @example
+     * ```ts
+     * const supportChannel =
+     *   await client.supportChannels.retrieve('id');
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Shared.SupportChannel>;
+    /**
+     * Lists chat channels inside a company
+     *
+     * Required permissions:
+     *
+     * - `support_chat:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const supportChannelListResponse of client.supportChannels.list(
+     *   { company_id: 'biz_xxxxxxxxxxxxxx' },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query: SupportChannelListParams, options?: RequestOptions): PagePromise<SupportChannelListResponsesCursorPage, SupportChannelListResponse>;
+}
+export type SupportChannelListResponsesCursorPage = CursorPage<SupportChannelListResponse>;
+/**
+ * Represents a DM channel
+ */
+export interface SupportChannelListResponse {
+    /**
+     * The unique identifier for the entity
+     */
+    id: string;
+    /**
+     * The bot ID if this is a support chat
+     */
+    company_id: string | null;
+    /**
+     * The custom name of the DM channel, if any
+     */
+    custom_name: string | null;
+    /**
+     * The customer user if this is a support chat
+     */
+    customer_user: SupportChannelListResponse.CustomerUser | null;
+    /**
+     * When the last message was sent
+     */
+    last_message_at: string | null;
+    /**
+     * When the support ticket was resolved (null if unresolved)
+     */
+    resolved_at: string | null;
+}
+export declare namespace SupportChannelListResponse {
+    /**
+     * The customer user if this is a support chat
+     */
+    interface CustomerUser {
+        /**
+         * The internal ID of the user.
+         */
+        id: string;
+        /**
+         * The name of the user from their Whop account.
+         */
+        name: string | null;
+        /**
+         * The username of the user from their Whop account.
+         */
+        username: string;
+    }
+}
+export interface SupportChannelCreateParams {
+    /**
+     * The ID of the company to create the support chat in
+     */
+    company_id: string;
+    /**
+     * The ID of the user to create the support chat for
+     */
+    user_id: string;
+}
+export interface SupportChannelListParams 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;
+    /**
+     * 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;
+    /**
+     * Filter for tickets where customer sent the last message (needs response) AND not
+     * resolved. Set to true to only return open channels, false to only return
+     * resolved channels.
+     */
+    open?: boolean | null;
+    /**
+     * Sort options for message channels
+     */
+    order?: 'created_at' | 'last_post_sent_at' | null;
+}
+export declare namespace SupportChannels {
+    export { type SupportChannelListResponse as SupportChannelListResponse, type SupportChannelListResponsesCursorPage as SupportChannelListResponsesCursorPage, type SupportChannelCreateParams as SupportChannelCreateParams, type SupportChannelListParams as SupportChannelListParams, };
+}
+//# sourceMappingURL=support-channels.d.ts.map

package/resources/support-channels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"support-channels.d.ts","sourceRoot":"","sources":["../src/resources/support-channels.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIrG;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIjF;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,qCAAqC,EAAE,0BAA0B,CAAC;CAMlF;AAED,MAAM,MAAM,qCAAqC,GAAG,UAAU,CAAC,0BAA0B,CAAC,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,0BAA0B,CAAC,YAAY,GAAG,IAAI,CAAC;IAE9D;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,yBAAiB,0BAA0B,CAAC;IAC1C;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAyB,SAAQ,gBAAgB;IAChE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;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;IAErB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,YAAY,GAAG,mBAAmB,GAAG,IAAI,CAAC;CACnD;AAED,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/support-channels.js

@@ -0,0 +1,69 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SupportChannels = void 0;
+const resource_1 = require("../core/resource.js");
+const pagination_1 = require("../core/pagination.js");
+const path_1 = require("../internal/utils/path.js");
+class SupportChannels extends resource_1.APIResource {
+    /**
+     * Create a new support channel for a user in a company. If one already exists, it
+     * will return the existing one.
+     *
+     * Required permissions:
+     *
+     * - `support_chat:create`
+     *
+     * @example
+     * ```ts
+     * const supportChannel = await client.supportChannels.create({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     *   user_id: 'user_xxxxxxxxxxxxx',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/support_channels', { body, ...options });
+    }
+    /**
+     * Retrieves a support channel
+     *
+     * Required permissions:
+     *
+     * - `support_chat:read`
+     *
+     * @example
+     * ```ts
+     * const supportChannel =
+     *   await client.supportChannels.retrieve('id');
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/support_channels/${id}`, options);
+    }
+    /**
+     * Lists chat channels inside a company
+     *
+     * Required permissions:
+     *
+     * - `support_chat:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const supportChannelListResponse of client.supportChannels.list(
+     *   { company_id: 'biz_xxxxxxxxxxxxxx' },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query, options) {
+        return this._client.getAPIList('/support_channels', (pagination_1.CursorPage), {
+            query,
+            ...options,
+        });
+    }
+}
+exports.SupportChannels = SupportChannels;
+//# sourceMappingURL=support-channels.js.map

package/resources/support-channels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"support-channels.js","sourceRoot":"","sources":["../src/resources/support-channels.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAoF;AAEpF,oDAA8C;AAE9C,MAAa,eAAgB,SAAQ,sBAAW;IAC9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAgC,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,uBAAsC,CAAA,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAhED,0CAgEC"}

package/resources/support-channels.mjs

@@ -0,0 +1,65 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { CursorPage } from "../core/pagination.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class SupportChannels extends APIResource {
+    /**
+     * Create a new support channel for a user in a company. If one already exists, it
+     * will return the existing one.
+     *
+     * Required permissions:
+     *
+     * - `support_chat:create`
+     *
+     * @example
+     * ```ts
+     * const supportChannel = await client.supportChannels.create({
+     *   company_id: 'biz_xxxxxxxxxxxxxx',
+     *   user_id: 'user_xxxxxxxxxxxxx',
+     * });
+     * ```
+     */
+    create(body, options) {
+        return this._client.post('/support_channels', { body, ...options });
+    }
+    /**
+     * Retrieves a support channel
+     *
+     * Required permissions:
+     *
+     * - `support_chat:read`
+     *
+     * @example
+     * ```ts
+     * const supportChannel =
+     *   await client.supportChannels.retrieve('id');
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/support_channels/${id}`, options);
+    }
+    /**
+     * Lists chat channels inside a company
+     *
+     * Required permissions:
+     *
+     * - `support_chat:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const supportChannelListResponse of client.supportChannels.list(
+     *   { company_id: 'biz_xxxxxxxxxxxxxx' },
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query, options) {
+        return this._client.getAPIList('/support_channels', (CursorPage), {
+            query,
+            ...options,
+        });
+    }
+}
+//# sourceMappingURL=support-channels.mjs.map

package/resources/support-channels.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"support-channels.mjs","sourceRoot":"","sources":["../src/resources/support-channels.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,UAAU,EAAsC;OAElD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,eAAgB,SAAQ,WAAW;IAC9C;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,IAAgC,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAA,UAAsC,CAAA,EAAE;YAC1F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/transfers.d.mts

@@ -0,0 +1,158 @@
+import { APIResource } from "../core/resource.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 Transfers extends APIResource {
+    /**
+     * Creates a new transfer between ledger accounts
+     *
+     * Required permissions:
+     *
+     * - `payout:transfer_funds`
+     *
+     * @example
+     * ```ts
+     * const transfer = await client.transfers.create({
+     *   amount: 6.9,
+     *   currency: 'usd',
+     *   destination_id: 'destination_id',
+     *   origin_id: 'origin_id',
+     * });
+     * ```
+     */
+    create(body: TransferCreateParams, options?: RequestOptions): APIPromise<Shared.Transfer>;
+    /**
+     * Retrieves a transfer by ID
+     *
+     * Required permissions:
+     *
+     * - `payout:transfer:read`
+     *
+     * @example
+     * ```ts
+     * const transfer = await client.transfers.retrieve(
+     *   'ctt_xxxxxxxxxxxxxx',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<Shared.Transfer>;
+    /**
+     * Lists transfers
+     *
+     * Required permissions:
+     *
+     * - `payout:transfer:read`
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const transferListResponse of client.transfers.list()) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(query?: TransferListParams | null | undefined, options?: RequestOptions): PagePromise<TransferListResponsesCursorPage, TransferListResponse>;
+}
+export type TransferListResponsesCursorPage = CursorPage<TransferListResponse>;
+/**
+ * Credit Transaction Transfer
+ */
+export interface TransferListResponse {
+    /**
+     * The unique identifier of the credit transaction transfer
+     */
+    id: string;
+    /**
+     * The amount of the credit transaction transfer
+     */
+    amount: number;
+    /**
+     * The timestamp when the credit transaction transfer was created
+     */
+    created_at: string;
+    /**
+     * The currency of the credit transaction transfer
+     */
+    currency: Shared.Currency;
+    /**
+     * The ID of the destination ledger account
+     */
+    destination_ledger_account_id: string;
+    /**
+     * The decimal fee of the credit transaction transfer
+     */
+    fee_amount: number | null;
+    /**
+     * The notes of the credit transaction transfer
+     */
+    notes: string | null;
+    /**
+     * The ID of the origin ledger account
+     */
+    origin_ledger_account_id: string;
+}
+export interface TransferCreateParams {
+    /**
+     * The amount to withdraw
+     */
+    amount: number;
+    /**
+     * The currency that is being withdrawn.
+     */
+    currency: Shared.Currency;
+    /**
+     * The ID of the destination account which will receive the funds (either a User
+     * ID, Company ID, or LedgerAccount ID)
+     */
+    destination_id: string;
+    /**
+     * The ID of the origin account which will send the funds (either a User ID,
+     * Company ID, or LedgerAccount ID)
+     */
+    origin_id: string;
+    /**
+     * A unique key to ensure idempotence. Use a UUID or similar.
+     */
+    idempotence_key?: string | null;
+    /**
+     * Notes for the transfer. Maximum of 50 characters.
+     */
+    notes?: string | null;
+}
+export interface TransferListParams extends CursorPageParams {
+    /**
+     * Returns the elements in the list that come before the specified cursor.
+     */
+    before?: string | null;
+    /**
+     * Filter transfers to only those that were sent to this destination account.
+     * (user_xxx, biz_xxx, ldgr_xxx)
+     */
+    destination_id?: 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;
+    /**
+     * Which columns can be used to sort.
+     */
+    order?: 'amount' | 'created_at' | null;
+    /**
+     * Filter transfers to only those that were sent from this origin account.
+     * (user_xxx, biz_xxx, ldgr_xxx)
+     */
+    origin_id?: string | null;
+}
+export declare namespace Transfers {
+    export { type TransferListResponse as TransferListResponse, type TransferListResponsesCursorPage as TransferListResponsesCursorPage, type TransferCreateParams as TransferCreateParams, type TransferListParams as TransferListParams, };
+}
+//# sourceMappingURL=transfers.d.mts.map

package/resources/transfers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transfers.d.mts","sourceRoot":"","sources":["../src/resources/transfers.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAIzF;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC;IAI3E;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+BAA+B,EAAE,oBAAoB,CAAC;CAGtE;AAED,MAAM,MAAM,+BAA+B,GAAG,UAAU,CAAC,oBAAoB,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IAEtC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;IAE1B;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;;OAGG;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;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,IAAI,CAAC;IAEvC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}