@epilot/user-client - npm Package Compare versions

Comparing version 3.6.1-next.3 to 3.6.1-next.4

dist/definition.js

@@ -1,1 +0,1 @@
-(()=>{"use strict";var e={914:function(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var i=a(t(240));r.default=i.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":{}}}}},"/v1/groups":{"get":{"operationId":"getGroups","parameters":[{"name":"query","in":"query","required":false},{"name":"limit","in":"query","required":false},{"name":"offset","in":"query","required":false}]},"post":{"operationId":"createGroup","requestBody":{"content":{"application/json":{}}}}},"/v1/groups/{id}":{"get":{"operationId":"getGroup","parameters":[{"name":"id","in":"path","required":true}]},"patch":{"operationId":"updateGroup","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteGroup","parameters":[{"name":"id","in":"path","required":true}]}},"/v1/groups/{id}/user:next":{"post":{"operationId":"advanceUserAssignment","parameters":[{"name":"id","in":"path","required":true}]}},"/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(a){var i=r[a];if(void 0!==i)return i.exports;var s=r[a]={exports:{}};return e[a].call(s.exports,s,s.exports,t),s.exports}(914),a=exports;for(var i in t)a[i]=t[i];t.__esModule&&Object.defineProperty(a,"__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})})();

dist/openapi-runtime.json

@@ -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,3 +120,4 @@ },
           }
-        }
+        },
+        "responses": {}
       }
@@ -135,4 +143,10 @@ },
             "required": false
+          },
+          {
+            "name": "hydrate",
+            "in": "query",
+            "required": false
           }
-        ]
+        ],
+        "responses": {}
       },
@@ -145,3 +159,4 @@ "post": {
           }
-        }
+        },
+        "responses": {}
       }
@@ -157,4 +172,10 @@ },
             "required": true
+          },
+          {
+            "name": "hydrate",
+            "in": "query",
+            "required": false
           }
-        ]
+        ],
+        "responses": {}
       },
@@ -174,3 +195,4 @@ "patch": {
           }
-        }
+        },
+        "responses": {}
       },
@@ -185,3 +207,4 @@ "delete": {
           }
-        ]
+        ],
+        "responses": {}
       }
@@ -198,3 +221,4 @@ },
           }
-        ]
+        ],
+        "responses": {}
       }
@@ -216,3 +240,4 @@ },
           }
-        }
+        },
+        "responses": {}
       }
@@ -234,3 +259,4 @@ },
           }
-        }
+        },
+        "responses": {}
       }
@@ -247,3 +273,4 @@ },
           }
-        ]
+        ],
+        "responses": {}
       }
@@ -253,3 +280,4 @@ },
       "get": {
-        "operationId": "getMe"
+        "operationId": "getMe",
+        "responses": {}
       }
@@ -282,3 +310,4 @@ },
           }
-        ]
+        ],
+        "responses": {}
       }
@@ -295,3 +324,4 @@ },
           }
-        ]
+        ],
+        "responses": {}
       }
@@ -308,3 +338,4 @@ },
           }
-        ]
+        ],
+        "responses": {}
       }
@@ -311,0 +342,0 @@ }

dist/openapi.d.ts

@@ -77,2 +77,3 @@ /* eslint-disable */
         }
+        export type DataPointsResponse = DataPoint[];
         export interface Group {
@@ -98,11 +99,6 @@ id: /* Group unique identifier */ GroupId;
             /**
-             * example:
-             * 123
+             * 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_user_id_assigned?: string;
-            /**
-             * 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?: {
-                id: /* User's unique identifier */ UserId;
+            crt_assignee?: {
+                id?: /* User's unique identifier */ UserId;
                 organization_id?: OrganizationId;
@@ -234,3 +230,13 @@ /**
                 }[];
-            }[];
+                /**
+                 * 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[];
         }
@@ -241,2 +247,3 @@ /**
         export type GroupId = string;
+        export type Hydrate = boolean;
         /**
@@ -713,2 +720,3 @@ * Token used to invite a user to epilot
         namespace Parameters {
+            export type Hydrate = Components.Schemas.Hydrate;
             export type Id = /* Group unique identifier */ Components.Schemas.GroupId;
@@ -719,2 +727,5 @@ }
         }
