Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@epilot/user-client
Advanced tools
@epilot/user-client - npm Package Compare versions
Comparing version 3.7.0 to 3.8.0
@@ -1,1 +0,1 @@ | ||
| (()=>{"use strict";var e={914:function(e,r,t){var s=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var a=s(t(240));r.default=a.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v2/users/public/signup":{"post":{"operationId":"signUpUser","parameters":[{"name":"token","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}}}},"/v2/users/me":{"get":{"operationId":"getMeV2"}},"/v2/users":{"get":{"operationId":"listUsersV2","parameters":[{"name":"query","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"offset","in":"query","required":false}]}},"/v2/users/{id}":{"get":{"operationId":"getUserV2","parameters":[{"in":"path","name":"id","required":true}]},"patch":{"operationId":"updateUserV2","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteUserV2","parameters":[{"in":"path","name":"id","required":true}]}},"/v2/users/invite":{"post":{"operationId":"inviteUser","requestBody":{"content":{"application/json":{}}}}},"/v2/users/invite:resendEmail":{"post":{"operationId":"resendUserInvitation","requestBody":{"content":{"application/json":{}}}}},"/v2/users/public/verifyEmail":{"post":{"operationId":"verifyEmailWithToken","parameters":[{"in":"query","name":"token","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v2/users/public/activate":{"post":{"operationId":"activateUser","parameters":[{"in":"query","name":"token","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v2/users/public/username/{username}:getLoginParameters":{"get":{"operationId":"getUserLoginParametersV2","parameters":[{"name":"username","in":"path","required":true}]}},"/v1/users/me":{"get":{"operationId":"getMe"}},"/v1/users":{"get":{"operationId":"listUsers","parameters":[{"name":"org_ids","in":"query","style":"form","explode":false},{"name":"query","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"offset","in":"query","required":false}]}},"/v1/users/{id}":{"get":{"operationId":"getUser","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/users/username/{username}:getLoginParameters":{"get":{"operationId":"getUserLoginParameters","parameters":[{"name":"username","in":"path","required":true}]}}},"components":{},"servers":[{"url":"https://user.sls.epilot.io"}]}')}},r={},t=function t(s){var a=r[s];if(void 0!==a)return a.exports;var i=r[s]={exports:{}};return e[s].call(i.exports,i,i.exports,t),i.exports}(914),s=exports;for(var a in t)s[a]=t[a];t.__esModule&&Object.defineProperty(s,"__esModule",{value:!0})})(); | ||
| (()=>{"use strict";var e={914:function(e,r,s){var t=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=t(s(240));r.default=n.default},240:e=>{e.exports=JSON.parse('{"openapi":"3.0.2","info":{"title":"","version":""},"paths":{"/v2/users/public/signup":{"post":{"operationId":"signUpUser","parameters":[{"name":"token","in":"query","required":false}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/users/me":{"get":{"operationId":"getMeV2","responses":{}}},"/v2/users":{"get":{"operationId":"listUsersV2","parameters":[{"name":"query","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"offset","in":"query","required":false}],"responses":{}}},"/v2/users/{id}":{"get":{"operationId":"getUserV2","parameters":[{"in":"path","name":"id","required":true}],"responses":{}},"patch":{"operationId":"updateUserV2","parameters":[{"in":"path","name":"id","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteUserV2","parameters":[{"in":"path","name":"id","required":true}],"responses":{}}},"/v2/users/invite":{"post":{"operationId":"inviteUser","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/users/invite:resendEmail":{"post":{"operationId":"resendUserInvitation","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/groups":{"get":{"operationId":"getGroups","parameters":[{"name":"query","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"offset","in":"query","required":false},{"name":"hydrate","in":"query","required":false}],"responses":{}},"post":{"operationId":"createGroup","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/groups/{id}":{"get":{"operationId":"getGroup","parameters":[{"name":"id","in":"path","required":true},{"name":"hydrate","in":"query","required":false}],"responses":{}},"patch":{"operationId":"updateGroup","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteGroup","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/groups/{id}/user:next":{"post":{"operationId":"advanceUserAssignment","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v2/users/public/verifyEmail":{"post":{"operationId":"verifyEmailWithToken","parameters":[{"in":"query","name":"token","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/users/public/activate":{"post":{"operationId":"activateUser","parameters":[{"in":"query","name":"token","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/users/public/username/{username}:getLoginParameters":{"get":{"operationId":"getUserLoginParametersV2","parameters":[{"name":"username","in":"path","required":true}],"responses":{}}},"/v1/users/me":{"get":{"operationId":"getMe","responses":{}}},"/v1/users":{"get":{"operationId":"listUsers","parameters":[{"name":"org_ids","in":"query","style":"form","explode":false},{"name":"query","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"offset","in":"query","required":false}],"responses":{}}},"/v1/users/{id}":{"get":{"operationId":"getUser","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/users/username/{username}:getLoginParameters":{"get":{"operationId":"getUserLoginParameters","parameters":[{"name":"username","in":"path","required":true}],"responses":{}}}},"components":{},"servers":[{"url":"https://user.sls.epilot.io"}]}')}},r={},s=function s(t){var n=r[t];if(void 0!==n)return n.exports;var a=r[t]={exports:{}};return e[t].call(a.exports,a,a.exports,s),a.exports}(914),t=exports;for(var n in s)t[n]=s[n];s.__esModule&&Object.defineProperty(t,"__esModule",{value:!0})})(); |
@@ -22,3 +22,4 @@ { | ||
| } | ||
| } | ||
| }, | ||
| "responses": {} | ||
| } | ||
@@ -28,3 +29,4 @@ }, | ||
| "get": { | ||
| "operationId": "getMeV2" | ||
| "operationId": "getMeV2", | ||
| "responses": {} | ||
| } | ||
@@ -51,3 +53,4 @@ }, | ||
| } | ||
| ] | ||
| ], | ||
| "responses": {} | ||
| } | ||
@@ -64,3 +67,4 @@ }, | ||
| } | ||
| ] | ||
| ], | ||
| "responses": {} | ||
| }, | ||
@@ -80,3 +84,4 @@ "patch": { | ||
| } | ||
| } | ||
| }, | ||
| "responses": {} | ||
| }, | ||
@@ -91,3 +96,4 @@ "delete": { | ||
| } | ||
| ] | ||
| ], | ||
| "responses": {} | ||
| } | ||
@@ -102,3 +108,4 @@ }, | ||
| } | ||
| } | ||
| }, | ||
| "responses": {} | ||
| } | ||
@@ -113,5 +120,101 @@ }, | ||
| } | ||
| } | ||
| }, | ||
| "responses": {} | ||
| } | ||
| }, | ||
| "/v1/groups": { | ||
| "get": { | ||
| "operationId": "getGroups", | ||
| "parameters": [ | ||
| { | ||
| "name": "query", | ||
| "in": "query", | ||
| "required": false | ||
| }, | ||
| { | ||
| "name": "limit", | ||
| "in": "query", | ||
| "required": false | ||
| }, | ||
| { | ||
| "name": "offset", | ||
| "in": "query", | ||
| "required": false | ||
| }, | ||
| { | ||
| "name": "hydrate", | ||
| "in": "query", | ||
| "required": false | ||
| } | ||
| ], | ||
| "responses": {} | ||
| }, | ||
| "post": { | ||
| "operationId": "createGroup", | ||
| "requestBody": { | ||
| "content": { | ||
| "application/json": {} | ||
| } | ||
| }, | ||
| "responses": {} | ||
| } | ||
| }, | ||
| "/v1/groups/{id}": { | ||
| "get": { | ||
| "operationId": "getGroup", | ||
| "parameters": [ | ||
| { | ||
| "name": "id", | ||
| "in": "path", | ||
| "required": true | ||
| }, | ||
| { | ||
| "name": "hydrate", | ||
| "in": "query", | ||
| "required": false | ||
| } | ||
| ], | ||
| "responses": {} | ||
| }, | ||
| "patch": { | ||
| "operationId": "updateGroup", | ||
| "parameters": [ | ||
| { | ||
| "name": "id", | ||
| "in": "path", | ||
| "required": true | ||
| } | ||
| ], | ||
| "requestBody": { | ||
| "content": { | ||
| "application/json": {} | ||
| } | ||
| }, | ||
| "responses": {} | ||
| }, | ||
| "delete": { | ||
| "operationId": "deleteGroup", | ||
| "parameters": [ | ||
| { | ||
| "name": "id", | ||
| "in": "path", | ||
| "required": true | ||
| } | ||
| ], | ||
| "responses": {} | ||
| } | ||
| }, | ||
| "/v1/groups/{id}/user:next": { | ||
| "post": { | ||
| "operationId": "advanceUserAssignment", | ||
| "parameters": [ | ||
| { | ||
| "name": "id", | ||
| "in": "path", | ||
| "required": true | ||
| } | ||
| ], | ||
| "responses": {} | ||
| } | ||
| }, | ||
| "/v2/users/public/verifyEmail": { | ||
@@ -131,3 +234,4 @@ "post": { | ||
| } | ||
| } | ||
| }, | ||
| "responses": {} | ||
| } | ||
@@ -149,3 +253,4 @@ }, | ||
| } | ||
| } | ||
| }, | ||
| "responses": {} | ||
| } | ||
@@ -162,3 +267,4 @@ }, | ||
| } | ||
| ] | ||
| ], | ||
| "responses": {} | ||
| } | ||
@@ -168,3 +274,4 @@ }, | ||
| "get": { | ||
| "operationId": "getMe" | ||
| "operationId": "getMe", | ||
| "responses": {} | ||
| } | ||
@@ -197,3 +304,4 @@ }, | ||
| } | ||
| ] | ||
| ], | ||
| "responses": {} | ||
| } | ||
@@ -210,3 +318,4 @@ }, | ||
| } | ||
| ] | ||
| ], | ||
| "responses": {} | ||
| } | ||
@@ -223,3 +332,4 @@ }, | ||
| } | ||
| ] | ||
| ], | ||
| "responses": {} | ||
| } | ||
@@ -226,0 +336,0 @@ } |
@@ -34,2 +34,19 @@ /* eslint-disable */ | ||
| } | ||
| export interface CreateGroupReq { | ||
| /** | ||
| * The name of the group. Could be a department or a team. | ||
| * example: | ||
| * Finance | ||
| */ | ||
| name: string; | ||
| /** | ||
| * The list of user ids in the group. | ||
| * example: | ||
| * [ | ||
| * "123", | ||
| * "456" | ||
| * ] | ||
| */ | ||
| user_ids?: /* User's unique identifier */ UserId[]; | ||
| } | ||
| export interface DataPoint { | ||
@@ -61,3 +78,171 @@ /** | ||
| } | ||
| export type DataPointsResponse = DataPoint[]; | ||
| export interface Group { | ||
| id: /* Group unique identifier */ GroupId; | ||
| org_id: OrganizationId; | ||
| /** | ||
| * The name of the group. Could be a department or a team. | ||
| * example: | ||
| * Finance | ||
| */ | ||
| name: string; | ||
| /** | ||
| * example: | ||
| * 2024-02-08T04:44:32.246Z | ||
| */ | ||
| created_at: string; | ||
| /** | ||
| * example: | ||
| * 2024-02-08T04:44:32.246Z | ||
| */ | ||
| updated_at: string; | ||
| /** | ||
| * The current user assignee of the group. This is the user, from within the group, that has last been assigned to a workflow task. | ||
| */ | ||
| crt_assignee?: { | ||
| id?: /* User's unique identifier */ UserId; | ||
| organization_id?: OrganizationId; | ||
| /** | ||
| * example: | ||
| * 2022-02-08T04:44:32.246Z | ||
| */ | ||
| created_at?: string; | ||
| /** | ||
| * User's display name (default: email address) | ||
| * example: | ||
| * Example User | ||
| */ | ||
| display_name?: string; | ||
| status?: "Active" | "Pending" | "Deactivated" | "Deleted"; | ||
| /** | ||
| * User's email address | ||
| */ | ||
| email?: string; // email | ||
| /** | ||
| * User's pending email address | ||
| */ | ||
| draft_email?: string | null; // email | ||
| /** | ||
| * User's department | ||
| * example: | ||
| * Sales | ||
| */ | ||
| department?: string | null; | ||
| /** | ||
| * User's phone number | ||
| * example: | ||
| * 1234567890 | ||
| */ | ||
| phone?: string | null; | ||
| /** | ||
| * User's secondary phone number, preferred for communication | ||
| * example: | ||
| * 1234567890 | ||
| */ | ||
| secondary_phone?: string | null; | ||
| /** | ||
| * User's multi-factor authentication status | ||
| * example: | ||
| * false | ||
| */ | ||
| mfa_enabled?: boolean; | ||
| /** | ||
| * User's phone number verification status | ||
| * example: | ||
| * true | ||
| */ | ||
| phone_verified?: boolean; | ||
| token?: /* Token used to invite a user to epilot */ InviteToken; | ||
| /** | ||
| * User's email signature | ||
| * example: | ||
| * <p>Thanks</p> | ||
| */ | ||
| signature?: string | null; | ||
| /** | ||
| * Whether the user's signature is enabled | ||
| * example: | ||
| * true | ||
| */ | ||
| is_signature_enabled?: boolean | null; | ||
| /** | ||
| * User's preferred language | ||
| * example: | ||
| * de | ||
| */ | ||
| preferred_language?: string; | ||
| /** | ||
| * User's start page after login | ||
| */ | ||
| custom_start_page?: string | null; // ^/app/* | ||
| /** | ||
| * This field is used to override the release channel for the user. | ||
| */ | ||
| override_release_channel?: "canary" | "rc" | "stable" | null; | ||
| /** | ||
| * User's feature preferences | ||
| * example: | ||
| * { | ||
| * "feature_name": true | ||
| * } | ||
| */ | ||
| feature_preferences?: { | ||
| [name: string]: any; | ||
| } | null; | ||
| /** | ||
| * User's custom profile image | ||
| * example: | ||
| * { | ||
| * "original": "https://account-profile-images.epilot.cloud/1/avatar.png", | ||
| * "thumbnail_32": "https://account-profile-images.epilot.cloud/1/avatar_32x32.png" | ||
| * } | ||
| */ | ||
| image_uri?: { | ||
| [name: string]: any; | ||
| original?: string; // uri | ||
| thumbnail_32?: string; // uri | ||
| } | null; | ||
| /** | ||
| * example: | ||
| * { | ||
| * "entity_views": { | ||
| * "opportunity": "891a5409850abf8b92bd2cb7bdd2844d32ce6bec", | ||
| * "order": "628aee91-7c2f-4047-ab0d-433582a19c49" | ||
| * }, | ||
| * "dashboard": "751ff121-9ac2-4511-a2e6-851f11287380" | ||
| * } | ||
| */ | ||
| favorites?: { | ||
| [name: string]: any; | ||
| }; | ||
| properties?: { | ||
| /** | ||
| * example: | ||
| * profileImageName | ||
| */ | ||
| name: string; | ||
| /** | ||
| * example: | ||
| * avatar.png | ||
| */ | ||
| value: string; | ||
| }[]; | ||
| /** | ||
| * The index of the current assignee in the group's user list. | ||
| * example: | ||
| * 3 | ||
| */ | ||
| crt_index?: number; | ||
| }; | ||
| /** | ||
| * The list of users in the group. Only contains the full user when respective endpoint is called with a flag. Otherwise only contains the user id. | ||
| */ | ||
| users?: UserV2[]; | ||
| } | ||
| /** | ||
| * Group unique identifier | ||
| */ | ||
| export type GroupId = string; | ||
| export type Hydrate = boolean; | ||
| /** | ||
| * Token used to invite a user to epilot | ||
@@ -216,2 +401,19 @@ */ | ||
| } | ||
| export interface UpdateGroupReq { | ||
| /** | ||
| * The name of the group. Could be a department or a team. | ||
| * example: | ||
| * Finance | ||
| */ | ||
| name?: string; | ||
| /** | ||
| * The list of user ids in the group. | ||
| * example: | ||
| * [ | ||
| * "123", | ||
| * "456" | ||
| * ] | ||
| */ | ||
| user_ids?: /* User's unique identifier */ UserId[]; | ||
| } | ||
| export interface User { | ||
@@ -473,2 +675,35 @@ id: /* User's unique identifier */ UserId; | ||
| } | ||
| namespace AdvanceUserAssignment { | ||
| namespace Parameters { | ||
| export type Id = /* Group unique identifier */ Components.Schemas.GroupId; | ||
| } | ||
| export interface PathParameters { | ||
| id: Parameters.Id; | ||
| } | ||
| namespace Responses { | ||
| export type $200 = Components.Schemas.Group; | ||
| export interface $404 { | ||
| } | ||
| export interface $422 { | ||
| } | ||
| } | ||
| } | ||
| namespace CreateGroup { | ||
| export type RequestBody = Components.Schemas.CreateGroupReq; | ||
| namespace Responses { | ||
| export type $201 = Components.Schemas.Group; | ||
| } | ||
| } | ||
| namespace DeleteGroup { | ||
| namespace Parameters { | ||
| export type Id = /* Group unique identifier */ Components.Schemas.GroupId; | ||
| } | ||
| export interface PathParameters { | ||
| id: Parameters.Id; | ||
| } | ||
| namespace Responses { | ||
| export interface $204 { | ||
| } | ||
| } | ||
| } | ||
| namespace DeleteUserV2 { | ||
@@ -485,2 +720,43 @@ namespace Parameters { | ||
| } | ||
| namespace GetGroup { | ||
| namespace Parameters { | ||
| export type Hydrate = Components.Schemas.Hydrate; | ||
| export type Id = /* Group unique identifier */ Components.Schemas.GroupId; | ||
| } | ||
| export interface PathParameters { | ||
| id: Parameters.Id; | ||
| } | ||
| export interface QueryParameters { | ||
| hydrate?: Parameters.Hydrate; | ||
| } | ||
| namespace Responses { | ||
| export type $200 = Components.Schemas.Group; | ||
| export interface $404 { | ||
| } | ||
| } | ||
| } | ||
| namespace GetGroups { | ||
| namespace Parameters { | ||
| export type Hydrate = Components.Schemas.Hydrate; | ||
| export type Limit = Components.Schemas.Limit; | ||
| export type Offset = Components.Schemas.Offset; | ||
| export type Query = Components.Schemas.Query; | ||
| } | ||
| export interface QueryParameters { | ||
| query?: Parameters.Query; | ||
| limit?: Parameters.Limit; | ||
| offset?: Parameters.Offset; | ||
| hydrate?: Parameters.Hydrate; | ||
| } | ||
| namespace Responses { | ||
| export interface $200 { | ||
| /** | ||
| * example: | ||
| * 1 | ||
| */ | ||
| hits?: number; | ||
| groups?: Components.Schemas.Group[]; | ||
| } | ||
| } | ||
| } | ||
| namespace GetMe { | ||
@@ -622,2 +898,16 @@ namespace Responses { | ||
| } | ||
| namespace UpdateGroup { | ||
| namespace Parameters { | ||
| export type Id = /* Group unique identifier */ Components.Schemas.GroupId; | ||
| } | ||
| export interface PathParameters { | ||
| id: Parameters.Id; | ||
| } | ||
| export type RequestBody = Components.Schemas.UpdateGroupReq; | ||
| namespace Responses { | ||
| export type $201 = Components.Schemas.Group; | ||
| export interface $404 { | ||
| } | ||
| } | ||
| } | ||
| namespace UpdateUserV2 { | ||
@@ -687,3 +977,3 @@ namespace Parameters { | ||
| 'getUserV2'( | ||
| parameters?: Parameters<Paths.GetUserV2.PathParameters> | null, | ||
| parameters: Parameters<Paths.GetUserV2.PathParameters>, | ||
| data?: any, | ||
@@ -698,3 +988,3 @@ config?: AxiosRequestConfig | ||
| 'updateUserV2'( | ||
| parameters?: Parameters<Paths.UpdateUserV2.PathParameters> | null, | ||
| parameters: Parameters<Paths.UpdateUserV2.PathParameters>, | ||
| data?: Paths.UpdateUserV2.RequestBody, | ||
@@ -709,3 +999,3 @@ config?: AxiosRequestConfig | ||
| 'deleteUserV2'( | ||
| parameters?: Parameters<Paths.DeleteUserV2.PathParameters> | null, | ||
| parameters: Parameters<Paths.DeleteUserV2.PathParameters>, | ||
| data?: any, | ||
@@ -735,2 +1025,62 @@ config?: AxiosRequestConfig | ||
| /** | ||
| * getGroups - getGroups | ||
| * | ||
| * Lists groups in organizations you have access to | ||
| */ | ||
| 'getGroups'( | ||
| parameters?: Parameters<Paths.GetGroups.QueryParameters> | null, | ||
| data?: any, | ||
| config?: AxiosRequestConfig | ||
| ): OperationResponse<Paths.GetGroups.Responses.$200> | ||
| /** | ||
| * createGroup - createGroup | ||
| * | ||
| * Create a new group | ||
| */ | ||
| 'createGroup'( | ||
| parameters?: Parameters<UnknownParamsObject> | null, | ||
| data?: Paths.CreateGroup.RequestBody, | ||
| config?: AxiosRequestConfig | ||
| ): OperationResponse<Paths.CreateGroup.Responses.$201> | ||
| /** | ||
| * getGroup - getGroup | ||
| * | ||
| * Get group by id | ||
| */ | ||
| 'getGroup'( | ||
| parameters: Parameters<Paths.GetGroup.QueryParameters & Paths.GetGroup.PathParameters>, | ||
| data?: any, | ||
| config?: AxiosRequestConfig | ||
| ): OperationResponse<Paths.GetGroup.Responses.$200> | ||
| /** | ||
| * updateGroup - updateGroup | ||
| * | ||
| * Update group by id | ||
| */ | ||
| 'updateGroup'( | ||
| parameters: Parameters<Paths.UpdateGroup.PathParameters>, | ||
| data?: Paths.UpdateGroup.RequestBody, | ||
| config?: AxiosRequestConfig | ||
| ): OperationResponse<Paths.UpdateGroup.Responses.$201> | ||
| /** | ||
| * deleteGroup - deleteGroup | ||
| * | ||
| * Delete group by id | ||
| */ | ||
| 'deleteGroup'( | ||
| parameters: Parameters<Paths.DeleteGroup.PathParameters>, | ||
| data?: any, | ||
| config?: AxiosRequestConfig | ||
| ): OperationResponse<Paths.DeleteGroup.Responses.$204> | ||
| /** | ||
| * advanceUserAssignment - advanceUserAssignment | ||
| * | ||
| * Advance user assignment to next user in line | ||
| */ | ||
| 'advanceUserAssignment'( | ||
| parameters: Parameters<Paths.AdvanceUserAssignment.PathParameters>, | ||
| data?: any, | ||
| config?: AxiosRequestConfig | ||
| ): OperationResponse<Paths.AdvanceUserAssignment.Responses.$200> | ||
| /** | ||
| * verifyEmailWithToken - verifyEmailWithToken | ||
@@ -761,3 +1111,3 @@ * | ||
| 'getUserLoginParametersV2'( | ||
| parameters?: Parameters<Paths.GetUserLoginParametersV2.PathParameters> | null, | ||
| parameters: Parameters<Paths.GetUserLoginParametersV2.PathParameters>, | ||
| data?: any, | ||
@@ -792,3 +1142,3 @@ config?: AxiosRequestConfig | ||
| 'getUser'( | ||
| parameters?: Parameters<Paths.GetUser.PathParameters> | null, | ||
| parameters: Parameters<Paths.GetUser.PathParameters>, | ||
| data?: any, | ||
@@ -803,3 +1153,3 @@ config?: AxiosRequestConfig | ||
| 'getUserLoginParameters'( | ||
| parameters?: Parameters<Paths.GetUserLoginParameters.PathParameters> | null, | ||
| parameters: Parameters<Paths.GetUserLoginParameters.PathParameters>, | ||
| data?: any, | ||
@@ -852,3 +1202,3 @@ config?: AxiosRequestConfig | ||
| 'get'( | ||
| parameters?: Parameters<Paths.GetUserV2.PathParameters> | null, | ||
| parameters: Parameters<Paths.GetUserV2.PathParameters>, | ||
| data?: any, | ||
@@ -863,3 +1213,3 @@ config?: AxiosRequestConfig | ||
| 'patch'( | ||
| parameters?: Parameters<Paths.UpdateUserV2.PathParameters> | null, | ||
| parameters: Parameters<Paths.UpdateUserV2.PathParameters>, | ||
| data?: Paths.UpdateUserV2.RequestBody, | ||
@@ -874,3 +1224,3 @@ config?: AxiosRequestConfig | ||
| 'delete'( | ||
| parameters?: Parameters<Paths.DeleteUserV2.PathParameters> | null, | ||
| parameters: Parameters<Paths.DeleteUserV2.PathParameters>, | ||
| data?: any, | ||
@@ -904,2 +1254,68 @@ config?: AxiosRequestConfig | ||
| } | ||
| ['/v1/groups']: { | ||
| /** | ||
| * getGroups - getGroups | ||
| * | ||
| * Lists groups in organizations you have access to | ||
| */ | ||
| 'get'( | ||
| parameters?: Parameters<Paths.GetGroups.QueryParameters> | null, | ||
| data?: any, | ||
| config?: AxiosRequestConfig | ||
| ): OperationResponse<Paths.GetGroups.Responses.$200> | ||
| /** | ||
| * createGroup - createGroup | ||
| * | ||
| * Create a new group | ||
| */ | ||
| 'post'( | ||
| parameters?: Parameters<UnknownParamsObject> | null, | ||
| data?: Paths.CreateGroup.RequestBody, | ||
| config?: AxiosRequestConfig | ||
| ): OperationResponse<Paths.CreateGroup.Responses.$201> | ||
| } | ||
| ['/v1/groups/{id}']: { | ||
| /** | ||
| * getGroup - getGroup | ||
| * | ||
| * Get group by id | ||
| */ | ||
| 'get'( | ||
| parameters: Parameters<Paths.GetGroup.QueryParameters & Paths.GetGroup.PathParameters>, | ||
| data?: any, | ||
| config?: AxiosRequestConfig | ||
| ): OperationResponse<Paths.GetGroup.Responses.$200> | ||
| /** | ||
| * updateGroup - updateGroup | ||
| * | ||
| * Update group by id | ||
| */ | ||
| 'patch'( | ||
| parameters: Parameters<Paths.UpdateGroup.PathParameters>, | ||
| data?: Paths.UpdateGroup.RequestBody, | ||
| config?: AxiosRequestConfig | ||
| ): OperationResponse<Paths.UpdateGroup.Responses.$201> | ||
| /** | ||
| * deleteGroup - deleteGroup | ||
| * | ||
| * Delete group by id | ||
| */ | ||
| 'delete'( | ||
| parameters: Parameters<Paths.DeleteGroup.PathParameters>, | ||
| data?: any, | ||
| config?: AxiosRequestConfig | ||
| ): OperationResponse<Paths.DeleteGroup.Responses.$204> | ||
| } | ||
| ['/v1/groups/{id}/user:next']: { | ||
| /** | ||
| * advanceUserAssignment - advanceUserAssignment | ||
| * | ||
| * Advance user assignment to next user in line | ||
| */ | ||
| 'post'( | ||
| parameters: Parameters<Paths.AdvanceUserAssignment.PathParameters>, | ||
| data?: any, | ||
| config?: AxiosRequestConfig | ||
| ): OperationResponse<Paths.AdvanceUserAssignment.Responses.$200> | ||
| } | ||
| ['/v2/users/public/verifyEmail']: { | ||
@@ -936,3 +1352,3 @@ /** | ||
| 'get'( | ||
| parameters?: Parameters<Paths.GetUserLoginParametersV2.PathParameters> | null, | ||
| parameters: Parameters<Paths.GetUserLoginParametersV2.PathParameters>, | ||
| data?: any, | ||
@@ -973,3 +1389,3 @@ config?: AxiosRequestConfig | ||
| 'get'( | ||
| parameters?: Parameters<Paths.GetUser.PathParameters> | null, | ||
| parameters: Parameters<Paths.GetUser.PathParameters>, | ||
| data?: any, | ||
@@ -986,3 +1402,3 @@ config?: AxiosRequestConfig | ||
| 'get'( | ||
| parameters?: Parameters<Paths.GetUserLoginParameters.PathParameters> | null, | ||
| parameters: Parameters<Paths.GetUserLoginParameters.PathParameters>, | ||
| data?: any, | ||
@@ -989,0 +1405,0 @@ config?: AxiosRequestConfig |
@@ -16,2 +16,6 @@ { | ||
| "description": "Legacy User API" | ||
| }, | ||
| { | ||
| "name": "Group", | ||
| "description": "User Groups" | ||
| } | ||
@@ -344,2 +348,254 @@ ], | ||
| }, | ||
| "/v1/groups": { | ||
| "get": { | ||
| "operationId": "getGroups", | ||
| "summary": "getGroups", | ||
| "description": "Lists groups in organizations you have access to", | ||
| "tags": [ | ||
| "Group" | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "query", | ||
| "in": "query", | ||
| "description": "Query name to filter by", | ||
| "required": false, | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Query" | ||
| } | ||
| }, | ||
| { | ||
| "name": "limit", | ||
| "in": "query", | ||
| "description": "Limit the results size", | ||
| "required": false, | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Limit" | ||
| } | ||
| }, | ||
| { | ||
| "name": "offset", | ||
| "in": "query", | ||
| "description": "Specify the offset", | ||
| "required": false, | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Offset" | ||
| } | ||
| }, | ||
| { | ||
| "name": "hydrate", | ||
| "in": "query", | ||
| "description": "Pass it true when you want to hydrate the group with full user details", | ||
| "required": false, | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Hydrate" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "List of groups", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "type": "object", | ||
| "properties": { | ||
| "hits": { | ||
| "type": "number", | ||
| "example": 1 | ||
| }, | ||
| "groups": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/Group" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "post": { | ||
| "operationId": "createGroup", | ||
| "summary": "createGroup", | ||
| "description": "Create a new group", | ||
| "tags": [ | ||
| "Group" | ||
| ], | ||
| "requestBody": { | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/CreateGroupReq" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "responses": { | ||
| "201": { | ||
| "description": "Group created successfully", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Group" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/v1/groups/{id}": { | ||
| "get": { | ||
| "operationId": "getGroup", | ||
| "summary": "getGroup", | ||
| "description": "Get group by id", | ||
| "tags": [ | ||
| "Group" | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "id", | ||
| "in": "path", | ||
| "description": "Group id", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/components/schemas/GroupId" | ||
| } | ||
| }, | ||
| { | ||
| "name": "hydrate", | ||
| "in": "query", | ||
| "description": "Pass it true when you want to hydrate the group with full user details", | ||
| "required": false, | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Hydrate" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Group", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Group" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "404": { | ||
| "description": "Group not found" | ||
| } | ||
| } | ||
| }, | ||
| "patch": { | ||
| "operationId": "updateGroup", | ||
| "summary": "updateGroup", | ||
| "description": "Update group by id", | ||
| "tags": [ | ||
| "Group" | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "id", | ||
| "in": "path", | ||
| "description": "Group id", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/components/schemas/GroupId" | ||
| } | ||
| } | ||
| ], | ||
| "requestBody": { | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/UpdateGroupReq" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "responses": { | ||
| "201": { | ||
| "description": "Group created successfully", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Group" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "404": { | ||
| "description": "Group not found" | ||
| } | ||
| } | ||
| }, | ||
| "delete": { | ||
| "operationId": "deleteGroup", | ||
| "summary": "deleteGroup", | ||
| "description": "Delete group by id", | ||
| "tags": [ | ||
| "Group" | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "id", | ||
| "in": "path", | ||
| "description": "Group id", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/components/schemas/GroupId" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "204": { | ||
| "description": "Group deleted successfully" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/v1/groups/{id}/user:next": { | ||
| "post": { | ||
| "operationId": "advanceUserAssignment", | ||
| "summary": "advanceUserAssignment", | ||
| "description": "Advance user assignment to next user in line", | ||
| "tags": [ | ||
| "Group" | ||
| ], | ||
| "parameters": [ | ||
| { | ||
| "name": "id", | ||
| "in": "path", | ||
| "description": "Group id", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/components/schemas/GroupId" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Updated user group with crt_assignee updated to next user in line", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/Group" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "404": { | ||
| "description": "Group not found" | ||
| }, | ||
| "422": { | ||
| "description": "User Group has no users assigned, thus it cannot advance to next user" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/v2/users/public/verifyEmail": { | ||
@@ -656,2 +912,7 @@ "post": { | ||
| }, | ||
| "GroupId": { | ||
| "description": "Group unique identifier", | ||
| "type": "string", | ||
| "readOnly": true | ||
| }, | ||
| "UserId": { | ||
@@ -674,2 +935,5 @@ "description": "User's unique identifier", | ||
| }, | ||
| "Hydrate": { | ||
| "type": "boolean" | ||
| }, | ||
| "Username": { | ||
@@ -1033,2 +1297,103 @@ "type": "string" | ||
| }, | ||
| "CreateGroupReq": { | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "description": "The name of the group. Could be a department or a team.", | ||
| "type": "string", | ||
| "example": "Finance" | ||
| }, | ||
| "user_ids": { | ||
| "description": "The list of user ids in the group.", | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/UserId" | ||
| }, | ||
| "example": [ | ||
| "123", | ||
| "456" | ||
| ] | ||
| } | ||
| }, | ||
| "required": [ | ||
| "name" | ||
| ] | ||
| }, | ||
| "UpdateGroupReq": { | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { | ||
| "description": "The name of the group. Could be a department or a team.", | ||
| "type": "string", | ||
| "example": "Finance" | ||
| }, | ||
| "user_ids": { | ||
| "description": "The list of user ids in the group.", | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/UserId" | ||
| }, | ||
| "example": [ | ||
| "123", | ||
| "456" | ||
| ] | ||
| } | ||
| } | ||
| }, | ||
| "Group": { | ||
| "type": "object", | ||
| "properties": { | ||
| "id": { | ||
| "$ref": "#/components/schemas/GroupId" | ||
| }, | ||
| "org_id": { | ||
| "$ref": "#/components/schemas/OrganizationId" | ||
| }, | ||
| "name": { | ||
| "description": "The name of the group. Could be a department or a team.", | ||
| "type": "string", | ||
| "example": "Finance" | ||
| }, | ||
| "created_at": { | ||
| "type": "string", | ||
| "example": "2024-02-08T04:44:32.246Z" | ||
| }, | ||
| "updated_at": { | ||
| "type": "string", | ||
| "example": "2024-02-08T04:44:32.246Z" | ||
| }, | ||
| "crt_assignee": { | ||
| "description": "The current user assignee of the group. This is the user, from within the group, that has last been assigned to a workflow task.", | ||
| "allOf": [ | ||
| { | ||
| "$ref": "#/components/schemas/UserV2" | ||
| }, | ||
| { | ||
| "type": "object", | ||
| "properties": { | ||
| "crt_index": { | ||
| "description": "The index of the current assignee in the group's user list.", | ||
| "type": "number", | ||
| "example": 3 | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "users": { | ||
| "description": "The list of users in the group. Only contains the full user when respective endpoint is called with a flag. Otherwise only contains the user id.", | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/UserV2" | ||
| } | ||
| } | ||
| }, | ||
| "required": [ | ||
| "id", | ||
| "org_id", | ||
| "name", | ||
| "created_at", | ||
| "updated_at" | ||
| ] | ||
| }, | ||
| "SignupUserPayload": { | ||
@@ -1238,2 +1603,8 @@ "type": "object", | ||
| }, | ||
| "DataPointsResponse": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/DataPoint" | ||
| } | ||
| }, | ||
| "DataPoint": { | ||
@@ -1240,0 +1611,0 @@ "type": "object", |
| { | ||
| "name": "@epilot/user-client", | ||
| "version": "3.7.0", | ||
| "version": "3.8.0", | ||
| "description": "Client library for the epilot User API", | ||
@@ -66,3 +66,3 @@ "main": "dist/index.js", | ||
| "openapi-client-axios-typegen": "^7.4.1", | ||
| "openapicmd": "^2.1.0", | ||
| "openapicmd": "^2.3.2", | ||
| "ts-jest": "^26.5.0", | ||
@@ -69,0 +69,0 @@ "ts-loader": "^8.0.14", |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by35.34%
102381
- Lines of code
- increased by35.65%
3413
No dependency changes