@epilot/sdk 2.18.28 → 2.18.29

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.18.28",
+  "version": "2.18.29",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",

package/dist/permissions-X3SJVSPC.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/permissions.json
-var permissions_default = '# Permissions API\n\n- **Full API Docs:** [https://docs.epilot.io/api/permissions](https://docs.epilot.io/api/permissions)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.permissions.listCurrentRoles(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/permissions\'\n\nconst permissionsClient = getClient()\nauthorize(permissionsClient, () => \'<token>\')\nconst { data } = await permissionsClient.listCurrentRoles(...)\n```\n\n## Operations\n\n**Roles**\n- [`listCurrentRoles`](#listcurrentroles)\n- [`listAllRoles`](#listallroles)\n- [`createRole`](#createrole)\n- [`searchRoles`](#searchroles)\n- [`getRole`](#getrole)\n- [`putRole`](#putrole)\n- [`deleteRole`](#deleterole)\n- [`refreshPermissions`](#refreshpermissions)\n\n**Assignments**\n- [`getAssignedRolesForUser`](#getassignedrolesforuser)\n- [`assignRoles`](#assignroles)\n- [`addAssignment`](#addassignment)\n- [`removeAssignment`](#removeassignment)\n- [`listAllAssignments`](#listallassignments)\n\n**Schemas**\n- [`Grant`](#grant)\n- [`GrantWithDependencies`](#grantwithdependencies)\n- [`GrantCondition`](#grantcondition)\n- [`EqualsCurrentUserCondition`](#equalscurrentusercondition)\n- [`EqualsCondition`](#equalscondition)\n- [`RoleId`](#roleid)\n- [`BaseRole`](#baserole)\n- [`BaseRoleForCreate`](#baseroleforcreate)\n- [`UserRole`](#userrole)\n- [`OrgRole`](#orgrole)\n- [`ShareRole`](#sharerole)\n- [`PartnerRole`](#partnerrole)\n- [`PortalRole`](#portalrole)\n- [`Role`](#role)\n- [`RolePayload`](#rolepayload)\n- [`Assignment`](#assignment)\n- [`InternalAssignment`](#internalassignment)\n- [`OrgAssignments`](#orgassignments)\n- [`OrgRoles`](#orgroles)\n- [`Assignments`](#assignments)\n- [`UserId`](#userid)\n- [`OrganizationId`](#organizationid)\n- [`Slug`](#slug)\n- [`RoleSearchInput`](#rolesearchinput)\n- [`CreateRolePayload`](#createrolepayload)\n- [`Error`](#error)\n\n### `listCurrentRoles`\n\nReturns roles and grants assigned to current user\n\n`GET /v1/permissions/me`\n\n```ts\nconst { data } = await client.listCurrentRoles()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "roles": [\n    {\n      "id": "123:owner",\n      "name": "Owner",\n      "slug": "owner",\n      "type": "user_role",\n      "expires_at": "2028-07-21T17:32:28Z",\n      "organization_id": "123",\n      "grants": [\n        {\n          "action": "entity-read",\n          "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n          "effect": "allow",\n          "conditions": [\n            {\n              "attribute": "workflows.primary.task_name",\n              "operation": "equals",\n              "values": ["Qualification"]\n            }\n          ]\n        }\n      ],\n      "parent_role": "123:owner",\n      "vendor_created": true\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `listAllRoles`\n\nReturns list of all roles in organization\n\n`GET /v1/permissions/roles`\n\n```ts\nconst { data } = await client.listAllRoles()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "roles": [\n    {\n      "id": "123:owner",\n      "name": "Owner",\n      "slug": "owner",\n      "type": "user_role",\n      "expires_at": "2028-07-21T17:32:28Z",\n      "organization_id": "123",\n      "grants": [\n        {\n          "action": "entity-read",\n          "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n          "effect": "allow",\n          "conditions": [\n            {\n              "attribute": "workflows.primary.task_name",\n              "operation": "equals",\n              "values": ["Qualification"]\n            }\n          ]\n        }\n      ],\n      "parent_role": "123:owner",\n      "vendor_created": true\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createRole`\n\nCreate role\n\n`POST /v1/permissions/roles`\n\n```ts\nconst { data } = await client.createRole(\n  null,\n  {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "123:owner",\n  "name": "Owner",\n  "slug": "owner",\n  "type": "user_role",\n  "expires_at": "2028-07-21T17:32:28Z",\n  "organization_id": "123",\n  "grants": [\n    {\n      "action": "entity-read",\n      "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n      "effect": "allow",\n      "conditions": [\n        {\n          "attribute": "workflows.primary.task_name",\n          "operation": "equals",\n          "values": ["Qualification"]\n        }\n      ]\n    }\n  ],\n  "parent_role": "123:owner",\n  "vendor_created": true\n}\n```\n\n</details>\n\n---\n\n### `searchRoles`\n\nSearch Roles\n\n`POST /v1/permissions/roles:search`\n\n```ts\nconst { data } = await client.searchRoles(\n  null,\n  {\n    role_ids: [\'123:manager\', \'456:owner\'],\n    org_ids: [\'123\', \'456\'],\n    slugs: [\'manager\', \'owner\'],\n    query: \'Administrator\',\n    limit: 1,\n    offset: 1\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "id": "123:owner",\n      "name": "Owner",\n      "slug": "owner",\n      "type": "user_role",\n      "expires_at": "2028-07-21T17:32:28Z",\n      "organization_id": "123",\n      "grants": [\n        {\n          "action": "entity-read",\n          "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n          "effect": "allow",\n          "conditions": [\n            {\n              "attribute": "workflows.primary.task_name",\n              "operation": "equals",\n              "values": ["Qualification"]\n            }\n          ]\n        }\n      ],\n      "parent_role": "123:owner",\n      "vendor_created": true\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getRole`\n\nGet role by id\n\n`GET /v1/permissions/roles/{roleId}`\n\n```ts\nconst { data } = await client.getRole({\n  roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "123:owner",\n  "name": "Owner",\n  "slug": "owner",\n  "type": "user_role",\n  "expires_at": "2028-07-21T17:32:28Z",\n  "organization_id": "123",\n  "grants": [\n    {\n      "action": "entity-read",\n      "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n      "effect": "allow",\n      "conditions": [\n        {\n          "attribute": "workflows.primary.task_name",\n          "operation": "equals",\n          "values": ["Qualification"]\n        }\n      ]\n    }\n  ],\n  "parent_role": "123:owner",\n  "vendor_created": true\n}\n```\n\n</details>\n\n---\n\n### `putRole`\n\nCreate or update role\n\n`PUT /v1/permissions/roles/{roleId}`\n\n```ts\nconst { data } = await client.putRole(\n  {\n    roleId: \'example\',\n  },\n  {\n    id: \'123:owner\',\n    name: \'Owner\',\n    slug: \'owner\',\n    type: \'user_role\',\n    expires_at: \'2028-07-21T17:32:28Z\',\n    organization_id: \'123\',\n    grants: [\n      {\n        action: \'entity-read\',\n        resource: \'entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947\',\n        effect: \'allow\',\n        conditions: [\n          {\n            attribute: \'workflows.primary.task_name\',\n            operation: \'equals\',\n            values: [\'Qualification\']\n          }\n        ]\n      }\n    ],\n    parent_role: \'123:owner\',\n    vendor_created: true\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "123:owner",\n  "name": "Owner",\n  "slug": "owner",\n  "type": "user_role",\n  "expires_at": "2028-07-21T17:32:28Z",\n  "organization_id": "123",\n  "grants": [\n    {\n      "action": "entity-read",\n      "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n      "effect": "allow",\n      "conditions": [\n        {\n          "attribute": "workflows.primary.task_name",\n          "operation": "equals",\n          "values": ["Qualification"]\n        }\n      ]\n    }\n  ],\n  "parent_role": "123:owner",\n  "vendor_created": true\n}\n```\n\n</details>\n\n---\n\n### `deleteRole`\n\nDelete role by id\n\n`DELETE /v1/permissions/roles/{roleId}`\n\n```ts\nconst { data } = await client.deleteRole({\n  roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "123:owner",\n  "name": "Owner",\n  "slug": "owner",\n  "type": "user_role",\n  "expires_at": "2028-07-21T17:32:28Z",\n  "organization_id": "123",\n  "grants": [\n    {\n      "action": "entity-read",\n      "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n      "effect": "allow",\n      "conditions": [\n        {\n          "attribute": "workflows.primary.task_name",\n          "operation": "equals",\n          "values": ["Qualification"]\n        }\n      ]\n    }\n  ],\n  "parent_role": "123:owner",\n  "vendor_created": true\n}\n```\n\n</details>\n\n---\n\n### `refreshPermissions`\n\nMakes sure the user has a role in the organization\n\n`GET /v1/permissions/refresh`\n\n```ts\nconst { data } = await client.refreshPermissions()\n```\n\n---\n\n### `getAssignedRolesForUser`\n\nGet list of assigned roles by user id\n\n`GET /v1/permissions/assignments/{userId}`\n\n```ts\nconst { data } = await client.getAssignedRolesForUser({\n  userId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n["123:owner"]\n```\n\n</details>\n\n---\n\n### `assignRoles`\n\nAssign / unassign roles to users.\n\n`PUT /v1/permissions/assignments/{userId}`\n\n```ts\nconst { data } = await client.assignRoles(\n  {\n    userId: \'example\',\n  },\n  [\'123:owner\'],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n["123:owner"]\n```\n\n</details>\n\n---\n\n### `addAssignment`\n\nAssign a user to a role.\n\n`POST /v1/permissions/assignments/{userId}/{roleId}`\n\n```ts\nconst { data } = await client.addAssignment({\n  userId: \'example\',\n  roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "user_id": "1",\n  "roles": ["123:owner"]\n}\n```\n\n</details>\n\n---\n\n### `removeAssignment`\n\nRemove role assignment from user\n\n`DELETE /v1/permissions/assignments/{userId}/{roleId}`\n\n```ts\nconst { data } = await client.removeAssignment({\n  userId: \'example\',\n  roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "user_id": "1",\n  "roles": ["123:owner"]\n}\n```\n\n</details>\n\n---\n\n### `listAllAssignments`\n\nReturns list of all assignments in organization\n\n`GET /v1/permissions/assignments`\n\n```ts\nconst { data } = await client.listAllAssignments()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "assignments": [\n    {\n      "user_id": "1",\n      "roles": ["123:owner"]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `Grant`\n\n```ts\ntype Grant = {\n  action: string\n  resource?: string\n  effect?: "allow" | "deny"\n  conditions?: object[]\n}\n```\n\n### `GrantWithDependencies`\n\n```ts\ntype GrantWithDependencies = {\n  action: string\n  resource?: string\n  effect?: "allow" | "deny"\n  conditions?: object[]\n  dependencies?: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n}\n```\n\n### `GrantCondition`\n\n```ts\ntype GrantCondition = object\n```\n\n### `EqualsCurrentUserCondition`\n\nCheck if any relation_user attribute on the entity contains the current user. When attribute is provided, only that specific attribute path is checked.\n\n```ts\ntype EqualsCurrentUserCondition = {\n  attribute?: string\n  operation: "equals_current_user"\n}\n```\n\n### `EqualsCondition`\n\nCheck if attribute equals to any of the values\n\n```ts\ntype EqualsCondition = {\n  attribute: string\n  operation: "equals"\n  values: unknown[]\n}\n```\n\n### `RoleId`\n\nFormat: `<organization_id>`:`<slug>`\n\n```ts\ntype RoleId = string\n```\n\n### `BaseRole`\n\n```ts\ntype BaseRole = {\n  id: string\n  name: string\n  slug: string\n  type: string\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n}\n```\n\n### `BaseRoleForCreate`\n\n```ts\ntype BaseRoleForCreate = {\n  id?: string\n  name: string\n  slug: string\n  type: string\n  expires_at?: string // date-time\n  organization_id?: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n}\n```\n\n### `UserRole`\n\n```ts\ntype UserRole = {\n  id: string\n  name: string\n  slug: string\n  type: "user_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  parent_role?: object\n  vendor_created?: boolean\n}\n```\n\n### `OrgRole`\n\n```ts\ntype OrgRole = {\n  id: string\n  name: string\n  slug: string\n  type: "org_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  pricing_tier?: string\n}\n```\n\n### `ShareRole`\n\n```ts\ntype ShareRole = {\n  id: string\n  name: string\n  slug: string\n  type: "share_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n}\n```\n\n### `PartnerRole`\n\n```ts\ntype PartnerRole = {\n  id: string\n  name: string\n  slug: string\n  type: "partner_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  partner_org_id?: object\n  vendor_enforced_user_limit?: number\n  vendor_created?: boolean\n}\n```\n\n### `PortalRole`\n\n```ts\ntype PortalRole = {\n  id: string\n  name: string\n  slug: string\n  type: "portal_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n}\n```\n\n### `Role`\n\n```ts\ntype Role = {\n  id: string\n  name: string\n  slug: string\n  type: "user_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  parent_role?: object\n  vendor_created?: boolean\n} | {\n  id: string\n  name: string\n  slug: string\n  type: "org_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  pricing_tier?: string\n} | {\n  id: string\n  name: string\n  slug: string\n  type: "share_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n} | {\n  id: string\n  name: string\n  slug: string\n  type: "partner_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  partner_org_id?: object\n  vendor_enforced_user_limit?: number\n  vendor_created?: boolean\n} | {\n  id: string\n  name: string\n  slug: string\n  type: "portal_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n}\n```\n\n### `RolePayload`\n\n```ts\ntype RolePayload = {\n  grants?: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n    dependencies?: Array<{\n      action: { ... }\n      resource?: { ... }\n      effect?: { ... }\n      conditions?: { ... }\n    }>\n  }>\n}\n```\n\n### `Assignment`\n\nA role attached to an user\n\n```ts\ntype Assignment = {\n  user_id?: string\n  roles?: string[]\n}\n```\n\n### `InternalAssignment`\n\nA role attached to an user\n\n```ts\ntype InternalAssignment = {\n  userId?: string\n  roles?: string[]\n}\n```\n\n### `OrgAssignments`\n\nAll roles attached to an users of an organization\n\n```ts\ntype OrgAssignments = {\n  organizationId?: string\n  assignments?: Array<{\n    userId?: string\n    roles?: string[]\n  }>\n}\n```\n\n### `OrgRoles`\n\nAll roles attached to an users of an organization\n\n```ts\ntype OrgRoles = {\n  organizationId?: string\n  roles?: Array<{\n    id: string\n    name: string\n    slug: string\n    type: "user_role"\n    expires_at?: string // date-time\n    organization_id: string\n    grants: Array<{\n      action: { ... }\n      resource?: { ... }\n      effect?: { ... }\n      conditions?: { ... }\n    }>\n    parent_role?: object\n    vendor_created?: boolean\n  } | {\n    id: string\n    name: string\n    slug: string\n    type: "org_role"\n    expires_at?: string // date-time\n    organization_id: string\n    grants: Array<{\n      action: { ... }\n      resource?: { ... }\n      effect?: { ... }\n      conditions?: { ... }\n    }>\n    pricing_tier?: string\n  } | {\n    id: string\n    name: string\n    slug: string\n    type: "share_role"\n    expires_at?: string // date-time\n    organization_id: string\n    grants: Array<{\n      action: { ... }\n      resource?: { ... }\n      effect?: { ... }\n      conditions?: { ... }\n    }>\n  } | {\n    id: string\n    name: string\n    slug: string\n    type: "partner_role"\n    expires_at?: string // date-time\n    organization_id: string\n    grants: Array<{\n      action: { ... }\n      resource?: { ... }\n      effect?: { ... }\n      conditions?: { ... }\n    }>\n    partner_org_id?: object\n    vendor_enforced_user_limit?: number\n    vendor_created?: boolean\n  } | {\n    id: string\n    name: string\n    slug: string\n    type: "portal_role"\n    expires_at?: string // date-time\n    organization_id: string\n    grants: Array<{\n      action: { ... }\n      resource?: { ... }\n      effect?: { ... }\n      conditions?: { ... }\n    }>\n  }>\n}\n```\n\n### `Assignments`\n\nList of role ids attached to an user\n\n```ts\ntype Assignments = string[]\n```\n\n### `UserId`\n\nId of a user\n\n```ts\ntype UserId = string\n```\n\n### `OrganizationId`\n\nId of an organization\n\n```ts\ntype OrganizationId = string\n```\n\n### `Slug`\n\nSlug of a role; for a role with id = 123:manager -> 123 is org_id & manager is slug\n\n```ts\ntype Slug = string\n```\n\n### `RoleSearchInput`\n\n```ts\ntype RoleSearchInput = {\n  role_ids?: string[]\n  org_ids?: string[]\n  slugs?: string[]\n  query?: string\n  limit?: number\n  offset?: number\n}\n```\n\n### `CreateRolePayload`\n\n```ts\ntype CreateRolePayload = {\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  id?: string\n  name: string\n  slug: string\n  type: string\n  expires_at?: string // date-time\n  organization_id?: string\n}\n```\n\n### `Error`\n\nError response\n\n```ts\ntype Error = {\n  message: string\n}\n```\n';
-export {
-  permissions_default as default
-};

