@epilot/sdk 2.1.1 → 2.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/partner-directory-runtime.json +1 -1
- package/definitions/partner-directory.json +795 -229
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-management.cjs +6 -6
- package/dist/apis/data-management.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/erp-integration.cjs +6 -6
- package/dist/apis/erp-integration.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +8 -8
- package/dist/apis/partner-directory.d.cts +2 -2
- package/dist/apis/partner-directory.d.ts +2 -2
- package/dist/apis/partner-directory.js +2 -2
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/bin/cli.js +1 -1
- package/dist/{chunk-F5JVW2D5.cjs → chunk-BFUNXZRX.cjs} +1 -1
- package/dist/{chunk-AUH6NP6Y.js → chunk-I2XRA5AM.js} +1 -1
- package/dist/{chunk-NBYH536J.js → chunk-QTU4H6NQ.js} +2 -2
- package/dist/{chunk-WSZWUQDD.cjs → chunk-T7LQKRUK.cjs} +2 -2
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
- package/dist/partner-directory-THI7JEXK.js +7 -0
- package/dist/partner-directory-ZQIBKD5Q.cjs +7 -0
- package/dist/{partner-directory-runtime-RSONSDNJ.cjs → partner-directory-runtime-AUHVA5Q3.cjs} +2 -2
- package/dist/{partner-directory-runtime-QURDOO4Z.js → partner-directory-runtime-GNVT7U7R.js} +1 -1
- package/dist/partner-directory.d-BCIjHoGs.d.cts +2337 -0
- package/dist/partner-directory.d-BCIjHoGs.d.ts +2337 -0
- package/docs/partner-directory.md +295 -127
- package/package.json +1 -1
- package/dist/partner-directory-2XMPQWWX.js +0 -7
- package/dist/partner-directory-WHNTKQ5E.cjs +0 -7
- package/dist/partner-directory.d-CRNkDF8q.d.cts +0 -1510
- package/dist/partner-directory.d-CRNkDF8q.d.ts +0 -1510
package/package.json
CHANGED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import "./chunk-YPSWSI3M.js";
|
|
2
|
-
|
|
3
|
-
// src/docs/partner-directory.json
|
|
4
|
-
var partner_directory_default = '# Partner API\n\n- **Base URL:** `https://partner-directory-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/partner-directory](https://docs.epilot.io/api/partner-directory)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.partnerDirectory.approvePartner(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/partner-directory\'\n\nconst partnerDirectoryClient = getClient()\nauthorize(partnerDirectoryClient, () => \'<token>\')\nconst { data } = await partnerDirectoryClient.approvePartner(...)\n```\n\n## Operations\n\n**partners**\n- [`approvePartner`](#approvepartner)\n- [`rejectPartner`](#rejectpartner)\n- [`searchAssignable`](#searchassignable)\n- [`batchGetAssignable`](#batchgetassignable)\n- [`getPartnerByToken`](#getpartnerbytoken)\n- [`activatePartner`](#activatepartner)\n- [`searchGeolocationForText`](#searchgeolocationfortext)\n- [`invitePartnerV2`](#invitepartnerv2)\n\n**partner_users**\n- [`getPartnerUsers`](#getpartnerusers)\n- [`createPartnerUser`](#createpartneruser)\n- [`deletePartnerUser`](#deletepartneruser)\n- [`getPartnerRoles`](#getpartnerroles)\n- [`createPartnerRole`](#createpartnerrole)\n- [`updatePartnerRole`](#updatepartnerrole)\n- [`assignPartnerUserRoles`](#assignpartneruserroles)\n- [`unassignPartnerUserRoles`](#unassignpartneruserroles)\n\n**Schemas**\n- [`InviteToken`](#invitetoken)\n- [`Partner`](#partner)\n- [`PartnerId`](#partnerid)\n- [`OrganizationId`](#organizationid)\n- [`ActivatePartnerPayload`](#activatepartnerpayload)\n- [`PartnerInvitationPayload`](#partnerinvitationpayload)\n- [`Assignable`](#assignable)\n- [`BaseAssignable`](#baseassignable)\n- [`AssignableUser`](#assignableuser)\n- [`AssignablePartnerUser`](#assignablepartneruser)\n- [`AssignableGroup`](#assignablegroup)\n- [`AssignableOrganization`](#assignableorganization)\n- [`AssignableEcpPlaceholder`](#assignableecpplaceholder)\n- [`SearchGeolocation`](#searchgeolocation)\n- [`Geolocation`](#geolocation)\n- [`Address`](#address)\n- [`AddressGeolocation`](#addressgeolocation)\n- [`PartnerUser`](#partneruser)\n- [`CreatePartnerUserPayload`](#createpartneruserpayload)\n- [`CreatePartnerRolePayload`](#createpartnerrolepayload)\n- [`UpdatePartnerRolePayload`](#updatepartnerrolepayload)\n- [`Grant`](#grant)\n- [`GrantWithDependencies`](#grantwithdependencies)\n- [`GrantCondition`](#grantcondition)\n- [`EqualsCondition`](#equalscondition)\n- [`RoleId`](#roleid)\n- [`BaseRoleForCreate`](#baseroleforcreate)\n- [`PartnerRole`](#partnerrole)\n- [`AssignRolesPayload`](#assignrolespayload)\n- [`User`](#user)\n\n### `approvePartner`\n\nApprove partner request\n\n`POST /v1/partners/{id}/approve`\n\n```ts\nconst { data } = await client.approvePartner({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `rejectPartner`\n\nReject partner request\n\n`POST /v1/partners/{id}/reject`\n\n```ts\nconst { data } = await client.rejectPartner({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `searchAssignable`\n\nsearchAssignables\n\n`POST /v1/partners/assignables:search`\n\n```ts\nconst { data } = await client.searchAssignable(\n null,\n {\n q: \'\',\n from: 0,\n size: 25,\n org_ids: [\'123\'],\n portalUsersEntityIdScope: \'\',\n types: [\'user\', \'partner_user\', \'partner_organization\', \'ecp\', \'group\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 25,\n "results": [\n {\n "type": "user",\n "display_name": "Example User",\n "image_uri": {\n "original": "https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png",\n "thumbnail_32": "https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png"\n },\n "org_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "activated_at": "2022-02-08T04:44:32.246Z",\n "status": "Active",\n "user_id": "456",\n "email": "example@example.com"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `batchGetAssignable`\n\nbatchGet\n\n`POST /v1/partners/assignables:batchGet`\n\n```ts\nconst { data } = await client.batchGetAssignable(\n null,\n [\n {\n user_id: \'string\',\n org_id: \'string\',\n group_id: \'string\'\n }\n ],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 25,\n "results": [\n {\n "type": "user",\n "display_name": "Example User",\n "image_uri": {\n "original": "https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png",\n "thumbnail_32": "https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png"\n },\n "org_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "activated_at": "2022-02-08T04:44:32.246Z",\n "status": "Active",\n "user_id": "456",\n "email": "example@example.com"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getPartnerByToken`\n\nGet partner by token\n\n`GET /v1/partner-directory/public/getPartnerByToken`\n\n```ts\nconst { data } = await client.getPartnerByToken({\n token: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `activatePartner`\n\nActivate partner using an invite token\n\n`POST /v1/partner-directory/public/activate`\n\n```ts\nconst { data } = await client.activatePartner(\n {\n token: \'example\',\n },\n {\n company_name: \'Company name\',\n signed_up_email: \'user@example.com\',\n organization_id: \'string\'\n },\n)\n```\n\n---\n\n### `searchGeolocationForText`\n\nConverts a given string, in the format of an address, to geo-location latitude and longitude\n\n`POST /v1/geolocation/text:search`\n\n```ts\nconst { data } = await client.searchGeolocationForText(\n null,\n {\n address: \'Auweg 1, 93055 Regensburg, DE\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "lat": 49.013,\n "lng": 12.101,\n "addressLabel": "string",\n "relevance": 0\n}\n```\n\n</details>\n\n---\n\n### `invitePartnerV2`\n\nInvite a partner into collaboration. It will send an email to partner and ask to join into collaboration\n\n`POST /v2/partners/{id}/invite`\n\n```ts\nconst { data } = await client.invitePartnerV2(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n language: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `getPartnerUsers`\n\nGet all users for a partner organization with their roles\n\n`GET /v2/partners/{orgId}/users`\n\n```ts\nconst { data } = await client.getPartnerUsers({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "456",\n "name": "John Doe",\n "email": "user@example.com",\n "status": "Active",\n "image": {\n "original": "https://example.com/path",\n "thumbnail_32": "https://example.com/path"\n },\n "roles": [\n {\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator"\n }\n ]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createPartnerUser`\n\nCreate a new user in a partner organization\n\n`POST /v2/partners/{orgId}/users`\n\n```ts\nconst { data } = await client.createPartnerUser(\n {\n orgId: \'example\',\n },\n {\n email: \'user@example.com\',\n language: \'en\',\n roles: [\'role-123\', \'role-456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "456",\n "email": "user@example.com",\n "display_name": "John Doe",\n "status": "Active"\n}\n```\n\n</details>\n\n---\n\n### `deletePartnerUser`\n\nDelete a user from a partner organization\n\n`DELETE /v2/partners/{orgId}/users/{userId}`\n\n```ts\nconst { data } = await client.deletePartnerUser({\n orgId: \'example\',\n userId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `getPartnerRoles`\n\nGet all roles for a partner organization\n\n`GET /v2/partners/{orgId}/roles`\n\n```ts\nconst { data } = await client.getPartnerRoles({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator",\n "type": "share_role"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createPartnerRole`\n\nCreate a role for a partner organization\n\n`POST /v2/partners/{orgId}/roles`\n\n```ts\nconst { data } = await client.createPartnerRole(\n {\n orgId: \'example\',\n },\n {\n name: \'Partner Admin\',\n slug: \'partner_admin\',\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 dependencies: [\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 }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator",\n "type": "share_role"\n}\n```\n\n</details>\n\n---\n\n### `updatePartnerRole`\n\nUpdate a role for a partner organization\n\n`PUT /v2/partners/{orgId}/roles/{roleId}`\n\n```ts\nconst { data } = await client.updatePartnerRole(\n {\n orgId: \'example\',\n roleId: \'example\',\n },\n {\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 dependencies: [\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 }\n ],\n id: \'123:owner\',\n name: \'Owner\',\n slug: \'owner\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator",\n "type": "share_role"\n}\n```\n\n</details>\n\n---\n\n### `assignPartnerUserRoles`\n\nAssign roles to a user in a partner organization\n\n`POST /v2/partners/{orgId}/users/{userId}/roles`\n\n```ts\nconst { data } = await client.assignPartnerUserRoles(\n {\n orgId: \'example\',\n userId: \'example\',\n },\n {\n roleIds: [\'role-123\', \'role-456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "roleId": "string",\n "success": true,\n "data": {},\n "error": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `unassignPartnerUserRoles`\n\nUnassign roles from a user in a partner organization\n\n`DELETE /v2/partners/{orgId}/users/{userId}/roles`\n\n```ts\nconst { data } = await client.unassignPartnerUserRoles(\n {\n orgId: \'example\',\n userId: \'example\',\n },\n {\n roleIds: [\'role-123\', \'role-456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "roleId": "string",\n "success": true,\n "data": {},\n "error": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `InviteToken`\n\n```ts\ntype InviteToken = string\n```\n\n### `Partner`\n\n```ts\ntype Partner = {\n id?: string\n organization_id?: string\n created_at?: string\n description?: string\n company_name?: string\n invitation_token?: string\n invitation_email?: string // email\n email?: string // email\n owner_email?: string // email\n signed_up_email?: string // email\n partner_org_id?: string\n status?: "Pending" | "Request" | "Deleted" | "Invited" | "Rejected"\n}\n```\n\n### `PartnerId`\n\n```ts\ntype PartnerId = string\n```\n\n### `OrganizationId`\n\n```ts\ntype OrganizationId = string\n```\n\n### `ActivatePartnerPayload`\n\n```ts\ntype ActivatePartnerPayload = {\n company_name?: string\n signed_up_email: string // email\n organization_id: string\n}\n```\n\n### `PartnerInvitationPayload`\n\n```ts\ntype PartnerInvitationPayload = {\n language?: "en" | "de"\n}\n```\n\n### `Assignable`\n\n```ts\ntype Assignable = {\n type: "user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id?: string\n email?: string\n} | {\n type: "partner_user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id?: string\n user_id?: string\n email?: string\n} | {\n type: "partner_organization"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id: string\n email?: string\n geolocations?: Array<{\n address?: {\n street?: { ... }\n street_number?: { ... }\n city?: { ... }\n postal_code?: { ... }\n country?: { ... }\n }\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n }>\n phone?: string\n activity_radius?: number\n} | {\n type: "ecp"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id: string\n email?: string\n} | {\n type: string\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n group_id?: string\n}\n```\n\n### `BaseAssignable`\n\n```ts\ntype BaseAssignable = {\n type: string\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n}\n```\n\n### `AssignableUser`\n\n```ts\ntype AssignableUser = {\n type: "user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id?: string\n email?: string\n}\n```\n\n### `AssignablePartnerUser`\n\n```ts\ntype AssignablePartnerUser = {\n type: "partner_user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id?: string\n user_id?: string\n email?: string\n}\n```\n\n### `AssignableGroup`\n\n```ts\ntype AssignableGroup = {\n type: string\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n group_id?: string\n}\n```\n\n### `AssignableOrganization`\n\n```ts\ntype AssignableOrganization = {\n type: "partner_organization"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id: string\n email?: string\n geolocations?: Array<{\n address?: {\n street?: { ... }\n street_number?: { ... }\n city?: { ... }\n postal_code?: { ... }\n country?: { ... }\n }\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n }>\n phone?: string\n activity_radius?: number\n}\n```\n\n### `AssignableEcpPlaceholder`\n\n```ts\ntype AssignableEcpPlaceholder = {\n type: "ecp"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id: string\n email?: string\n}\n```\n\n### `SearchGeolocation`\n\n```ts\ntype SearchGeolocation = {\n address: string\n}\n```\n\n### `Geolocation`\n\n```ts\ntype Geolocation = {\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n}\n```\n\n### `Address`\n\n```ts\ntype Address = {\n street?: string\n street_number?: string\n city?: string\n postal_code?: string\n country?: string\n}\n```\n\n### `AddressGeolocation`\n\n```ts\ntype AddressGeolocation = {\n address?: {\n street?: string\n street_number?: string\n city?: string\n postal_code?: string\n country?: string\n }\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n}\n```\n\n### `PartnerUser`\n\n```ts\ntype PartnerUser = {\n id: string\n name?: string\n email: string // email\n status: string\n image?: {\n original?: string // uri\n thumbnail_32?: string // uri\n }\n roles: Array<{\n id: string\n slug: string\n name: string\n }>\n}\n```\n\n### `CreatePartnerUserPayload`\n\n```ts\ntype CreatePartnerUserPayload = {\n email: string // email\n language?: "en" | "de"\n roles?: string[]\n}\n```\n\n### `CreatePartnerRolePayload`\n\n```ts\ntype CreatePartnerRolePayload = {\n name: string\n slug: string\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### `UpdatePartnerRolePayload`\n\n```ts\ntype UpdatePartnerRolePayload = {\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}\n```\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### `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### `BaseRoleForCreate`\n\n```ts\ntype BaseRoleForCreate = {\n id?: string\n name: string\n slug: 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 slug: string\n name: string\n type?: string\n}\n```\n\n### `AssignRolesPayload`\n\n```ts\ntype AssignRolesPayload = {\n roleIds: string[]\n}\n```\n\n### `User`\n\n```ts\ntype User = {\n id?: string\n email?: string // email\n display_name?: string\n status?: string\n}\n```\n';
|
|
5
|
-
export {
|
|
6
|
-
partner_directory_default as default
|
|
7
|
-
};
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
-
|
|
3
|
-
// src/docs/partner-directory.json
|
|
4
|
-
var partner_directory_default = '# Partner API\n\n- **Base URL:** `https://partner-directory-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/partner-directory](https://docs.epilot.io/api/partner-directory)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.partnerDirectory.approvePartner(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/partner-directory\'\n\nconst partnerDirectoryClient = getClient()\nauthorize(partnerDirectoryClient, () => \'<token>\')\nconst { data } = await partnerDirectoryClient.approvePartner(...)\n```\n\n## Operations\n\n**partners**\n- [`approvePartner`](#approvepartner)\n- [`rejectPartner`](#rejectpartner)\n- [`searchAssignable`](#searchassignable)\n- [`batchGetAssignable`](#batchgetassignable)\n- [`getPartnerByToken`](#getpartnerbytoken)\n- [`activatePartner`](#activatepartner)\n- [`searchGeolocationForText`](#searchgeolocationfortext)\n- [`invitePartnerV2`](#invitepartnerv2)\n\n**partner_users**\n- [`getPartnerUsers`](#getpartnerusers)\n- [`createPartnerUser`](#createpartneruser)\n- [`deletePartnerUser`](#deletepartneruser)\n- [`getPartnerRoles`](#getpartnerroles)\n- [`createPartnerRole`](#createpartnerrole)\n- [`updatePartnerRole`](#updatepartnerrole)\n- [`assignPartnerUserRoles`](#assignpartneruserroles)\n- [`unassignPartnerUserRoles`](#unassignpartneruserroles)\n\n**Schemas**\n- [`InviteToken`](#invitetoken)\n- [`Partner`](#partner)\n- [`PartnerId`](#partnerid)\n- [`OrganizationId`](#organizationid)\n- [`ActivatePartnerPayload`](#activatepartnerpayload)\n- [`PartnerInvitationPayload`](#partnerinvitationpayload)\n- [`Assignable`](#assignable)\n- [`BaseAssignable`](#baseassignable)\n- [`AssignableUser`](#assignableuser)\n- [`AssignablePartnerUser`](#assignablepartneruser)\n- [`AssignableGroup`](#assignablegroup)\n- [`AssignableOrganization`](#assignableorganization)\n- [`AssignableEcpPlaceholder`](#assignableecpplaceholder)\n- [`SearchGeolocation`](#searchgeolocation)\n- [`Geolocation`](#geolocation)\n- [`Address`](#address)\n- [`AddressGeolocation`](#addressgeolocation)\n- [`PartnerUser`](#partneruser)\n- [`CreatePartnerUserPayload`](#createpartneruserpayload)\n- [`CreatePartnerRolePayload`](#createpartnerrolepayload)\n- [`UpdatePartnerRolePayload`](#updatepartnerrolepayload)\n- [`Grant`](#grant)\n- [`GrantWithDependencies`](#grantwithdependencies)\n- [`GrantCondition`](#grantcondition)\n- [`EqualsCondition`](#equalscondition)\n- [`RoleId`](#roleid)\n- [`BaseRoleForCreate`](#baseroleforcreate)\n- [`PartnerRole`](#partnerrole)\n- [`AssignRolesPayload`](#assignrolespayload)\n- [`User`](#user)\n\n### `approvePartner`\n\nApprove partner request\n\n`POST /v1/partners/{id}/approve`\n\n```ts\nconst { data } = await client.approvePartner({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `rejectPartner`\n\nReject partner request\n\n`POST /v1/partners/{id}/reject`\n\n```ts\nconst { data } = await client.rejectPartner({\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `searchAssignable`\n\nsearchAssignables\n\n`POST /v1/partners/assignables:search`\n\n```ts\nconst { data } = await client.searchAssignable(\n null,\n {\n q: \'\',\n from: 0,\n size: 25,\n org_ids: [\'123\'],\n portalUsersEntityIdScope: \'\',\n types: [\'user\', \'partner_user\', \'partner_organization\', \'ecp\', \'group\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 25,\n "results": [\n {\n "type": "user",\n "display_name": "Example User",\n "image_uri": {\n "original": "https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png",\n "thumbnail_32": "https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png"\n },\n "org_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "activated_at": "2022-02-08T04:44:32.246Z",\n "status": "Active",\n "user_id": "456",\n "email": "example@example.com"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `batchGetAssignable`\n\nbatchGet\n\n`POST /v1/partners/assignables:batchGet`\n\n```ts\nconst { data } = await client.batchGetAssignable(\n null,\n [\n {\n user_id: \'string\',\n org_id: \'string\',\n group_id: \'string\'\n }\n ],\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 25,\n "results": [\n {\n "type": "user",\n "display_name": "Example User",\n "image_uri": {\n "original": "https://epilot-staging-user-content.s3.eu-central-1.amazonaws.com/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png",\n "thumbnail_32": "https://file.sls.epilot.io/v1/files/public/preview?w=32&h=32&key=/728/8043d909-71fc-4838-a363-1b15dc1d585c/epilot.png"\n },\n "org_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "activated_at": "2022-02-08T04:44:32.246Z",\n "status": "Active",\n "user_id": "456",\n "email": "example@example.com"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getPartnerByToken`\n\nGet partner by token\n\n`GET /v1/partner-directory/public/getPartnerByToken`\n\n```ts\nconst { data } = await client.getPartnerByToken({\n token: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `activatePartner`\n\nActivate partner using an invite token\n\n`POST /v1/partner-directory/public/activate`\n\n```ts\nconst { data } = await client.activatePartner(\n {\n token: \'example\',\n },\n {\n company_name: \'Company name\',\n signed_up_email: \'user@example.com\',\n organization_id: \'string\'\n },\n)\n```\n\n---\n\n### `searchGeolocationForText`\n\nConverts a given string, in the format of an address, to geo-location latitude and longitude\n\n`POST /v1/geolocation/text:search`\n\n```ts\nconst { data } = await client.searchGeolocationForText(\n null,\n {\n address: \'Auweg 1, 93055 Regensburg, DE\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "lat": 49.013,\n "lng": 12.101,\n "addressLabel": "string",\n "relevance": 0\n}\n```\n\n</details>\n\n---\n\n### `invitePartnerV2`\n\nInvite a partner into collaboration. It will send an email to partner and ask to join into collaboration\n\n`POST /v2/partners/{id}/invite`\n\n```ts\nconst { data } = await client.invitePartnerV2(\n {\n id: \'123e4567-e89b-12d3-a456-426614174000\',\n },\n {\n language: \'en\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "e45a6dc2-3795-43a3-ae0f-6b6760f310fc",\n "organization_id": "123",\n "created_at": "2022-02-08T04:44:32.246Z",\n "description": "Description",\n "company_name": "Company name",\n "invitation_token": "string",\n "invitation_email": "user@example.com",\n "email": "user@example.com",\n "owner_email": "user@example.com",\n "signed_up_email": "user@example.com",\n "partner_org_id": 123456,\n "status": "Pending"\n}\n```\n\n</details>\n\n---\n\n### `getPartnerUsers`\n\nGet all users for a partner organization with their roles\n\n`GET /v2/partners/{orgId}/users`\n\n```ts\nconst { data } = await client.getPartnerUsers({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "456",\n "name": "John Doe",\n "email": "user@example.com",\n "status": "Active",\n "image": {\n "original": "https://example.com/path",\n "thumbnail_32": "https://example.com/path"\n },\n "roles": [\n {\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator"\n }\n ]\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createPartnerUser`\n\nCreate a new user in a partner organization\n\n`POST /v2/partners/{orgId}/users`\n\n```ts\nconst { data } = await client.createPartnerUser(\n {\n orgId: \'example\',\n },\n {\n email: \'user@example.com\',\n language: \'en\',\n roles: [\'role-123\', \'role-456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "456",\n "email": "user@example.com",\n "display_name": "John Doe",\n "status": "Active"\n}\n```\n\n</details>\n\n---\n\n### `deletePartnerUser`\n\nDelete a user from a partner organization\n\n`DELETE /v2/partners/{orgId}/users/{userId}`\n\n```ts\nconst { data } = await client.deletePartnerUser({\n orgId: \'example\',\n userId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{}\n```\n\n</details>\n\n---\n\n### `getPartnerRoles`\n\nGet all roles for a partner organization\n\n`GET /v2/partners/{orgId}/roles`\n\n```ts\nconst { data } = await client.getPartnerRoles({\n orgId: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator",\n "type": "share_role"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createPartnerRole`\n\nCreate a role for a partner organization\n\n`POST /v2/partners/{orgId}/roles`\n\n```ts\nconst { data } = await client.createPartnerRole(\n {\n orgId: \'example\',\n },\n {\n name: \'Partner Admin\',\n slug: \'partner_admin\',\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 dependencies: [\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 }\n ]\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator",\n "type": "share_role"\n}\n```\n\n</details>\n\n---\n\n### `updatePartnerRole`\n\nUpdate a role for a partner organization\n\n`PUT /v2/partners/{orgId}/roles/{roleId}`\n\n```ts\nconst { data } = await client.updatePartnerRole(\n {\n orgId: \'example\',\n roleId: \'example\',\n },\n {\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 dependencies: [\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 }\n ],\n id: \'123:owner\',\n name: \'Owner\',\n slug: \'owner\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "id": "role-123",\n "slug": "admin",\n "name": "Administrator",\n "type": "share_role"\n}\n```\n\n</details>\n\n---\n\n### `assignPartnerUserRoles`\n\nAssign roles to a user in a partner organization\n\n`POST /v2/partners/{orgId}/users/{userId}/roles`\n\n```ts\nconst { data } = await client.assignPartnerUserRoles(\n {\n orgId: \'example\',\n userId: \'example\',\n },\n {\n roleIds: [\'role-123\', \'role-456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "roleId": "string",\n "success": true,\n "data": {},\n "error": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `unassignPartnerUserRoles`\n\nUnassign roles from a user in a partner organization\n\n`DELETE /v2/partners/{orgId}/users/{userId}/roles`\n\n```ts\nconst { data } = await client.unassignPartnerUserRoles(\n {\n orgId: \'example\',\n userId: \'example\',\n },\n {\n roleIds: [\'role-123\', \'role-456\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "roleId": "string",\n "success": true,\n "data": {},\n "error": {}\n }\n ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `InviteToken`\n\n```ts\ntype InviteToken = string\n```\n\n### `Partner`\n\n```ts\ntype Partner = {\n id?: string\n organization_id?: string\n created_at?: string\n description?: string\n company_name?: string\n invitation_token?: string\n invitation_email?: string // email\n email?: string // email\n owner_email?: string // email\n signed_up_email?: string // email\n partner_org_id?: string\n status?: "Pending" | "Request" | "Deleted" | "Invited" | "Rejected"\n}\n```\n\n### `PartnerId`\n\n```ts\ntype PartnerId = string\n```\n\n### `OrganizationId`\n\n```ts\ntype OrganizationId = string\n```\n\n### `ActivatePartnerPayload`\n\n```ts\ntype ActivatePartnerPayload = {\n company_name?: string\n signed_up_email: string // email\n organization_id: string\n}\n```\n\n### `PartnerInvitationPayload`\n\n```ts\ntype PartnerInvitationPayload = {\n language?: "en" | "de"\n}\n```\n\n### `Assignable`\n\n```ts\ntype Assignable = {\n type: "user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id?: string\n email?: string\n} | {\n type: "partner_user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id?: string\n user_id?: string\n email?: string\n} | {\n type: "partner_organization"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id: string\n email?: string\n geolocations?: Array<{\n address?: {\n street?: { ... }\n street_number?: { ... }\n city?: { ... }\n postal_code?: { ... }\n country?: { ... }\n }\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n }>\n phone?: string\n activity_radius?: number\n} | {\n type: "ecp"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id: string\n email?: string\n} | {\n type: string\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n group_id?: string\n}\n```\n\n### `BaseAssignable`\n\n```ts\ntype BaseAssignable = {\n type: string\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n}\n```\n\n### `AssignableUser`\n\n```ts\ntype AssignableUser = {\n type: "user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id?: string\n email?: string\n}\n```\n\n### `AssignablePartnerUser`\n\n```ts\ntype AssignablePartnerUser = {\n type: "partner_user"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id?: string\n user_id?: string\n email?: string\n}\n```\n\n### `AssignableGroup`\n\n```ts\ntype AssignableGroup = {\n type: string\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n group_id?: string\n}\n```\n\n### `AssignableOrganization`\n\n```ts\ntype AssignableOrganization = {\n type: "partner_organization"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n partner_id: string\n email?: string\n geolocations?: Array<{\n address?: {\n street?: { ... }\n street_number?: { ... }\n city?: { ... }\n postal_code?: { ... }\n country?: { ... }\n }\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n }>\n phone?: string\n activity_radius?: number\n}\n```\n\n### `AssignableEcpPlaceholder`\n\n```ts\ntype AssignableEcpPlaceholder = {\n type: "ecp"\n display_name: string\n image_uri?: {\n original: string // uri\n thumbnail_32?: string // uri\n }\n org_id: string\n created_at?: string\n activated_at?: string\n status?: "Active" | "Pending" | "Deactivated" | "Deleted"\n user_id: string\n email?: string\n}\n```\n\n### `SearchGeolocation`\n\n```ts\ntype SearchGeolocation = {\n address: string\n}\n```\n\n### `Geolocation`\n\n```ts\ntype Geolocation = {\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n}\n```\n\n### `Address`\n\n```ts\ntype Address = {\n street?: string\n street_number?: string\n city?: string\n postal_code?: string\n country?: string\n}\n```\n\n### `AddressGeolocation`\n\n```ts\ntype AddressGeolocation = {\n address?: {\n street?: string\n street_number?: string\n city?: string\n postal_code?: string\n country?: string\n }\n lat: number\n lng: number\n addressLabel?: string\n relevance?: number\n}\n```\n\n### `PartnerUser`\n\n```ts\ntype PartnerUser = {\n id: string\n name?: string\n email: string // email\n status: string\n image?: {\n original?: string // uri\n thumbnail_32?: string // uri\n }\n roles: Array<{\n id: string\n slug: string\n name: string\n }>\n}\n```\n\n### `CreatePartnerUserPayload`\n\n```ts\ntype CreatePartnerUserPayload = {\n email: string // email\n language?: "en" | "de"\n roles?: string[]\n}\n```\n\n### `CreatePartnerRolePayload`\n\n```ts\ntype CreatePartnerRolePayload = {\n name: string\n slug: string\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### `UpdatePartnerRolePayload`\n\n```ts\ntype UpdatePartnerRolePayload = {\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}\n```\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### `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### `BaseRoleForCreate`\n\n```ts\ntype BaseRoleForCreate = {\n id?: string\n name: string\n slug: 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 slug: string\n name: string\n type?: string\n}\n```\n\n### `AssignRolesPayload`\n\n```ts\ntype AssignRolesPayload = {\n roleIds: string[]\n}\n```\n\n### `User`\n\n```ts\ntype User = {\n id?: string\n email?: string // email\n display_name?: string\n status?: string\n}\n```\n';
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
exports.default = partner_directory_default;
|