@smartytalent/api-client 0.5.0 → 0.5.1

package/dist/apis/UsersApi.d.ts

@@ -91,12 +91,12 @@ export declare class UsersApi extends runtime.BaseAPI {
      */
     createUserRequestOpts(requestParameters: CreateUserRequest): Promise<runtime.RequestOpts>;
     /**
-     * Creates a new user in your account.  ### User\'s Attributes  Here is a table that describes the attributes of the user object:  | Attribute                  | Type   | Description                                                                 | |----------------------------|--------|-----------------------------------------------------------------------------| | `name`                     | string | The full name of the user.                                                  | | `status`                   | string | The current status of the user (e.g., active, inactive).                    | | `timestamps.created`       | string | The date and time when the user was created (ISO 8601 format).              | | `timestamps.modified`      | string | The date and time when the user was last modified (ISO 8601 format).        |
+     * Creates a new user in your account. Cognito sends the invitation email with a temporary password (valid 7 days).  Attaching a `role` relationship assigns the user\'s role at birth - this is privilege assignment, so it requires role sysowner/owner/admin, the role must exist, and assigning `owner`/`sysowner` requires standing on that rung. Creates without a role are open to any write-capable caller; the account then has no role and lands read-only.  ### User\'s Attributes  Here is a table that describes the attributes of the user object:  | Attribute                  | Type   | Description                                                                 | |----------------------------|--------|-----------------------------------------------------------------------------| | `name`                     | string | The full name of the user.                                                  | | `status`                   | string | The current status of the user (e.g., active, inactive).                    | | `timestamps.created`       | string | The date and time when the user was created (ISO 8601 format).              | | `timestamps.modified`      | string | The date and time when the user was last modified (ISO 8601 format).        |
      * Create User
      */
     createUserRaw(requestParameters: CreateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserSchema>>;
     /**
-     * Creates a new user in your account.  ### User\'s Attributes  Here is a table that describes the attributes of the user object:  | Attribute                  | Type   | Description                                                                 | |----------------------------|--------|-----------------------------------------------------------------------------| | `name`                     | string | The full name of the user.                                                  | | `status`                   | string | The current status of the user (e.g., active, inactive).                    | | `timestamps.created`       | string | The date and time when the user was created (ISO 8601 format).              | | `timestamps.modified`      | string | The date and time when the user was last modified (ISO 8601 format).        |
+     * Creates a new user in your account. Cognito sends the invitation email with a temporary password (valid 7 days).  Attaching a `role` relationship assigns the user\'s role at birth - this is privilege assignment, so it requires role sysowner/owner/admin, the role must exist, and assigning `owner`/`sysowner` requires standing on that rung. Creates without a role are open to any write-capable caller; the account then has no role and lands read-only.  ### User\'s Attributes  Here is a table that describes the attributes of the user object:  | Attribute                  | Type   | Description                                                                 | |----------------------------|--------|-----------------------------------------------------------------------------| | `name`                     | string | The full name of the user.                                                  | | `status`                   | string | The current status of the user (e.g., active, inactive).                    | | `timestamps.created`       | string | The date and time when the user was created (ISO 8601 format).              | | `timestamps.modified`      | string | The date and time when the user was last modified (ISO 8601 format).        |
      * Create User
      */
     createUser(requestParameters: CreateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserSchema>;
@@ -245,12 +245,12 @@ export declare class UsersApi extends runtime.BaseAPI {
      */
     updateUserRequestOpts(requestParameters: UpdateUserRequest): Promise<runtime.RequestOpts>;
     /**
-     * This endpoint allows you to update details of a specific user in your account. You can modify information such as name, and other relevant attributes of the user. Only the fields provided in the request will be updated.  Role change: a to-one `role` relationship in the request switches the user\'s role (and their Cognito `custom:userRole`). Callers need role sysowner/owner/admin; assigning or displacing `owner`/`sysowner` requires standing on that rung; system users\' roles cannot be changed. `jobs`/`apikeys` relationships are ignored on update.  Status change: `status` flips between `active` and `archived` and enables/disables the Cognito account accordingly (the restore door for a soft-deleted user). An actual status transition requires role sysowner/owner/admin, and archiving/restoring a user holding `owner`/`sysowner` requires standing on that rung. Omitting `status` (or echoing the current value) leaves permissions checks untouched.
+     * This endpoint allows you to update details of a specific user in your account. You can modify information such as name, and other relevant attributes of the user. Only the fields provided in the request will be updated.  Role change: a to-one `role` relationship in the request switches the user\'s role (and their Cognito `custom:userRole`). Callers need role sysowner/owner/admin; assigning or displacing `owner`/`sysowner` requires standing on that rung; system users\' roles cannot be changed. Sending `role` with `data: null` (unassign) is rejected - every user keeps exactly one role. `jobs`/`apikeys` relationships are ignored on update.  Status change: `status` flips between `active` and `archived` and enables/disables the Cognito account accordingly (the restore door for a soft-deleted user). An actual status transition requires role sysowner/owner/admin, and archiving/restoring a user holding `owner`/`sysowner` requires standing on that rung. Omitting `status` (or echoing the current value) leaves permissions checks untouched.
      * Update User
      */
     updateUserRaw(requestParameters: UpdateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserSchema>>;
     /**
-     * This endpoint allows you to update details of a specific user in your account. You can modify information such as name, and other relevant attributes of the user. Only the fields provided in the request will be updated.  Role change: a to-one `role` relationship in the request switches the user\'s role (and their Cognito `custom:userRole`). Callers need role sysowner/owner/admin; assigning or displacing `owner`/`sysowner` requires standing on that rung; system users\' roles cannot be changed. `jobs`/`apikeys` relationships are ignored on update.  Status change: `status` flips between `active` and `archived` and enables/disables the Cognito account accordingly (the restore door for a soft-deleted user). An actual status transition requires role sysowner/owner/admin, and archiving/restoring a user holding `owner`/`sysowner` requires standing on that rung. Omitting `status` (or echoing the current value) leaves permissions checks untouched.
+     * This endpoint allows you to update details of a specific user in your account. You can modify information such as name, and other relevant attributes of the user. Only the fields provided in the request will be updated.  Role change: a to-one `role` relationship in the request switches the user\'s role (and their Cognito `custom:userRole`). Callers need role sysowner/owner/admin; assigning or displacing `owner`/`sysowner` requires standing on that rung; system users\' roles cannot be changed. Sending `role` with `data: null` (unassign) is rejected - every user keeps exactly one role. `jobs`/`apikeys` relationships are ignored on update.  Status change: `status` flips between `active` and `archived` and enables/disables the Cognito account accordingly (the restore door for a soft-deleted user). An actual status transition requires role sysowner/owner/admin, and archiving/restoring a user holding `owner`/`sysowner` requires standing on that rung. Omitting `status` (or echoing the current value) leaves permissions checks untouched.
      * Update User
      */
     updateUser(requestParameters: UpdateUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserSchema>;

package/dist/apis/UsersApi.js

@@ -80,7 +80,7 @@ class UsersApi extends runtime.BaseAPI {
         };
     }
     /**
-     * Creates a new user in your account.  ### User\'s Attributes  Here is a table that describes the attributes of the user object:  | Attribute                  | Type   | Description                                                                 | |----------------------------|--------|-----------------------------------------------------------------------------| | `name`                     | string | The full name of the user.                                                  | | `status`                   | string | The current status of the user (e.g., active, inactive).                    | | `timestamps.created`       | string | The date and time when the user was created (ISO 8601 format).              | | `timestamps.modified`      | string | The date and time when the user was last modified (ISO 8601 format).        |
+     * Creates a new user in your account. Cognito sends the invitation email with a temporary password (valid 7 days).  Attaching a `role` relationship assigns the user\'s role at birth - this is privilege assignment, so it requires role sysowner/owner/admin, the role must exist, and assigning `owner`/`sysowner` requires standing on that rung. Creates without a role are open to any write-capable caller; the account then has no role and lands read-only.  ### User\'s Attributes  Here is a table that describes the attributes of the user object:  | Attribute                  | Type   | Description                                                                 | |----------------------------|--------|-----------------------------------------------------------------------------| | `name`                     | string | The full name of the user.                                                  | | `status`                   | string | The current status of the user (e.g., active, inactive).                    | | `timestamps.created`       | string | The date and time when the user was created (ISO 8601 format).              | | `timestamps.modified`      | string | The date and time when the user was last modified (ISO 8601 format).        |
      * Create User
      */
     async createUserRaw(requestParameters, initOverrides) {
@@ -89,7 +89,7 @@ class UsersApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserSchemaFromJSON)(jsonValue));
     }
     /**
-     * Creates a new user in your account.  ### User\'s Attributes  Here is a table that describes the attributes of the user object:  | Attribute                  | Type   | Description                                                                 | |----------------------------|--------|-----------------------------------------------------------------------------| | `name`                     | string | The full name of the user.                                                  | | `status`                   | string | The current status of the user (e.g., active, inactive).                    | | `timestamps.created`       | string | The date and time when the user was created (ISO 8601 format).              | | `timestamps.modified`      | string | The date and time when the user was last modified (ISO 8601 format).        |
+     * Creates a new user in your account. Cognito sends the invitation email with a temporary password (valid 7 days).  Attaching a `role` relationship assigns the user\'s role at birth - this is privilege assignment, so it requires role sysowner/owner/admin, the role must exist, and assigning `owner`/`sysowner` requires standing on that rung. Creates without a role are open to any write-capable caller; the account then has no role and lands read-only.  ### User\'s Attributes  Here is a table that describes the attributes of the user object:  | Attribute                  | Type   | Description                                                                 | |----------------------------|--------|-----------------------------------------------------------------------------| | `name`                     | string | The full name of the user.                                                  | | `status`                   | string | The current status of the user (e.g., active, inactive).                    | | `timestamps.created`       | string | The date and time when the user was created (ISO 8601 format).              | | `timestamps.modified`      | string | The date and time when the user was last modified (ISO 8601 format).        |
      * Create User
      */
     async createUser(requestParameters, initOverrides) {
@@ -577,7 +577,7 @@ class UsersApi extends runtime.BaseAPI {
         };
     }
     /**
-     * This endpoint allows you to update details of a specific user in your account. You can modify information such as name, and other relevant attributes of the user. Only the fields provided in the request will be updated.  Role change: a to-one `role` relationship in the request switches the user\'s role (and their Cognito `custom:userRole`). Callers need role sysowner/owner/admin; assigning or displacing `owner`/`sysowner` requires standing on that rung; system users\' roles cannot be changed. `jobs`/`apikeys` relationships are ignored on update.  Status change: `status` flips between `active` and `archived` and enables/disables the Cognito account accordingly (the restore door for a soft-deleted user). An actual status transition requires role sysowner/owner/admin, and archiving/restoring a user holding `owner`/`sysowner` requires standing on that rung. Omitting `status` (or echoing the current value) leaves permissions checks untouched.
+     * This endpoint allows you to update details of a specific user in your account. You can modify information such as name, and other relevant attributes of the user. Only the fields provided in the request will be updated.  Role change: a to-one `role` relationship in the request switches the user\'s role (and their Cognito `custom:userRole`). Callers need role sysowner/owner/admin; assigning or displacing `owner`/`sysowner` requires standing on that rung; system users\' roles cannot be changed. Sending `role` with `data: null` (unassign) is rejected - every user keeps exactly one role. `jobs`/`apikeys` relationships are ignored on update.  Status change: `status` flips between `active` and `archived` and enables/disables the Cognito account accordingly (the restore door for a soft-deleted user). An actual status transition requires role sysowner/owner/admin, and archiving/restoring a user holding `owner`/`sysowner` requires standing on that rung. Omitting `status` (or echoing the current value) leaves permissions checks untouched.
      * Update User
      */
     async updateUserRaw(requestParameters, initOverrides) {
@@ -586,7 +586,7 @@ class UsersApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserSchemaFromJSON)(jsonValue));
     }
     /**
-     * This endpoint allows you to update details of a specific user in your account. You can modify information such as name, and other relevant attributes of the user. Only the fields provided in the request will be updated.  Role change: a to-one `role` relationship in the request switches the user\'s role (and their Cognito `custom:userRole`). Callers need role sysowner/owner/admin; assigning or displacing `owner`/`sysowner` requires standing on that rung; system users\' roles cannot be changed. `jobs`/`apikeys` relationships are ignored on update.  Status change: `status` flips between `active` and `archived` and enables/disables the Cognito account accordingly (the restore door for a soft-deleted user). An actual status transition requires role sysowner/owner/admin, and archiving/restoring a user holding `owner`/`sysowner` requires standing on that rung. Omitting `status` (or echoing the current value) leaves permissions checks untouched.
+     * This endpoint allows you to update details of a specific user in your account. You can modify information such as name, and other relevant attributes of the user. Only the fields provided in the request will be updated.  Role change: a to-one `role` relationship in the request switches the user\'s role (and their Cognito `custom:userRole`). Callers need role sysowner/owner/admin; assigning or displacing `owner`/`sysowner` requires standing on that rung; system users\' roles cannot be changed. Sending `role` with `data: null` (unassign) is rejected - every user keeps exactly one role. `jobs`/`apikeys` relationships are ignored on update.  Status change: `status` flips between `active` and `archived` and enables/disables the Cognito account accordingly (the restore door for a soft-deleted user). An actual status transition requires role sysowner/owner/admin, and archiving/restoring a user holding `owner`/`sysowner` requires standing on that rung. Omitting `status` (or echoing the current value) leaves permissions checks untouched.
      * Update User
      */
     async updateUser(requestParameters, initOverrides) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartytalent/api-client",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "TypeScript API client generated from SmartyTalent OpenAPI spec",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",