@openmrp/sdk 0.19.3

package/resources/identity/accounts.js

@@ -0,0 +1,35 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Accounts = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Manage account details, branding, portal, logo, and favicon.
+ */
+class Accounts extends resource_1.APIResource {
+    /**
+     * Uploads a customer-portal favicon.
+     *
+     * Send the image as the raw request body, not as multipart form data. Use a small
+     * square PNG (e.g. 32x32 or 64x64) for the best result in browser tabs. The
+     * uploaded image replaces any existing favicon and is shown on the account's
+     * customer portal. You can only upload a favicon for the account you are acting
+     * in.
+     *
+     * This endpoint requires the permission: `self:update`.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.identity.accounts.updateFavicon(
+     *     'ac_ykxoradjoeb3',
+     *   );
+     * ```
+     */
+    updateFavicon(id, options) {
+        return this._client.put((0, path_1.path) `/v1/identity/accounts/${id}/favicon`, options);
+    }
+}
+exports.Accounts = Accounts;
+//# sourceMappingURL=accounts.js.map

package/resources/identity/accounts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.js","sourceRoot":"","sources":["../../src/resources/identity/accounts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAU,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,yBAAyB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AAvBD,4BAuBC"}

package/resources/identity/accounts.mjs

@@ -0,0 +1,31 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Manage account details, branding, portal, logo, and favicon.
+ */
+export class Accounts extends APIResource {
+    /**
+     * Uploads a customer-portal favicon.
+     *
+     * Send the image as the raw request body, not as multipart form data. Use a small
+     * square PNG (e.g. 32x32 or 64x64) for the best result in browser tabs. The
+     * uploaded image replaces any existing favicon and is shown on the account's
+     * customer portal. You can only upload a favicon for the account you are acting
+     * in.
+     *
+     * This endpoint requires the permission: `self:update`.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.identity.accounts.updateFavicon(
+     *     'ac_ykxoradjoeb3',
+     *   );
+     * ```
+     */
+    updateFavicon(id, options) {
+        return this._client.put(path `/v1/identity/accounts/${id}/favicon`, options);
+    }
+}
+//# sourceMappingURL=accounts.mjs.map

package/resources/identity/accounts.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.mjs","sourceRoot":"","sources":["../../src/resources/identity/accounts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAU,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,yBAAyB,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF"}

package/resources/identity/identity.d.mts