+        export interface QueryParameters {
+            hydrate?: Parameters.Hydrate;
+        }
         namespace Responses {
@@ -728,2 +739,3 @@ export type $200 = Components.Schemas.Group;
         namespace Parameters {
+            export type Hydrate = Components.Schemas.Hydrate;
             export type Limit = Components.Schemas.Limit;
@@ -737,2 +749,3 @@ export type Offset = Components.Schemas.Offset;
             offset?: Parameters.Offset;
+            hydrate?: Parameters.Hydrate;
         }
@@ -964,3 +977,3 @@ namespace Responses {
   'getUserV2'(
-    parameters?: Parameters<Paths.GetUserV2.PathParameters> | null,
+    parameters: Parameters<Paths.GetUserV2.PathParameters>,
     data?: any,
@@ -975,3 +988,3 @@ config?: AxiosRequestConfig
   'updateUserV2'(
-    parameters?: Parameters<Paths.UpdateUserV2.PathParameters> | null,
+    parameters: Parameters<Paths.UpdateUserV2.PathParameters>,
     data?: Paths.UpdateUserV2.RequestBody,
@@ -986,3 +999,3 @@ config?: AxiosRequestConfig
   'deleteUserV2'(
-    parameters?: Parameters<Paths.DeleteUserV2.PathParameters> | null,
+    parameters: Parameters<Paths.DeleteUserV2.PathParameters>,
     data?: any,
@@ -1037,3 +1050,3 @@ config?: AxiosRequestConfig
   'getGroup'(
-    parameters?: Parameters<Paths.GetGroup.PathParameters> | null,
+    parameters: Parameters<Paths.GetGroup.QueryParameters & Paths.GetGroup.PathParameters>,
     data?: any,
@@ -1048,3 +1061,3 @@ config?: AxiosRequestConfig
   'updateGroup'(
-    parameters?: Parameters<Paths.UpdateGroup.PathParameters> | null,
+    parameters: Parameters<Paths.UpdateGroup.PathParameters>,
     data?: Paths.UpdateGroup.RequestBody,
@@ -1059,3 +1072,3 @@ config?: AxiosRequestConfig
   'deleteGroup'(
-    parameters?: Parameters<Paths.DeleteGroup.PathParameters> | null,
+    parameters: Parameters<Paths.DeleteGroup.PathParameters>,
     data?: any,
@@ -1070,3 +1083,3 @@ config?: AxiosRequestConfig
   'advanceUserAssignment'(
-    parameters?: Parameters<Paths.AdvanceUserAssignment.PathParameters> | null,
+    parameters: Parameters<Paths.AdvanceUserAssignment.PathParameters>,
     data?: any,
@@ -1101,3 +1114,3 @@ config?: AxiosRequestConfig
   'getUserLoginParametersV2'(
-    parameters?: Parameters<Paths.GetUserLoginParametersV2.PathParameters> | null,
+    parameters: Parameters<Paths.GetUserLoginParametersV2.PathParameters>,
     data?: any,
@@ -1132,3 +1145,3 @@ config?: AxiosRequestConfig
   'getUser'(
-    parameters?: Parameters<Paths.GetUser.PathParameters> | null,
+    parameters: Parameters<Paths.GetUser.PathParameters>,
     data?: any,
@@ -1143,3 +1156,3 @@ config?: AxiosRequestConfig
   'getUserLoginParameters'(
-    parameters?: Parameters<Paths.GetUserLoginParameters.PathParameters> | null,
+    parameters: Parameters<Paths.GetUserLoginParameters.PathParameters>,
     data?: any,
@@ -1192,3 +1205,3 @@ config?: AxiosRequestConfig
     'get'(
-      parameters?: Parameters<Paths.GetUserV2.PathParameters> | null,
+      parameters: Parameters<Paths.GetUserV2.PathParameters>,
       data?: any,
@@ -1203,3 +1216,3 @@ config?: AxiosRequestConfig
     'patch'(
-      parameters?: Parameters<Paths.UpdateUserV2.PathParameters> | null,
+      parameters: Parameters<Paths.UpdateUserV2.PathParameters>,
       data?: Paths.UpdateUserV2.RequestBody,
@@ -1214,3 +1227,3 @@ config?: AxiosRequestConfig
     'delete'(
-      parameters?: Parameters<Paths.DeleteUserV2.PathParameters> | null,
+      parameters: Parameters<Paths.DeleteUserV2.PathParameters>,
       data?: any,
@@ -1273,3 +1286,3 @@ config?: AxiosRequestConfig
     'get'(
-      parameters?: Parameters<Paths.GetGroup.PathParameters> | null,
+      parameters: Parameters<Paths.GetGroup.QueryParameters & Paths.GetGroup.PathParameters>,
       data?: any,
@@ -1284,3 +1297,3 @@ config?: AxiosRequestConfig
     'patch'(
-      parameters?: Parameters<Paths.UpdateGroup.PathParameters> | null,
+      parameters: Parameters<Paths.UpdateGroup.PathParameters>,
       data?: Paths.UpdateGroup.RequestBody,
@@ -1295,3 +1308,3 @@ config?: AxiosRequestConfig
     'delete'(
-      parameters?: Parameters<Paths.DeleteGroup.PathParameters> | null,
+      parameters: Parameters<Paths.DeleteGroup.PathParameters>,
       data?: any,
@@ -1308,3 +1321,3 @@ config?: AxiosRequestConfig
     'post'(
-      parameters?: Parameters<Paths.AdvanceUserAssignment.PathParameters> | null,
+      parameters: Parameters<Paths.AdvanceUserAssignment.PathParameters>,
       data?: any,
@@ -1345,3 +1358,3 @@ config?: AxiosRequestConfig
     'get'(
-      parameters?: Parameters<Paths.GetUserLoginParametersV2.PathParameters> | null,
+      parameters: Parameters<Paths.GetUserLoginParametersV2.PathParameters>,
       data?: any,
@@ -1382,3 +1395,3 @@ config?: AxiosRequestConfig
     'get'(
-      parameters?: Parameters<Paths.GetUser.PathParameters> | null,
+      parameters: Parameters<Paths.GetUser.PathParameters>,
       data?: any,
@@ -1395,3 +1408,3 @@ config?: AxiosRequestConfig
     'get'(
-      parameters?: Parameters<Paths.GetUserLoginParameters.PathParameters> | null,
+      parameters: Parameters<Paths.GetUserLoginParameters.PathParameters>,
       data?: any,
@@ -1398,0 +1411,0 @@ config?: AxiosRequestConfig

dist/openapi.json

@@ -382,2 +382,11 @@ {
             }
+          },
+          {
+            "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"
+            }
           }
@@ -457,2 +466,11 @@ ],
             }
+          },
+          {
+            "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"
+            }
           }
@@ -913,2 +931,5 @@ ],
       },
+      "Hydrate": {
+        "type": "boolean"
+      },
       "Username": {
@@ -1339,5 +1360,19 @@ "type": "string"
           },
-          "crt_user_id_assigned": {
-            "type": "string",
-            "example": "123"
+          "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
+                  }
+                }
+              }
+            ]
           },
@@ -1348,13 +1383,3 @@ "users": {
             "items": {
-              "allOf": [
-                {
-                  "$ref": "#/components/schemas/UserV2"
-                },
-                {
-                  "type": "object",
-                  "required": [
-                    "id"
-                  ]
-                }
-              ]
+              "$ref": "#/components/schemas/UserV2"
             }
@@ -1575,2 +1600,8 @@ }
       },
+      "DataPointsResponse": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/DataPoint"
+        }
+      },
       "DataPoint": {
@@ -1577,0 +1608,0 @@ "type": "object",

package.json

 {
   "name": "@epilot/user-client",
-  "version": "3.6.1-next.3",
+  "version": "3.6.1-next.4",
   "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",

No alert changes

Improved metrics

Total package byte prevSize

102216

increased by2.87%

Lines of code

3408

increased by2.25%

No dependency changes