package/dist/permissions-ZJHUIBWY.cjs

@@ -1,7 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
-
-// src/docs/permissions.json
-var permissions_default = '# Permissions API\n\n- **Full API Docs:** [https://docs.epilot.io/api/permissions](https://docs.epilot.io/api/permissions)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.permissions.listCurrentRoles(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/permissions\'\n\nconst permissionsClient = getClient()\nauthorize(permissionsClient, () => \'<token>\')\nconst { data } = await permissionsClient.listCurrentRoles(...)\n```\n\n## Operations\n\n**Roles**\n- [`listCurrentRoles`](#listcurrentroles)\n- [`listAllRoles`](#listallroles)\n- [`createRole`](#createrole)\n- [`searchRoles`](#searchroles)\n- [`getRole`](#getrole)\n- [`putRole`](#putrole)\n- [`deleteRole`](#deleterole)\n- [`refreshPermissions`](#refreshpermissions)\n\n**Assignments**\n- [`getAssignedRolesForUser`](#getassignedrolesforuser)\n- [`assignRoles`](#assignroles)\n- [`addAssignment`](#addassignment)\n- [`removeAssignment`](#removeassignment)\n- [`listAllAssignments`](#listallassignments)\n\n**Schemas**\n- [`Grant`](#grant)\n- [`GrantWithDependencies`](#grantwithdependencies)\n- [`GrantCondition`](#grantcondition)\n- [`EqualsCurrentUserCondition`](#equalscurrentusercondition)\n- [`EqualsCondition`](#equalscondition)\n- [`RoleId`](#roleid)\n- [`BaseRole`](#baserole)\n- [`BaseRoleForCreate`](#baseroleforcreate)\n- [`UserRole`](#userrole)\n- [`OrgRole`](#orgrole)\n- [`ShareRole`](#sharerole)\n- [`PartnerRole`](#partnerrole)\n- [`PortalRole`](#portalrole)\n- [`Role`](#role)\n- [`RolePayload`](#rolepayload)\n- [`Assignment`](#assignment)\n- [`InternalAssignment`](#internalassignment)\n- [`OrgAssignments`](#orgassignments)\n- [`OrgRoles`](#orgroles)\n- [`Assignments`](#assignments)\n- [`UserId`](#userid)\n- [`OrganizationId`](#organizationid)\n- [`Slug`](#slug)\n- [`RoleSearchInput`](#rolesearchinput)\n- [`CreateRolePayload`](#createrolepayload)\n- [`Error`](#error)\n\n### `listCurrentRoles`\n\nReturns roles and grants assigned to current user\n\n`GET /v1/permissions/me`\n\n```ts\nconst { data } = await client.listCurrentRoles()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "roles": [\n    {\n      "id": "123:owner",\n      "name": "Owner",\n      "slug": "owner",\n      "type": "user_role",\n      "expires_at": "2028-07-21T17:32:28Z",\n      "organization_id": "123",\n      "grants": [\n        {\n          "action": "entity-read",\n          "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n          "effect": "allow",\n          "conditions": [\n            {\n              "attribute": "workflows.primary.task_name",\n              "operation": "equals",\n              "values": ["Qualification"]\n            }\n          ]\n        }\n      ],\n      "parent_role": "123:owner",\n      "vendor_created": true\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `listAllRoles`\n\nReturns list of all roles in organization\n\n`GET /v1/permissions/roles`\n\n```ts\nconst { data } = await client.listAllRoles()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "roles": [\n    {\n      "id": "123:owner",\n      "name": "Owner",\n      "slug": "owner",\n      "type": "user_role",\n      "expires_at": "2028-07-21T17:32:28Z",\n      "organization_id": "123",\n      "grants": [\n        {\n          "action": "entity-read",\n          "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n          "effect": "allow",\n          "conditions": [\n            {\n              "attribute": "workflows.primary.task_name",\n              "operation": "equals",\n              "values": ["Qualification"]\n            }\n          ]\n        }\n      ],\n      "parent_role": "123:owner",\n      "vendor_created": true\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `createRole`\n\nCreate role\n\n`POST /v1/permissions/roles`\n\n```ts\nconst { data } = await client.createRole(\n  null,\n  {},\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "123:owner",\n  "name": "Owner",\n  "slug": "owner",\n  "type": "user_role",\n  "expires_at": "2028-07-21T17:32:28Z",\n  "organization_id": "123",\n  "grants": [\n    {\n      "action": "entity-read",\n      "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n      "effect": "allow",\n      "conditions": [\n        {\n          "attribute": "workflows.primary.task_name",\n          "operation": "equals",\n          "values": ["Qualification"]\n        }\n      ]\n    }\n  ],\n  "parent_role": "123:owner",\n  "vendor_created": true\n}\n```\n\n</details>\n\n---\n\n### `searchRoles`\n\nSearch Roles\n\n`POST /v1/permissions/roles:search`\n\n```ts\nconst { data } = await client.searchRoles(\n  null,\n  {\n    role_ids: [\'123:manager\', \'456:owner\'],\n    org_ids: [\'123\', \'456\'],\n    slugs: [\'manager\', \'owner\'],\n    query: \'Administrator\',\n    limit: 1,\n    offset: 1\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "hits": 0,\n  "results": [\n    {\n      "id": "123:owner",\n      "name": "Owner",\n      "slug": "owner",\n      "type": "user_role",\n      "expires_at": "2028-07-21T17:32:28Z",\n      "organization_id": "123",\n      "grants": [\n        {\n          "action": "entity-read",\n          "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n          "effect": "allow",\n          "conditions": [\n            {\n              "attribute": "workflows.primary.task_name",\n              "operation": "equals",\n              "values": ["Qualification"]\n            }\n          ]\n        }\n      ],\n      "parent_role": "123:owner",\n      "vendor_created": true\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getRole`\n\nGet role by id\n\n`GET /v1/permissions/roles/{roleId}`\n\n```ts\nconst { data } = await client.getRole({\n  roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "123:owner",\n  "name": "Owner",\n  "slug": "owner",\n  "type": "user_role",\n  "expires_at": "2028-07-21T17:32:28Z",\n  "organization_id": "123",\n  "grants": [\n    {\n      "action": "entity-read",\n      "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n      "effect": "allow",\n      "conditions": [\n        {\n          "attribute": "workflows.primary.task_name",\n          "operation": "equals",\n          "values": ["Qualification"]\n        }\n      ]\n    }\n  ],\n  "parent_role": "123:owner",\n  "vendor_created": true\n}\n```\n\n</details>\n\n---\n\n### `putRole`\n\nCreate or update role\n\n`PUT /v1/permissions/roles/{roleId}`\n\n```ts\nconst { data } = await client.putRole(\n  {\n    roleId: \'example\',\n  },\n  {\n    id: \'123:owner\',\n    name: \'Owner\',\n    slug: \'owner\',\n    type: \'user_role\',\n    expires_at: \'2028-07-21T17:32:28Z\',\n    organization_id: \'123\',\n    grants: [\n      {\n        action: \'entity-read\',\n        resource: \'entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947\',\n        effect: \'allow\',\n        conditions: [\n          {\n            attribute: \'workflows.primary.task_name\',\n            operation: \'equals\',\n            values: [\'Qualification\']\n          }\n        ]\n      }\n    ],\n    parent_role: \'123:owner\',\n    vendor_created: true\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "123:owner",\n  "name": "Owner",\n  "slug": "owner",\n  "type": "user_role",\n  "expires_at": "2028-07-21T17:32:28Z",\n  "organization_id": "123",\n  "grants": [\n    {\n      "action": "entity-read",\n      "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n      "effect": "allow",\n      "conditions": [\n        {\n          "attribute": "workflows.primary.task_name",\n          "operation": "equals",\n          "values": ["Qualification"]\n        }\n      ]\n    }\n  ],\n  "parent_role": "123:owner",\n  "vendor_created": true\n}\n```\n\n</details>\n\n---\n\n### `deleteRole`\n\nDelete role by id\n\n`DELETE /v1/permissions/roles/{roleId}`\n\n```ts\nconst { data } = await client.deleteRole({\n  roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "id": "123:owner",\n  "name": "Owner",\n  "slug": "owner",\n  "type": "user_role",\n  "expires_at": "2028-07-21T17:32:28Z",\n  "organization_id": "123",\n  "grants": [\n    {\n      "action": "entity-read",\n      "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",\n      "effect": "allow",\n      "conditions": [\n        {\n          "attribute": "workflows.primary.task_name",\n          "operation": "equals",\n          "values": ["Qualification"]\n        }\n      ]\n    }\n  ],\n  "parent_role": "123:owner",\n  "vendor_created": true\n}\n```\n\n</details>\n\n---\n\n### `refreshPermissions`\n\nMakes sure the user has a role in the organization\n\n`GET /v1/permissions/refresh`\n\n```ts\nconst { data } = await client.refreshPermissions()\n```\n\n---\n\n### `getAssignedRolesForUser`\n\nGet list of assigned roles by user id\n\n`GET /v1/permissions/assignments/{userId}`\n\n```ts\nconst { data } = await client.getAssignedRolesForUser({\n  userId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n["123:owner"]\n```\n\n</details>\n\n---\n\n### `assignRoles`\n\nAssign / unassign roles to users.\n\n`PUT /v1/permissions/assignments/{userId}`\n\n```ts\nconst { data } = await client.assignRoles(\n  {\n    userId: \'example\',\n  },\n  [\'123:owner\'],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n["123:owner"]\n```\n\n</details>\n\n---\n\n### `addAssignment`\n\nAssign a user to a role.\n\n`POST /v1/permissions/assignments/{userId}/{roleId}`\n\n```ts\nconst { data } = await client.addAssignment({\n  userId: \'example\',\n  roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "user_id": "1",\n  "roles": ["123:owner"]\n}\n```\n\n</details>\n\n---\n\n### `removeAssignment`\n\nRemove role assignment from user\n\n`DELETE /v1/permissions/assignments/{userId}/{roleId}`\n\n```ts\nconst { data } = await client.removeAssignment({\n  userId: \'example\',\n  roleId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "user_id": "1",\n  "roles": ["123:owner"]\n}\n```\n\n</details>\n\n---\n\n### `listAllAssignments`\n\nReturns list of all assignments in organization\n\n`GET /v1/permissions/assignments`\n\n```ts\nconst { data } = await client.listAllAssignments()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "assignments": [\n    {\n      "user_id": "1",\n      "roles": ["123:owner"]\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `Grant`\n\n```ts\ntype Grant = {\n  action: string\n  resource?: string\n  effect?: "allow" | "deny"\n  conditions?: object[]\n}\n```\n\n### `GrantWithDependencies`\n\n```ts\ntype GrantWithDependencies = {\n  action: string\n  resource?: string\n  effect?: "allow" | "deny"\n  conditions?: object[]\n  dependencies?: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n}\n```\n\n### `GrantCondition`\n\n```ts\ntype GrantCondition = object\n```\n\n### `EqualsCurrentUserCondition`\n\nCheck if any relation_user attribute on the entity contains the current user. When attribute is provided, only that specific attribute path is checked.\n\n```ts\ntype EqualsCurrentUserCondition = {\n  attribute?: string\n  operation: "equals_current_user"\n}\n```\n\n### `EqualsCondition`\n\nCheck if attribute equals to any of the values\n\n```ts\ntype EqualsCondition = {\n  attribute: string\n  operation: "equals"\n  values: unknown[]\n}\n```\n\n### `RoleId`\n\nFormat: `<organization_id>`:`<slug>`\n\n```ts\ntype RoleId = string\n```\n\n### `BaseRole`\n\n```ts\ntype BaseRole = {\n  id: string\n  name: string\n  slug: string\n  type: string\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n}\n```\n\n### `BaseRoleForCreate`\n\n```ts\ntype BaseRoleForCreate = {\n  id?: string\n  name: string\n  slug: string\n  type: string\n  expires_at?: string // date-time\n  organization_id?: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n}\n```\n\n### `UserRole`\n\n```ts\ntype UserRole = {\n  id: string\n  name: string\n  slug: string\n  type: "user_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  parent_role?: object\n  vendor_created?: boolean\n}\n```\n\n### `OrgRole`\n\n```ts\ntype OrgRole = {\n  id: string\n  name: string\n  slug: string\n  type: "org_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  pricing_tier?: string\n}\n```\n\n### `ShareRole`\n\n```ts\ntype ShareRole = {\n  id: string\n  name: string\n  slug: string\n  type: "share_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n}\n```\n\n### `PartnerRole`\n\n```ts\ntype PartnerRole = {\n  id: string\n  name: string\n  slug: string\n  type: "partner_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  partner_org_id?: object\n  vendor_enforced_user_limit?: number\n  vendor_created?: boolean\n}\n```\n\n### `PortalRole`\n\n```ts\ntype PortalRole = {\n  id: string\n  name: string\n  slug: string\n  type: "portal_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n}\n```\n\n### `Role`\n\n```ts\ntype Role = {\n  id: string\n  name: string\n  slug: string\n  type: "user_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  parent_role?: object\n  vendor_created?: boolean\n} | {\n  id: string\n  name: string\n  slug: string\n  type: "org_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  pricing_tier?: string\n} | {\n  id: string\n  name: string\n  slug: string\n  type: "share_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n} | {\n  id: string\n  name: string\n  slug: string\n  type: "partner_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  partner_org_id?: object\n  vendor_enforced_user_limit?: number\n  vendor_created?: boolean\n} | {\n  id: string\n  name: string\n  slug: string\n  type: "portal_role"\n  expires_at?: string // date-time\n  organization_id: string\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n}\n```\n\n### `RolePayload`\n\n```ts\ntype RolePayload = {\n  grants?: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n    dependencies?: Array<{\n      action: { ... }\n      resource?: { ... }\n      effect?: { ... }\n      conditions?: { ... }\n    }>\n  }>\n}\n```\n\n### `Assignment`\n\nA role attached to an user\n\n```ts\ntype Assignment = {\n  user_id?: string\n  roles?: string[]\n}\n```\n\n### `InternalAssignment`\n\nA role attached to an user\n\n```ts\ntype InternalAssignment = {\n  userId?: string\n  roles?: string[]\n}\n```\n\n### `OrgAssignments`\n\nAll roles attached to an users of an organization\n\n```ts\ntype OrgAssignments = {\n  organizationId?: string\n  assignments?: Array<{\n    userId?: string\n    roles?: string[]\n  }>\n}\n```\n\n### `OrgRoles`\n\nAll roles attached to an users of an organization\n\n```ts\ntype OrgRoles = {\n  organizationId?: string\n  roles?: Array<{\n    id: string\n    name: string\n    slug: string\n    type: "user_role"\n    expires_at?: string // date-time\n    organization_id: string\n    grants: Array<{\n      action: { ... }\n      resource?: { ... }\n      effect?: { ... }\n      conditions?: { ... }\n    }>\n    parent_role?: object\n    vendor_created?: boolean\n  } | {\n    id: string\n    name: string\n    slug: string\n    type: "org_role"\n    expires_at?: string // date-time\n    organization_id: string\n    grants: Array<{\n      action: { ... }\n      resource?: { ... }\n      effect?: { ... }\n      conditions?: { ... }\n    }>\n    pricing_tier?: string\n  } | {\n    id: string\n    name: string\n    slug: string\n    type: "share_role"\n    expires_at?: string // date-time\n    organization_id: string\n    grants: Array<{\n      action: { ... }\n      resource?: { ... }\n      effect?: { ... }\n      conditions?: { ... }\n    }>\n  } | {\n    id: string\n    name: string\n    slug: string\n    type: "partner_role"\n    expires_at?: string // date-time\n    organization_id: string\n    grants: Array<{\n      action: { ... }\n      resource?: { ... }\n      effect?: { ... }\n      conditions?: { ... }\n    }>\n    partner_org_id?: object\n    vendor_enforced_user_limit?: number\n    vendor_created?: boolean\n  } | {\n    id: string\n    name: string\n    slug: string\n    type: "portal_role"\n    expires_at?: string // date-time\n    organization_id: string\n    grants: Array<{\n      action: { ... }\n      resource?: { ... }\n      effect?: { ... }\n      conditions?: { ... }\n    }>\n  }>\n}\n```\n\n### `Assignments`\n\nList of role ids attached to an user\n\n```ts\ntype Assignments = string[]\n```\n\n### `UserId`\n\nId of a user\n\n```ts\ntype UserId = string\n```\n\n### `OrganizationId`\n\nId of an organization\n\n```ts\ntype OrganizationId = string\n```\n\n### `Slug`\n\nSlug of a role; for a role with id = 123:manager -> 123 is org_id & manager is slug\n\n```ts\ntype Slug = string\n```\n\n### `RoleSearchInput`\n\n```ts\ntype RoleSearchInput = {\n  role_ids?: string[]\n  org_ids?: string[]\n  slugs?: string[]\n  query?: string\n  limit?: number\n  offset?: number\n}\n```\n\n### `CreateRolePayload`\n\n```ts\ntype CreateRolePayload = {\n  grants: Array<{\n    action: string\n    resource?: string\n    effect?: "allow" | "deny"\n    conditions?: object[]\n  }>\n  id?: string\n  name: string\n  slug: string\n  type: string\n  expires_at?: string // date-time\n  organization_id?: string\n}\n```\n\n### `Error`\n\nError response\n\n```ts\ntype Error = {\n  message: string\n}\n```\n';
-
-
-exports.default = permissions_default;