@@ -0,0 +1,207 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as AccountsAPI from "./accounts.mjs";
+import { AccountUpdateFaviconResponse, Accounts } from "./accounts.mjs";
+import * as RolesAPI from "./roles.mjs";
+import { CreateRoleRequest, ListRole, RoleCreateParams, RoleDeleteResponse, RoleListParams, RoleRetrieveParams, RoleUpdateParams, Roles, UpdateRoleRequest } from "./roles.mjs";
+import * as APIKeysAPI from "../auth/api-keys/api-keys.mjs";
+import * as AccountUsersAPI from "./account-users/account-users.mjs";
+import { AccountUserCreateParams, AccountUserListParams, AccountUserRetrieveParams, AccountUserUpdateParams, AccountUsers, CreateAccountUserRequest, ListAccountUser, NotificationPreferenceItem, UpdateAccountUserRequest } from "./account-users/account-users.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * List permission groups and their permissions.
+ */
+export declare class Identity extends APIResource {
+    accountUsers: AccountUsersAPI.AccountUsers;
+    accounts: AccountsAPI.Accounts;
+    roles: RolesAPI.Roles;
+    /**
+     * Lists the permission catalog, organized into groups of related permissions.
+     *
+     * Each group carries the individual permissions it covers; pair a permission's
+     * code with an action (`create`, `read`, `update`, or `delete`) to build the
+     * permission strings accepted when creating or updating a role. The catalog is
+     * platform-defined and identical for every account.
+     *
+     * This endpoint requires the permission: `permissions:read`.
+     *
+     * @example
+     * ```ts
+     * const listPermissionGroup =
+     *   await client.identity.retrievePermissionGroups();
+     * ```
+     */
+    retrievePermissionGroups(query?: IdentityRetrievePermissionGroupsParams | null | undefined, options?: RequestOptions): APIPromise<ListPermissionGroup>;
+}
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListPermission {
+    /**
+     * Resources in this page.
+     */
+    data: Array<Permission>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo describes where the current page sits within a paginated result set and
+     * how to move to the adjacent pages.
+     *
+     * Page a list by following the URLs below rather than assembling cursors yourself.
+     * For a top-level list endpoint the URL repeats the original request's query
+     * string with only the cursor swapped, so following it preserves the same filters,
+     * search term, and page size.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListPermissionGroup {
+    /**
+     * Resources in this page.
+     */
+    data: Array<PermissionGroup>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo describes where the current page sits within a paginated result set and
+     * how to move to the adjacent pages.
+     *
+     * Page a list by following the URLs below rather than assembling cursors yourself.
+     * For a top-level list endpoint the URL repeats the original request's query
+     * string with only the cursor swapped, so following it preserves the same filters,
+     * search term, and page size.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * One area of the product that access can be granted for, such as customers,
+ * invoices, or production runs.
+ *
+ * A role never grants a permission outright; it grants specific actions on it,
+ * written as `{code}:{action}` — for example `customers:read`.
+ */
+export interface Permission {
+    /**
+     * Permission ID.
+     */
+    id: string;
+    /**
+     * Stable code identifying the area this permission controls, such as `customers`
+     * or `sales_orders`.
+     *
+     * Pair the code with an action (`create`, `read`, `update`, or `delete`) to form
+     * the permission strings used when creating or updating a role.
+     */
+    code: string;
+    /**
+     * When the permission was created.
+     */
+    created_at: string;
+    /**
+     * Human-readable description of what this permission controls.
+     */
+    description: string | null;
+    /**
+     * Code of the permission group this permission is listed under, such as
+     * `inventory`.
+     */
+    group: string;
+    /**
+     * Human-readable name for the permission.
+     */
+    name: string;
+    /**
+     * Resource type identifier.
+     */
+    object: 'permission';
+    /**
+     * When the permission was last updated.
+     */
+    updated_at: string;
+}
+/**
+ * A category of the permission catalog that collects related permissions, such as
+ * inventory or invoices.
+ *
+ * Groups exist to organize the catalog for display; access is always granted by
+ * the individual permissions inside a group, never by the group itself.
+ */
+export interface PermissionGroup {
+    /**
+     * Permission group ID.
+     */
+    id: string;
+    /**
+     * Unique code identifying the permission group, such as `customers`.
+     */
+    code: string;
+    /**
+     * When the permission group was created.
+     */
+    created_at: string;
+    /**
+     * Free-form description of the permission group.
+     */
+    description: string | null;
+    /**
+     * Human-readable name for the permission group.
+     */
+    name: string;
+    /**
+     * Resource type identifier.
+     */
+    object: 'permission_group';
+    /**
+     * Owner describes the provenance of a resource.
+     */
+    owner: APIKeysAPI.Owner | null;
+    /**
+     * A single page of resources, together with the metadata needed to page through
+     * the rest of the result set.
+     */
+    permissions: ListPermission | null;
+    /**
+     * When the permission group was last updated.
+     */
+    updated_at: string;
+}
+export interface IdentityRetrievePermissionGroupsParams {
+    /**
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
+     */
+    cursor?: string;
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'owner'>;
+    /**
+     * Maximum number of results to return in a single page.
+     */
+    limit?: number;
+    /**
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
+     */
+    q?: string;
+}
+export declare namespace Identity {
+    export { type ListPermission as ListPermission, type ListPermissionGroup as ListPermissionGroup, type Permission as Permission, type PermissionGroup as PermissionGroup, type IdentityRetrievePermissionGroupsParams as IdentityRetrievePermissionGroupsParams, };
+    export { AccountUsers as AccountUsers, type CreateAccountUserRequest as CreateAccountUserRequest, type ListAccountUser as ListAccountUser, type NotificationPreferenceItem as NotificationPreferenceItem, type UpdateAccountUserRequest as UpdateAccountUserRequest, type AccountUserListParams as AccountUserListParams, type AccountUserRetrieveParams as AccountUserRetrieveParams, type AccountUserCreateParams as AccountUserCreateParams, type AccountUserUpdateParams as AccountUserUpdateParams, };
+    export { Accounts as Accounts, type AccountUpdateFaviconResponse as AccountUpdateFaviconResponse };
+    export { Roles as Roles, type CreateRoleRequest as CreateRoleRequest, type ListRole as ListRole, type UpdateRoleRequest as UpdateRoleRequest, type RoleDeleteResponse as RoleDeleteResponse, type RoleListParams as RoleListParams, type RoleRetrieveParams as RoleRetrieveParams, type RoleCreateParams as RoleCreateParams, type RoleUpdateParams as RoleUpdateParams, };
+}
+//# sourceMappingURL=identity.d.mts.map

package/resources/identity/identity.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity.d.mts","sourceRoot":"","sources":["../../src/resources/identity/identity.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,4BAA4B,EAAE,QAAQ,EAAE;OAC1C,KAAK,QAAQ;OACb,EACL,iBAAiB,EACjB,QAAQ,EACR,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAChB,KAAK,EACL,iBAAiB,EAClB;OACM,KAAK,UAAU;OACf,KAAK,eAAe;OACpB,EACL,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,uBAAuB,EACvB,YAAY,EACZ,wBAAwB,EACxB,eAAe,EACf,0BAA0B,EAC1B,wBAAwB,EACzB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,YAAY,EAAE,eAAe,CAAC,YAAY,CAAkD;IAC5F,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,CACtB,KAAK,GAAE,sCAAsC,GAAG,IAAI,GAAG,SAAc,EACrE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,WAAW,EAAE,cAAc,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sCAAsC;IACrD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAMD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sCAAsC,IAAI,sCAAsC,GACtF,CAAC;IAEF,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,KAAK,4BAA4B,IAAI,4BAA4B,EAAE,CAAC;IAEnG,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/identity/identity.d.ts

@@ -0,0 +1,207 @@
+import { APIResource } from "../../core/resource.js";
+import * as AccountsAPI from "./accounts.js";
+import { AccountUpdateFaviconResponse, Accounts } from "./accounts.js";
+import * as RolesAPI from "./roles.js";
+import { CreateRoleRequest, ListRole, RoleCreateParams, RoleDeleteResponse, RoleListParams, RoleRetrieveParams, RoleUpdateParams, Roles, UpdateRoleRequest } from "./roles.js";
+import * as APIKeysAPI from "../auth/api-keys/api-keys.js";
+import * as AccountUsersAPI from "./account-users/account-users.js";
+import { AccountUserCreateParams, AccountUserListParams, AccountUserRetrieveParams, AccountUserUpdateParams, AccountUsers, CreateAccountUserRequest, ListAccountUser, NotificationPreferenceItem, UpdateAccountUserRequest } from "./account-users/account-users.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * List permission groups and their permissions.
+ */
+export declare class Identity extends APIResource {
+    accountUsers: AccountUsersAPI.AccountUsers;
+    accounts: AccountsAPI.Accounts;
+    roles: RolesAPI.Roles;
+    /**
+     * Lists the permission catalog, organized into groups of related permissions.
+     *
+     * Each group carries the individual permissions it covers; pair a permission's
+     * code with an action (`create`, `read`, `update`, or `delete`) to build the
+     * permission strings accepted when creating or updating a role. The catalog is
+     * platform-defined and identical for every account.
+     *
+     * This endpoint requires the permission: `permissions:read`.
+     *
+     * @example
+     * ```ts
+     * const listPermissionGroup =
+     *   await client.identity.retrievePermissionGroups();
+     * ```
+     */
+    retrievePermissionGroups(query?: IdentityRetrievePermissionGroupsParams | null | undefined, options?: RequestOptions): APIPromise<ListPermissionGroup>;
+}
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListPermission {
+    /**
+     * Resources in this page.
+     */
+    data: Array<Permission>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo describes where the current page sits within a paginated result set and
+     * how to move to the adjacent pages.
+     *
+     * Page a list by following the URLs below rather than assembling cursors yourself.
+     * For a top-level list endpoint the URL repeats the original request's query
+     * string with only the cursor swapped, so following it preserves the same filters,
+     * search term, and page size.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListPermissionGroup {
+    /**
+     * Resources in this page.
+     */
+    data: Array<PermissionGroup>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo describes where the current page sits within a paginated result set and
+     * how to move to the adjacent pages.
+     *
+     * Page a list by following the URLs below rather than assembling cursors yourself.
+     * For a top-level list endpoint the URL repeats the original request's query
+     * string with only the cursor swapped, so following it preserves the same filters,
+     * search term, and page size.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+/**
+ * One area of the product that access can be granted for, such as customers,
+ * invoices, or production runs.
+ *
+ * A role never grants a permission outright; it grants specific actions on it,
+ * written as `{code}:{action}` — for example `customers:read`.
+ */
+export interface Permission {
+    /**
+     * Permission ID.
+     */
+    id: string;
+    /**
+     * Stable code identifying the area this permission controls, such as `customers`
+     * or `sales_orders`.
+     *
+     * Pair the code with an action (`create`, `read`, `update`, or `delete`) to form
+     * the permission strings used when creating or updating a role.
+     */
+    code: string;
+    /**
+     * When the permission was created.
+     */
+    created_at: string;
+    /**
+     * Human-readable description of what this permission controls.
+     */
+    description: string | null;
+    /**
+     * Code of the permission group this permission is listed under, such as
+     * `inventory`.
+     */
+    group: string;
+    /**
+     * Human-readable name for the permission.
+     */
+    name: string;
+    /**
+     * Resource type identifier.
+     */
+    object: 'permission';
+    /**
+     * When the permission was last updated.
+     */
+    updated_at: string;
+}
+/**
+ * A category of the permission catalog that collects related permissions, such as
+ * inventory or invoices.
+ *
+ * Groups exist to organize the catalog for display; access is always granted by
+ * the individual permissions inside a group, never by the group itself.
+ */
+export interface PermissionGroup {
+    /**
+     * Permission group ID.
+     */
+    id: string;
+    /**
+     * Unique code identifying the permission group, such as `customers`.
+     */
+    code: string;
+    /**
+     * When the permission group was created.
+     */
+    created_at: string;
+    /**
+     * Free-form description of the permission group.
+     */
+    description: string | null;
+    /**
+     * Human-readable name for the permission group.
+     */
+    name: string;
+    /**
+     * Resource type identifier.
+     */
+    object: 'permission_group';
+    /**
+     * Owner describes the provenance of a resource.
+     */
+    owner: APIKeysAPI.Owner | null;
+    /**
+     * A single page of resources, together with the metadata needed to page through
+     * the rest of the result set.
+     */
+    permissions: ListPermission | null;
+    /**
+     * When the permission group was last updated.
+     */
+    updated_at: string;
+}
+export interface IdentityRetrievePermissionGroupsParams {
+    /**
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
+     */
+    cursor?: string;
+    /**
+     * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+     * `null`.
+     */
+    include?: Array<'owner'>;
+    /**
+     * Maximum number of results to return in a single page.
+     */
+    limit?: number;
+    /**
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
+     */
+    q?: string;
+}
+export declare namespace Identity {
+    export { type ListPermission as ListPermission, type ListPermissionGroup as ListPermissionGroup, type Permission as Permission, type PermissionGroup as PermissionGroup, type IdentityRetrievePermissionGroupsParams as IdentityRetrievePermissionGroupsParams, };
+    export { AccountUsers as AccountUsers, type CreateAccountUserRequest as CreateAccountUserRequest, type ListAccountUser as ListAccountUser, type NotificationPreferenceItem as NotificationPreferenceItem, type UpdateAccountUserRequest as UpdateAccountUserRequest, type AccountUserListParams as AccountUserListParams, type AccountUserRetrieveParams as AccountUserRetrieveParams, type AccountUserCreateParams as AccountUserCreateParams, type AccountUserUpdateParams as AccountUserUpdateParams, };
+    export { Accounts as Accounts, type AccountUpdateFaviconResponse as AccountUpdateFaviconResponse };
+    export { Roles as Roles, type CreateRoleRequest as CreateRoleRequest, type ListRole as ListRole, type UpdateRoleRequest as UpdateRoleRequest, type RoleDeleteResponse as RoleDeleteResponse, type RoleListParams as RoleListParams, type RoleRetrieveParams as RoleRetrieveParams, type RoleCreateParams as RoleCreateParams, type RoleUpdateParams as RoleUpdateParams, };
+}
+//# sourceMappingURL=identity.d.ts.map

package/resources/identity/identity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity.d.ts","sourceRoot":"","sources":["../../src/resources/identity/identity.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,4BAA4B,EAAE,QAAQ,EAAE;OAC1C,KAAK,QAAQ;OACb,EACL,iBAAiB,EACjB,QAAQ,EACR,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,kBAAkB,EAClB,gBAAgB,EAChB,KAAK,EACL,iBAAiB,EAClB;OACM,KAAK,UAAU;OACf,KAAK,eAAe;OACpB,EACL,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,uBAAuB,EACvB,YAAY,EACZ,wBAAwB,EACxB,eAAe,EACf,0BAA0B,EAC1B,wBAAwB,EACzB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,YAAY,EAAE,eAAe,CAAC,YAAY,CAAkD;IAC5F,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IACxE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,CACtB,KAAK,GAAE,sCAAsC,GAAG,IAAI,GAAG,SAAc,EACrE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC,KAAK,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,WAAW,EAAE,cAAc,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sCAAsC;IACrD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;CACZ;AAMD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sCAAsC,IAAI,sCAAsC,GACtF,CAAC;IAEF,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,KAAK,4BAA4B,IAAI,4BAA4B,EAAE,CAAC;IAEnG,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/identity/identity.js

@@ -0,0 +1,47 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Identity = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const AccountsAPI = tslib_1.__importStar(require("./accounts.js"));
+const accounts_1 = require("./accounts.js");
+const RolesAPI = tslib_1.__importStar(require("./roles.js"));
+const roles_1 = require("./roles.js");
+const AccountUsersAPI = tslib_1.__importStar(require("./account-users/account-users.js"));
+const account_users_1 = require("./account-users/account-users.js");
+/**
+ * List permission groups and their permissions.
+ */
+class Identity extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.accountUsers = new AccountUsersAPI.AccountUsers(this._client);
+        this.accounts = new AccountsAPI.Accounts(this._client);
+        this.roles = new RolesAPI.Roles(this._client);
+    }
+    /**
+     * Lists the permission catalog, organized into groups of related permissions.
+     *
+     * Each group carries the individual permissions it covers; pair a permission's
+     * code with an action (`create`, `read`, `update`, or `delete`) to build the
+     * permission strings accepted when creating or updating a role. The catalog is
+     * platform-defined and identical for every account.
+     *
+     * This endpoint requires the permission: `permissions:read`.
+     *
+     * @example
+     * ```ts
+     * const listPermissionGroup =
+     *   await client.identity.retrievePermissionGroups();
+     * ```
+     */
+    retrievePermissionGroups(query = {}, options) {
+        return this._client.get('/v1/identity/permission-groups', { query, ...options });
+    }
+}
+exports.Identity = Identity;
+Identity.AccountUsers = account_users_1.AccountUsers;
+Identity.Accounts = accounts_1.Accounts;
+Identity.Roles = roles_1.Roles;
+//# sourceMappingURL=identity.js.map

package/resources/identity/identity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../src/resources/identity/identity.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,mEAA0C;AAC1C,4CAAoE;AACpE,6DAAoC;AACpC,sCAUiB;AAEjB,0FAAiE;AACjE,oEAUuC;AAIvC;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5F,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwB3D,CAAC;IAtBC;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,CACtB,QAAmE,EAAE,EACrE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AA3BD,4BA2BC;AAkMD,QAAQ,CAAC,YAAY,GAAG,4BAAY,CAAC;AACrC,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC;AAC7B,QAAQ,CAAC,KAAK,GAAG,aAAK,CAAC"}

package/resources/identity/identity.mjs

@@ -0,0 +1,42 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as AccountsAPI from "./accounts.mjs";
+import { Accounts } from "./accounts.mjs";
+import * as RolesAPI from "./roles.mjs";
+import { Roles, } from "./roles.mjs";
+import * as AccountUsersAPI from "./account-users/account-users.mjs";
+import { AccountUsers, } from "./account-users/account-users.mjs";
+/**
+ * List permission groups and their permissions.
+ */
+export class Identity extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.accountUsers = new AccountUsersAPI.AccountUsers(this._client);
+        this.accounts = new AccountsAPI.Accounts(this._client);
+        this.roles = new RolesAPI.Roles(this._client);
+    }
+    /**
+     * Lists the permission catalog, organized into groups of related permissions.
+     *
+     * Each group carries the individual permissions it covers; pair a permission's
+     * code with an action (`create`, `read`, `update`, or `delete`) to build the
+     * permission strings accepted when creating or updating a role. The catalog is
+     * platform-defined and identical for every account.
+     *
+     * This endpoint requires the permission: `permissions:read`.
+     *
+     * @example
+     * ```ts
+     * const listPermissionGroup =
+     *   await client.identity.retrievePermissionGroups();
+     * ```
+     */
+    retrievePermissionGroups(query = {}, options) {
+        return this._client.get('/v1/identity/permission-groups', { query, ...options });
+    }
+}
+Identity.AccountUsers = AccountUsers;
+Identity.Accounts = Accounts;
+Identity.Roles = Roles;
+//# sourceMappingURL=identity.mjs.map

