@sentdm/sentdm 0.7.2 → 0.14.0

package/resources/users.d.ts

@@ -0,0 +1,251 @@
+import { APIResource } from "../core/resource.js";
+import * as UsersAPI from "./users.js";
+import * as WebhooksAPI from "./webhooks.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+/**
+ * Invite, update, and manage organization users and roles
+ */
+export declare class Users extends APIResource {
+    /**
+     * Retrieves detailed information about a specific user in an organization or
+     * profile. Requires developer role or higher.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfUser = await client.users.retrieve(
+     *   'userId',
+     * );
+     * ```
+     */
+    retrieve(userID: string, params?: UserRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfUser>;
+    /**
+     * Retrieves all users who have access to the organization or profile identified by
+     * the API key, including their roles and status. Shows invited users (pending
+     * acceptance) and active users. Requires developer role or higher.
+     *
+     * @example
+     * ```ts
+     * const users = await client.users.list();
+     * ```
+     */
+    list(params?: UserListParams | null | undefined, options?: RequestOptions): APIPromise<UserListResponse>;
+    /**
+     * Sends an invitation to a user to join the organization or profile with a
+     * specific role. Requires admin role. The user will receive an invitation email
+     * with a token to accept. Invitation tokens expire after 7 days.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfUser = await client.users.invite();
+     * ```
+     */
+    invite(params: UserInviteParams, options?: RequestOptions): APIPromise<APIResponseOfUser>;
+    /**
+     * Removes a user's access to an organization or profile. Requires admin role. You
+     * cannot remove yourself or remove the last admin.
+     *
+     * @example
+     * ```ts
+     * await client.users.remove('userId', { body: {} });
+     * ```
+     */
+    remove(userID: string, params: UserRemoveParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Updates a user's role in the organization or profile. Requires admin role. You
+     * cannot change your own role or demote the last admin.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfUser = await client.users.updateRole(
+     *   'userId',
+     * );
+     * ```
+     */
+    updateRole(userID: string, params: UserUpdateRoleParams, options?: RequestOptions): APIPromise<APIResponseOfUser>;
+}
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface APIResponseOfUser {
+    /**
+     * User response for v3 API
+     */
+    data?: UserResponse | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+/**
+ * User response for v3 API
+ */
+export interface UserResponse {
+    /**
+     * User unique identifier
+     */
+    id?: string;
+    /**
+     * When the user was added to the organization
+     */
+    created_at?: string;
+    /**
+     * User email address
+     */
+    email?: string;
+    /**
+     * When the user was invited
+     */
+    invited_at?: string | null;
+    /**
+     * When the user last logged in
+     */
+    last_login_at?: string | null;
+    /**
+     * User full name
+     */
+    name?: string;
+    /**
+     * User role in the organization: admin, billing, developer
+     */
+    role?: string;
+    /**
+     * User status: active, invited, suspended, rejected
+     */
+    status?: string;
+    /**
+     * When the user record was last updated
+     */
+    updated_at?: string | null;
+}
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface UserListResponse {
+    /**
+     * List of users response
+     */
+    data?: UserListResponse.Data | null;
+    /**
+     * Error information
+     */
+    error?: WebhooksAPI.ErrorDetail | null;
+    /**
+     * Request and response metadata
+     */
+    meta?: WebhooksAPI.APIMeta;
+    /**
+     * Indicates whether the request was successful
+     */
+    success?: boolean;
+}
+export declare namespace UserListResponse {
+    /**
+     * List of users response
+     */
+    interface Data {
+        /**
+         * List of users in the organization
+         */
+        users?: Array<UsersAPI.UserResponse>;
+    }
+}
+export interface UserRetrieveParams {
+    /**
+     * Profile UUID to scope the request to a child profile. Only organization API keys
+     * can use this header. The profile must belong to the calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface UserListParams {
+    /**
+     * Profile UUID to scope the request to a child profile. Only organization API keys
+     * can use this header. The profile must belong to the calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface UserInviteParams {
+    /**
+     * Body param: User email address (required)
+     */
+    email?: string;
+    /**
+     * Body param: User full name (required)
+     */
+    name?: string;
+    /**
+     * Body param: User role: admin, billing, or developer (required)
+     */
+    role?: string;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Header param: Unique key to ensure idempotent request processing. Must be 1-255
+     * alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+     * hours per key per customer.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export interface UserRemoveParams {
+    /**
+     * Body param: Request to remove a user from an organization
+     */
+    body: UserRemoveParams.Body;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export declare namespace UserRemoveParams {
+    /**
+     * Request to remove a user from an organization
+     */
+    interface Body extends WebhooksAPI.MutationRequest {
+    }
+}
+export interface UserUpdateRoleParams {
+    /**
+     * Body param: User role: admin, billing, or developer (required)
+     */
+    role?: string;
+    /**
+     * Body param: Sandbox flag - when true, the operation is simulated without side
+     * effects Useful for testing integrations without actual execution
+     */
+    sandbox?: boolean;
+    /**
+     * Header param: Unique key to ensure idempotent request processing. Must be 1-255
+     * alphanumeric characters, hyphens, or underscores. Responses are cached for 24
+     * hours per key per customer.
+     */
+    'Idempotency-Key'?: string;
+    /**
+     * Header param: Profile UUID to scope the request to a child profile. Only
+     * organization API keys can use this header. The profile must belong to the
+     * calling organization.
+     */
+    'x-profile-id'?: string;
+}
+export declare namespace Users {
+    export { type APIResponseOfUser as APIResponseOfUser, type UserResponse as UserResponse, type UserListResponse as UserListResponse, type UserRetrieveParams as UserRetrieveParams, type UserListParams as UserListParams, type UserInviteParams as UserInviteParams, type UserRemoveParams as UserRemoveParams, type UserUpdateRoleParams as UserUpdateRoleParams, };
+}
+//# sourceMappingURL=users.d.ts.map

package/resources/users.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAWhC;;;;;;;;;OASG;IACH,IAAI,CACF,MAAM,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAW/B;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAezF;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAY5F;;;;;;;;;;OAUG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAcjC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;KACtC;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC;IAE5B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,IAAK,SAAQ,WAAW,CAAC,eAAe;KAAG;CAC7D;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/users.js

@@ -0,0 +1,124 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Users = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+const path_1 = require("../internal/utils/path.js");
+/**
+ * Invite, update, and manage organization users and roles
+ */
+class Users extends resource_1.APIResource {
+    /**
+     * Retrieves detailed information about a specific user in an organization or
+     * profile. Requires developer role or higher.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfUser = await client.users.retrieve(
+     *   'userId',
+     * );
+     * ```
+     */
+    retrieve(userID, params = {}, options) {
+        const { 'x-profile-id': xProfileID } = params ?? {};
+        return this._client.get((0, path_1.path) `/v3/users/${userID}`, {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves all users who have access to the organization or profile identified by
+     * the API key, including their roles and status. Shows invited users (pending
+     * acceptance) and active users. Requires developer role or higher.
+     *
+     * @example
+     * ```ts
+     * const users = await client.users.list();
+     * ```
+     */
+    list(params = {}, options) {
+        const { 'x-profile-id': xProfileID } = params ?? {};
+        return this._client.get('/v3/users', {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Sends an invitation to a user to join the organization or profile with a
+     * specific role. Requires admin role. The user will receive an invitation email
+     * with a token to accept. Invitation tokens expire after 7 days.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfUser = await client.users.invite();
+     * ```
+     */
+    invite(params, options) {
+        const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
+        return this._client.post('/v3/users', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Removes a user's access to an organization or profile. Requires admin role. You
+     * cannot remove yourself or remove the last admin.
+     *
+     * @example
+     * ```ts
+     * await client.users.remove('userId', { body: {} });
+     * ```
+     */
+    remove(userID, params, options) {
+        const { body, 'x-profile-id': xProfileID } = params;
+        return this._client.delete((0, path_1.path) `/v3/users/${userID}`, {
+            body: body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { Accept: '*/*', ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Updates a user's role in the organization or profile. Requires admin role. You
+     * cannot change your own role or demote the last admin.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfUser = await client.users.updateRole(
+     *   'userId',
+     * );
+     * ```
+     */
+    updateRole(userID, params, options) {
+        const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
+        return this._client.patch((0, path_1.path) `/v3/users/${userID}`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                {
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.Users = Users;
+//# sourceMappingURL=users.js.map

package/resources/users.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAAmD;AAEnD,oDAA8C;AAE9C;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,MAAc,EACd,SAAgD,EAAE,EAClD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,EAAE,EAAE;YACjD,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,SAA4C,EAAE,EAC9C,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE;YACnC,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE;YACpC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAc,EAAE,MAAwB,EAAE,OAAwB;QACvE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,EAAE,EAAE;YACpD,IAAI,EAAE,IAAI;YACV,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CACR,MAAc,EACd,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,MAAM,EAAE,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA9HD,sBA8HC"}

package/resources/users.mjs

@@ -0,0 +1,120 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+import { path } from "../internal/utils/path.mjs";
+/**
+ * Invite, update, and manage organization users and roles
+ */
+export class Users extends APIResource {
+    /**
+     * Retrieves detailed information about a specific user in an organization or
+     * profile. Requires developer role or higher.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfUser = await client.users.retrieve(
+     *   'userId',
+     * );
+     * ```
+     */
+    retrieve(userID, params = {}, options) {
+        const { 'x-profile-id': xProfileID } = params ?? {};
+        return this._client.get(path `/v3/users/${userID}`, {
+            ...options,
+            headers: buildHeaders([
+                { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves all users who have access to the organization or profile identified by
+     * the API key, including their roles and status. Shows invited users (pending
+     * acceptance) and active users. Requires developer role or higher.
+     *
+     * @example
+     * ```ts
+     * const users = await client.users.list();
+     * ```
+     */
+    list(params = {}, options) {
+        const { 'x-profile-id': xProfileID } = params ?? {};
+        return this._client.get('/v3/users', {
+            ...options,
+            headers: buildHeaders([
+                { ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Sends an invitation to a user to join the organization or profile with a
+     * specific role. Requires admin role. The user will receive an invitation email
+     * with a token to accept. Invitation tokens expire after 7 days.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfUser = await client.users.invite();
+     * ```
+     */
+    invite(params, options) {
+        const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
+        return this._client.post('/v3/users', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Removes a user's access to an organization or profile. Requires admin role. You
+     * cannot remove yourself or remove the last admin.
+     *
+     * @example
+     * ```ts
+     * await client.users.remove('userId', { body: {} });
+     * ```
+     */
+    remove(userID, params, options) {
+        const { body, 'x-profile-id': xProfileID } = params;
+        return this._client.delete(path `/v3/users/${userID}`, {
+            body: body,
+            ...options,
+            headers: buildHeaders([
+                { Accept: '*/*', ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Updates a user's role in the organization or profile. Requires admin role. You
+     * cannot change your own role or demote the last admin.
+     *
+     * @example
+     * ```ts
+     * const apiResponseOfUser = await client.users.updateRole(
+     *   'userId',
+     * );
+     * ```
+     */
+    updateRole(userID, params, options) {
+        const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
+        return this._client.patch(path `/v3/users/${userID}`, {
+            body,
+            ...options,
+            headers: buildHeaders([
+                {
+                    ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined),
+                    ...(xProfileID != null ? { 'x-profile-id': xProfileID } : undefined),
+                },
+                options?.headers,
+            ]),
+        });
+    }
+}
+//# sourceMappingURL=users.mjs.map

package/resources/users.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,MAAc,EACd,SAAgD,EAAE,EAClD,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE;YACjD,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CACF,SAA4C,EAAE,EAC9C,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE;YACnC,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACxE,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAwB,EAAE,OAAwB;QACvD,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE;YACpC,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAc,EAAE,MAAwB,EAAE,OAAwB;QACvE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE;YACpD,IAAI,EAAE,IAAI;YACV,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACvF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CACR,MAAc,EACd,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC1F,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,MAAM,EAAE,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB;oBACE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;oBAC/E,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBACrE;gBACD,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}