@liaisongroup/assist-api-js-client 1.5.123 → 1.5.124

package/dist/openapi.d.ts

@@ -107,6 +107,24 @@ declare namespace Components {
             included?: ActionInclusions;
         }
         export type AdministrableResources = ("user" | "field" | "template" | "saved_filter" | "list" | "tag" | "role")[];
+        export interface AuthApplication {
+            data: AuthApplicationData;
+            links: Links;
+        }
+        export interface AuthApplicationAttributes {
+            name?: string;
+            uid?: string;
+        }
+        export interface AuthApplicationData {
+            type: "auth_application";
+            id: string;
+            attributes: AuthApplicationAttributes;
+        }
+        export interface AuthApplications {
+            data: AuthApplicationData[];
+            meta: Meta;
+            links: Links;
+        }
         export interface BroadcastEvent {
             type: "destroyed" | "updated" | "created";
             data: {
@@ -618,6 +636,12 @@ declare namespace Components {
         export interface FieldSettingAttributes {
             field_id?: string; // uuid
             template_id?: string; // uuid
+            /**
+             * The roles that are allowed to access this field setting.
+             * If not provided, the field setting will be accessible to all roles.
+             *
+             */
+            role_ids?: string /* uuid */[];
             required?: boolean;
             position?: number;
             meta?: {
@@ -746,12 +770,24 @@ declare namespace Components {
                 }
                 export type Position = number;
                 export type Required = boolean;
+                /**
+                 * The roles that are allowed to access this field setting.
+                 * If not provided, the field setting will be accessible to all roles.
+                 *
+                 */
+                export type RoleIds = string /* uuid */[];
                 export type TemplateId = string; // uuid
             }
         }
         export interface FieldSettingCreateAttributes {
             field_id: FieldSettingAttributes.Properties.FieldId /* uuid */;
             template_id: FieldSettingAttributes.Properties.TemplateId /* uuid */;
+            role_ids?: /**
+             * The roles that are allowed to access this field setting.
+             * If not provided, the field setting will be accessible to all roles.
+             *
+             */
+            FieldSettingAttributes.Properties.RoleIds;
             required?: FieldSettingAttributes.Properties.Required;
             position?: FieldSettingAttributes.Properties.Position;
             meta?: FieldSettingAttributes.Properties.Meta;
@@ -762,6 +798,7 @@ declare namespace Components {
             attributes: FieldSettingAttributes;
             relationships: {
                 field?: FieldRelationship;
+                roles?: RolesRelationship;
                 template?: TemplateRelationship;
                 versions?: VersionsRelationship;
             };
@@ -770,6 +807,7 @@ declare namespace Components {
             namespace Properties {
                 export interface Relationships {
                     field?: FieldRelationship;
+                    roles?: RolesRelationship;
                     template?: TemplateRelationship;
                     versions?: VersionsRelationship;
                 }
@@ -781,7 +819,7 @@ declare namespace Components {
             attributes: FieldSettingAttributes;
             relationships: FieldSettingData.Properties.Relationships;
         }
-        export type FieldSettingInclusions = (CaseInclusion | FieldInclusion | FieldSettingInclusion | NoteInclusion | TagInclusion | TaskInclusion | TemplateInclusion | VersionInclusion)[];
+        export type FieldSettingInclusions = (CaseInclusion | FieldInclusion | FieldSettingInclusion | NoteInclusion | RoleInclusion | TagInclusion | TaskInclusion | TemplateInclusion | VersionInclusion)[];
         export interface FieldSettings {
             data: FieldSettingData[];
             meta: Meta;
@@ -875,7 +913,7 @@ declare namespace Components {
              */
             interpolated_name?: string;
         }
-        export type KnownConfigIDs = "action_resources" | "admin_resources" | "db_reset" | "field_resources" | "field_setting_restriction_constraints" | "field_setting_restriction_operators" | "hide_tasks" | "hl7_message_lifespan" | "password_regex" | "password_regex_message" | "role_resources" | "skip_rack_attack" | "task_delete_reasons";
+        export type KnownConfigIDs = "action_resources" | "admin_resources" | "db_reset" | "field_resources" | "field_setting_restriction_constraints" | "field_setting_restriction_operators" | "hide_tasks" | "hl7_message_lifespan" | "password_regex" | "password_regex_message" | "role_resources" | "skip_rack_attack" | "task_delete_reasons" | "task_duration";
         export interface Links {
             self?: string;
             current?: string;
@@ -1385,8 +1423,9 @@ declare namespace Components {
         }
         export type RoleInclusions = (UserInclusion | TeamInclusion)[];
         export interface RoleRelationships {
-            users?: UsersRelationship;
+            field_settings?: FieldSettingsRelationship;
             teams?: TeamsRelationship;
+            users?: UsersRelationship;
         }
         export interface Roles {
             data: RoleData[];
@@ -2059,13 +2098,21 @@ declare namespace Components {
              */
             password_required?: boolean;
             /**
-             * Can be set to true to send an invitation email to the user upon creation
+             * DEPRECATED: Use `invitation_destination_url` instead - this will be removed in a future release.
+             * Can be set to true to send an invitation email to the user upon creation - this email does not contain instructions on how to setup an account - it is purely to inform the user that an account has been created for them.
              *
              */
             send_invitation?: boolean;
+            /**
+             * The URL the invitation email should send the user to.
+             * Setting this value triggers the "Invitation" email to be sent to the user.
+             *
+             */
+            invitation_destination_url?: string; // uri
             /**
              * The URL the set password email should send the user to in order to set their password.
              * The API will append a token to the URL as a query parameter (e.g. `https://localhost:3000/set-password?token=123456`).
+             * Setting this value triggers the "Set password" email to be sent to the user.
              *
              * example:
              * https://localhost:3000/set-password
@@ -3447,6 +3494,13 @@ declare namespace Paths {
             export type $403 = Components.Schemas.Errors;
         }
     }
+    namespace IndexAuthApplications {
+        namespace Responses {
+            export type $200 = Components.Schemas.AuthApplications;
+            export type $401 = Components.Schemas.Errors;
+            export type $403 = Components.Schemas.Errors;
+        }
+    }
     namespace IntrospectAccessToken {
         export interface RequestBody {
             token: string; // jwt
@@ -3519,6 +3573,19 @@ declare namespace Paths {
             }
         }
     }
+    namespace ShowAuthApplication {
+        namespace Parameters {
+            export type Id = string; // uuid
+        }
+        export interface PathParameters {
+            id: Parameters.Id /* uuid */;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.AuthApplication;
+            export type $401 = Components.Schemas.Errors;
+            export type $403 = Components.Schemas.Errors;
+        }
+    }
     namespace UpdateAction {
         namespace Parameters {
             export type Id = string; // uuid
@@ -4992,6 +5059,22 @@ export interface OperationMethods {
     data?: Paths.CreatePushSubscription.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.CreatePushSubscription.Responses.$201>
+  /**
+   * index_auth_applications - List auth applications
+   */
+  'index_auth_applications'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.IndexAuthApplications.Responses.$200>
+  /**
+   * show_auth_application - Show auth application
+   */
+  'show_auth_application'(
+    parameters?: Parameters<Paths.ShowAuthApplication.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ShowAuthApplication.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -6136,6 +6219,26 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.CreatePushSubscription.Responses.$201>
   }
+  ['/auth_applications']: {
+    /**
+     * index_auth_applications - List auth applications
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.IndexAuthApplications.Responses.$200>
+  }
+  ['/auth_applications/{id}']: {
+    /**
+     * show_auth_application - Show auth application
+     */
+    'get'(
+      parameters?: Parameters<Paths.ShowAuthApplication.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ShowAuthApplication.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
@@ -6162,6 +6265,10 @@ export type ActionTypeInputsOutputs = Components.Schemas.ActionTypeInputsOutputs
 export type ActionTypes = Components.Schemas.ActionTypes;
 export type Actions = Components.Schemas.Actions;
 export type AdministrableResources = Components.Schemas.AdministrableResources;
+export type AuthApplication = Components.Schemas.AuthApplication;
+export type AuthApplicationAttributes = Components.Schemas.AuthApplicationAttributes;
+export type AuthApplicationData = Components.Schemas.AuthApplicationData;
+export type AuthApplications = Components.Schemas.AuthApplications;
 export type BroadcastEvent = Components.Schemas.BroadcastEvent;
 export type BroadcastToEvent = Components.Schemas.BroadcastToEvent;
 export type CalculationAction = Components.Schemas.CalculationAction;
@@ -6212,6 +6319,7 @@ export type FieldSettingAttributes/properties/field_id = Components.Schemas.Fiel
 export type FieldSettingAttributes/properties/meta = Components.Schemas.FieldSettingAttributes.Properties.Meta;
 export type FieldSettingAttributes/properties/position = Components.Schemas.FieldSettingAttributes.Properties.Position;
 export type FieldSettingAttributes/properties/required = Components.Schemas.FieldSettingAttributes.Properties.Required;
+export type FieldSettingAttributes/properties/role_ids = Components.Schemas.FieldSettingAttributes.Properties.RoleIds;
 export type FieldSettingAttributes/properties/template_id = Components.Schemas.FieldSettingAttributes.Properties.TemplateId;
 export type FieldSettingCreateAttributes = Components.Schemas.FieldSettingCreateAttributes;
 export type FieldSettingData = Components.Schemas.FieldSettingData;

package/dist/openapi.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Liaison Assist API",
     "description": "![Hero](./hero.svg)\n",
-    "version": "0.0.338-hotfix-4",
+    "version": "0.0.350",
     "license": {
       "name": "MIT",
       "url": "https://opensource.org/licenses/MIT"
@@ -159,6 +159,10 @@
     {
       "name": "Password Resets",
       "description": "Password resets are used to reset a user's password.\nA password reset journey can be started with via the POST `/password_resets` endpoint.\nThe journey can be completed by sending a PUT request to `/password_resets/{token}`.\n"
+    },
+    {
+      "name": "Auth Applications",
+      "description": "Auth Applications are used to store information about the applications that are allowed to use the API.\n"
     }
   ],
   "paths": {
@@ -9105,6 +9109,115 @@
           }
         }
       }
+    },
+    "/auth_applications": {
+      "get": {
+        "operationId": "index_auth_applications",
+        "summary": "List auth applications",
+        "tags": [
+          "Auth Applications"
+        ],
+        "security": [
+          {
+            "bearerAuth": []
+          },
+          {
+            "cookieAuth": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AuthApplications"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/auth_applications/{id}": {
+      "get": {
+        "operationId": "show_auth_application",
+        "summary": "Show auth application",
+        "tags": [
+          "Auth Applications"
+        ],
+        "security": [
+          {
+            "bearerAuth": []
+          },
+          {
+            "cookieAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AuthApplication"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "content": {
+              "application/vnd.api+json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Errors"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -9536,6 +9649,79 @@
           }
         }
       },
+      "AuthApplicationAttributes": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "uid": {
+            "type": "string"
+          }
+        }
+      },
+      "AuthApplicationData": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "type",
+          "id",
+          "attributes"
+        ],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "auth_application"
+            ]
+          },
+          "id": {
+            "type": "string"
+          },
+          "attributes": {
+            "$ref": "#/components/schemas/AuthApplicationAttributes"
+          }
+        }
+      },
+      "AuthApplication": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "data",
+          "links"
+        ],
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/AuthApplicationData"
+          },
+          "links": {
+            "$ref": "#/components/schemas/Links"
+          }
+        }
+      },
+      "AuthApplications": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "data",
+          "meta",
+          "links"
+        ],
+        "properties": {
+          "data": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/AuthApplicationData"
+            }
+          },
+          "meta": {
+            "$ref": "#/components/schemas/Meta"
+          },
+          "links": {
+            "$ref": "#/components/schemas/Links"
+          }
+        }
+      },
       "CaseCreateAttributes": {
         "type": "object",
         "required": [
@@ -10671,6 +10857,15 @@
             "format": "uuid",
             "writeOnly": true
           },
+          "role_ids": {
+            "type": "array",
+            "description": "The roles that are allowed to access this field setting.\nIf not provided, the field setting will be accessible to all roles.\n",
+            "items": {
+              "type": "string",
+              "format": "uuid"
+            },
+            "writeOnly": true
+          },
           "required": {
             "type": "boolean"
           },
@@ -10874,6 +11069,9 @@
           "template_id": {
             "$ref": "#/components/schemas/FieldSettingAttributes/properties/template_id"
           },
+          "role_ids": {
+            "$ref": "#/components/schemas/FieldSettingAttributes/properties/role_ids"
+          },
           "required": {
             "$ref": "#/components/schemas/FieldSettingAttributes/properties/required"
           },
@@ -10915,6 +11113,9 @@
               "field": {
                 "$ref": "#/components/schemas/FieldRelationship"
               },
+              "roles": {
+                "$ref": "#/components/schemas/RolesRelationship"
+              },
               "template": {
                 "$ref": "#/components/schemas/TemplateRelationship"
               },
@@ -10969,6 +11170,9 @@
             {
               "$ref": "#/components/schemas/NoteInclusion"
             },
+            {
+              "$ref": "#/components/schemas/RoleInclusion"
+            },
             {
               "$ref": "#/components/schemas/TagInclusion"
             },
@@ -12434,11 +12638,14 @@
         "type": "object",
         "additionalProperties": false,
         "properties": {
-          "users": {
-            "$ref": "#/components/schemas/UsersRelationship"
+          "field_settings": {
+            "$ref": "#/components/schemas/FieldSettingsRelationship"
           },
           "teams": {
             "$ref": "#/components/schemas/TeamsRelationship"
+          },
+          "users": {
+            "$ref": "#/components/schemas/UsersRelationship"
           }
         }
       },
@@ -12829,10 +13036,12 @@
           "config": {
             "anyOf": [
               {
-                "$ref": "#/components/schemas/SamlConfig"
+                "$ref": "#/components/schemas/SamlConfig",
+                "name": "SAML Config"
               },
               {
-                "$ref": "#/components/schemas/OidcConfig"
+                "$ref": "#/components/schemas/OidcConfig",
+                "name": "OIDC Config"
               }
             ]
           },
@@ -14490,12 +14699,17 @@
           "send_invitation": {
             "type": "boolean",
             "default": false,
-            "description": "Can be set to true to send an invitation email to the user upon creation\n"
+            "description": "DEPRECATED: Use `invitation_destination_url` instead - this will be removed in a future release.\nCan be set to true to send an invitation email to the user upon creation - this email does not contain instructions on how to setup an account - it is purely to inform the user that an account has been created for them.\n"
+          },
+          "invitation_destination_url": {
+            "type": "string",
+            "format": "uri",
+            "description": "The URL the invitation email should send the user to.\nSetting this value triggers the \"Invitation\" email to be sent to the user.\n"
           },
           "set_password_destination_url": {
             "type": "string",
             "format": "uri",
-            "description": "The URL the set password email should send the user to in order to set their password.\nThe API will append a token to the URL as a query parameter (e.g. `https://localhost:3000/set-password?token=123456`).\n",
+            "description": "The URL the set password email should send the user to in order to set their password.\nThe API will append a token to the URL as a query parameter (e.g. `https://localhost:3000/set-password?token=123456`).\nSetting this value triggers the \"Set password\" email to be sent to the user.\n",
             "example": "https://localhost:3000/set-password"
           },
           "active": {
@@ -15282,7 +15496,8 @@
           "password_regex_message",
           "role_resources",
           "skip_rack_attack",
-          "task_delete_reasons"
+          "task_delete_reasons",
+          "task_duration"
         ]
       },
       "AccessToken": {