package/resources/identity/identity.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"identity.mjs","sourceRoot":"","sources":["../../src/resources/identity/identity.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAgC,QAAQ,EAAE;OAC1C,KAAK,QAAQ;OACb,EAQL,KAAK,GAEN;OAEM,KAAK,eAAe;OACpB,EAKL,YAAY,GAKb;AAID;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5F,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwB3D,CAAC;IAtBC;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,CACtB,QAAmE,EAAE,EACrE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gCAAgC,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AAkMD,QAAQ,CAAC,YAAY,GAAG,YAAY,CAAC;AACrC,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC;AAC7B,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC"}

package/resources/identity/index.d.mts

@@ -0,0 +1,5 @@
+export { AccountUsers, type CreateAccountUserRequest, type ListAccountUser, type NotificationPreferenceItem, type UpdateAccountUserRequest, type AccountUserListParams, type AccountUserRetrieveParams, type AccountUserCreateParams, type AccountUserUpdateParams, } from "./account-users/index.mjs";
+export { Accounts, type AccountUpdateFaviconResponse } from "./accounts.mjs";
+export { Identity, type ListPermission, type ListPermissionGroup, type Permission, type PermissionGroup, type IdentityRetrievePermissionGroupsParams, } from "./identity.mjs";
+export { Roles, type CreateRoleRequest, type ListRole, type UpdateRoleRequest, type RoleDeleteResponse, type RoleListParams, type RoleRetrieveParams, type RoleCreateParams, type RoleUpdateParams, } from "./roles.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/identity/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/identity/index.ts"],"names":[],"mappings":"OAEO,EACL,YAAY,EACZ,KAAK,wBAAwB,EAC7B,KAAK,eAAe,EACpB,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,GAC7B;OACM,EAAE,QAAQ,EAAE,KAAK,4BAA4B,EAAE;OAC/C,EACL,QAAQ,EACR,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,sCAAsC,GAC5C;OACM,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,QAAQ,EACb,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB"}

package/resources/identity/index.d.ts

@@ -0,0 +1,5 @@
+export { AccountUsers, type CreateAccountUserRequest, type ListAccountUser, type NotificationPreferenceItem, type UpdateAccountUserRequest, type AccountUserListParams, type AccountUserRetrieveParams, type AccountUserCreateParams, type AccountUserUpdateParams, } from "./account-users/index.js";
+export { Accounts, type AccountUpdateFaviconResponse } from "./accounts.js";
+export { Identity, type ListPermission, type ListPermissionGroup, type Permission, type PermissionGroup, type IdentityRetrievePermissionGroupsParams, } from "./identity.js";
+export { Roles, type CreateRoleRequest, type ListRole, type UpdateRoleRequest, type RoleDeleteResponse, type RoleListParams, type RoleRetrieveParams, type RoleCreateParams, type RoleUpdateParams, } from "./roles.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/identity/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/identity/index.ts"],"names":[],"mappings":"OAEO,EACL,YAAY,EACZ,KAAK,wBAAwB,EAC7B,KAAK,eAAe,EACpB,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,GAC7B;OACM,EAAE,QAAQ,EAAE,KAAK,4BAA4B,EAAE;OAC/C,EACL,QAAQ,EACR,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,sCAAsC,GAC5C;OACM,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,QAAQ,EACb,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB"}

package/resources/identity/index.js

@@ -0,0 +1,13 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Roles = exports.Identity = exports.Accounts = exports.AccountUsers = void 0;
+var index_1 = require("./account-users/index.js");
+Object.defineProperty(exports, "AccountUsers", { enumerable: true, get: function () { return index_1.AccountUsers; } });
+var accounts_1 = require("./accounts.js");
+Object.defineProperty(exports, "Accounts", { enumerable: true, get: function () { return accounts_1.Accounts; } });
+var identity_1 = require("./identity.js");
+Object.defineProperty(exports, "Identity", { enumerable: true, get: function () { return identity_1.Identity; } });
+var roles_1 = require("./roles.js");
+Object.defineProperty(exports, "Roles", { enumerable: true, get: function () { return roles_1.Roles; } });
+//# sourceMappingURL=index.js.map

package/resources/identity/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/identity/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAU+B;AAT7B,qGAAA,YAAY,OAAA;AAUd,0CAAyE;AAAhE,oGAAA,QAAQ,OAAA;AACjB,0CAOoB;AANlB,oGAAA,QAAQ,OAAA;AAOV,oCAUiB;AATf,8FAAA,KAAK,OAAA"}

package/resources/identity/index.mjs

@@ -0,0 +1,6 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { AccountUsers, } from "./account-users/index.mjs";
+export { Accounts } from "./accounts.mjs";
+export { Identity, } from "./identity.mjs";
+export { Roles, } from "./roles.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/identity/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/identity/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,YAAY,GASb;OACM,EAAE,QAAQ,EAAqC;OAC/C,EACL,QAAQ,GAMT;OACM,EACL,KAAK,GASN"}