@liaisongroup/assist-api-js-client 1.5.119 → 1.5.121

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/openapi.d.ts CHANGED
@@ -107,24 +107,6 @@ declare namespace Components {
107
107
  included?: ActionInclusions;
108
108
  }
109
109
  export type AdministrableResources = ("user" | "field" | "template" | "saved_filter" | "list" | "tag" | "role")[];
110
- export interface AuthApplication {
111
- data: AuthApplicationData;
112
- links: Links;
113
- }
114
- export interface AuthApplicationAttributes {
115
- name?: string;
116
- uid?: string;
117
- }
118
- export interface AuthApplicationData {
119
- type: "auth_application";
120
- id: string;
121
- attributes: AuthApplicationAttributes;
122
- }
123
- export interface AuthApplications {
124
- data: AuthApplicationData[];
125
- meta: Meta;
126
- links: Links;
127
- }
128
110
  export interface BroadcastEvent {
129
111
  type: "destroyed" | "updated" | "created";
130
112
  data: {
@@ -636,12 +618,6 @@ declare namespace Components {
636
618
  export interface FieldSettingAttributes {
637
619
  field_id?: string; // uuid
638
620
  template_id?: string; // uuid
639
- /**
640
- * The roles that are allowed to access this field setting.
641
- * If not provided, the field setting will be accessible to all roles.
642
- *
643
- */
644
- role_ids?: string /* uuid */[];
645
621
  required?: boolean;
646
622
  position?: number;
647
623
  meta?: {
@@ -770,24 +746,12 @@ declare namespace Components {
770
746
  }
771
747
  export type Position = number;
772
748
  export type Required = boolean;
773
- /**
774
- * The roles that are allowed to access this field setting.
775
- * If not provided, the field setting will be accessible to all roles.
776
- *
777
- */
778
- export type RoleIds = string /* uuid */[];
779
749
  export type TemplateId = string; // uuid
780
750
  }
781
751
  }
782
752
  export interface FieldSettingCreateAttributes {
783
753
  field_id: FieldSettingAttributes.Properties.FieldId /* uuid */;
784
754
  template_id: FieldSettingAttributes.Properties.TemplateId /* uuid */;
785
- role_ids?: /**
786
- * The roles that are allowed to access this field setting.
787
- * If not provided, the field setting will be accessible to all roles.
788
- *
789
- */
790
- FieldSettingAttributes.Properties.RoleIds;
791
755
  required?: FieldSettingAttributes.Properties.Required;
792
756
  position?: FieldSettingAttributes.Properties.Position;
793
757
  meta?: FieldSettingAttributes.Properties.Meta;
@@ -798,7 +762,6 @@ declare namespace Components {
798
762
  attributes: FieldSettingAttributes;
799
763
  relationships: {
800
764
  field?: FieldRelationship;
801
- roles?: RolesRelationship;
802
765
  template?: TemplateRelationship;
803
766
  versions?: VersionsRelationship;
804
767
  };
@@ -807,7 +770,6 @@ declare namespace Components {
807
770
  namespace Properties {
808
771
  export interface Relationships {
809
772
  field?: FieldRelationship;
810
- roles?: RolesRelationship;
811
773
  template?: TemplateRelationship;
812
774
  versions?: VersionsRelationship;
813
775
  }
@@ -819,7 +781,7 @@ declare namespace Components {
819
781
  attributes: FieldSettingAttributes;
820
782
  relationships: FieldSettingData.Properties.Relationships;
821
783
  }
822
- export type FieldSettingInclusions = (CaseInclusion | FieldInclusion | FieldSettingInclusion | NoteInclusion | RoleInclusion | TagInclusion | TaskInclusion | TemplateInclusion | VersionInclusion)[];
784
+ export type FieldSettingInclusions = (CaseInclusion | FieldInclusion | FieldSettingInclusion | NoteInclusion | TagInclusion | TaskInclusion | TemplateInclusion | VersionInclusion)[];
823
785
  export interface FieldSettings {
824
786
  data: FieldSettingData[];
825
787
  meta: Meta;
@@ -913,7 +875,7 @@ declare namespace Components {
913
875
  */
914
876
  interpolated_name?: string;
915
877
  }
916
- 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";
878
+ 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";
917
879
  export interface Links {
918
880
  self?: string;
919
881
  current?: string;
@@ -1423,9 +1385,8 @@ declare namespace Components {
1423
1385
  }
1424
1386
  export type RoleInclusions = (UserInclusion | TeamInclusion)[];
1425
1387
  export interface RoleRelationships {
1426
- field_settings?: FieldSettingsRelationship;
1427
- teams?: TeamsRelationship;
1428
1388
  users?: UsersRelationship;
1389
+ teams?: TeamsRelationship;
1429
1390
  }
1430
1391
  export interface Roles {
1431
1392
  data: RoleData[];
@@ -2098,21 +2059,13 @@ declare namespace Components {
2098
2059
  */
2099
2060
  password_required?: boolean;
2100
2061
  /**
2101
- * DEPRECATED: Use `invitation_destination_url` instead - this will be removed in a future release.
2102
- * 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.
2062
+ * Can be set to true to send an invitation email to the user upon creation
2103
2063
  *
2104
2064
  */
2105
2065
  send_invitation?: boolean;
2106
- /**
2107
- * The URL the invitation email should send the user to.
2108
- * Setting this value triggers the "Invitation" email to be sent to the user.
2109
- *
2110
- */
2111
- invitation_destination_url?: string; // uri
2112
2066
  /**
2113
2067
  * The URL the set password email should send the user to in order to set their password.
2114
2068
  * The API will append a token to the URL as a query parameter (e.g. `https://localhost:3000/set-password?token=123456`).
2115
- * Setting this value triggers the "Set password" email to be sent to the user.
2116
2069
  *
2117
2070
  * example:
2118
2071
  * https://localhost:3000/set-password
@@ -3494,13 +3447,6 @@ declare namespace Paths {
3494
3447
  export type $403 = Components.Schemas.Errors;
3495
3448
  }
3496
3449
  }
3497
- namespace IndexAuthApplications {
3498
- namespace Responses {
3499
- export type $200 = Components.Schemas.AuthApplications;
3500
- export type $401 = Components.Schemas.Errors;
3501
- export type $403 = Components.Schemas.Errors;
3502
- }
3503
- }
3504
3450
  namespace IntrospectAccessToken {
3505
3451
  export interface RequestBody {
3506
3452
  token: string; // jwt
@@ -3573,19 +3519,6 @@ declare namespace Paths {
3573
3519
  }
3574
3520
  }
3575
3521
  }
3576
- namespace ShowAuthApplication {
3577
- namespace Parameters {
3578
- export type Id = string; // uuid
3579
- }
3580
- export interface PathParameters {
3581
- id: Parameters.Id /* uuid */;
3582
- }
3583
- namespace Responses {
3584
- export type $200 = Components.Schemas.AuthApplication;
3585
- export type $401 = Components.Schemas.Errors;
3586
- export type $403 = Components.Schemas.Errors;
3587
- }
3588
- }
3589
3522
  namespace UpdateAction {
3590
3523
  namespace Parameters {
3591
3524
  export type Id = string; // uuid
@@ -5059,22 +4992,6 @@ export interface OperationMethods {
5059
4992
  data?: Paths.CreatePushSubscription.RequestBody,
5060
4993
  config?: AxiosRequestConfig
5061
4994
  ): OperationResponse<Paths.CreatePushSubscription.Responses.$201>
5062
- /**
5063
- * index_auth_applications - List auth applications
5064
- */
5065
- 'index_auth_applications'(
5066
- parameters?: Parameters<UnknownParamsObject> | null,
5067
- data?: any,
5068
- config?: AxiosRequestConfig
5069
- ): OperationResponse<Paths.IndexAuthApplications.Responses.$200>
5070
- /**
5071
- * show_auth_application - Show auth application
5072
- */
5073
- 'show_auth_application'(
5074
- parameters?: Parameters<Paths.ShowAuthApplication.PathParameters> | null,
5075
- data?: any,
5076
- config?: AxiosRequestConfig
5077
- ): OperationResponse<Paths.ShowAuthApplication.Responses.$200>
5078
4995
  }
5079
4996
 
5080
4997
  export interface PathsDictionary {
@@ -6219,26 +6136,6 @@ export interface PathsDictionary {
6219
6136
  config?: AxiosRequestConfig
6220
6137
  ): OperationResponse<Paths.CreatePushSubscription.Responses.$201>
6221
6138
  }
6222
- ['/auth_applications']: {
6223
- /**
6224
- * index_auth_applications - List auth applications
6225
- */
6226
- 'get'(
6227
- parameters?: Parameters<UnknownParamsObject> | null,
6228
- data?: any,
6229
- config?: AxiosRequestConfig
6230
- ): OperationResponse<Paths.IndexAuthApplications.Responses.$200>
6231
- }
6232
- ['/auth_applications/{id}']: {
6233
- /**
6234
- * show_auth_application - Show auth application
6235
- */
6236
- 'get'(
6237
- parameters?: Parameters<Paths.ShowAuthApplication.PathParameters> | null,
6238
- data?: any,
6239
- config?: AxiosRequestConfig
6240
- ): OperationResponse<Paths.ShowAuthApplication.Responses.$200>
6241
- }
6242
6139
  }
6243
6140
 
6244
6141
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
@@ -6265,10 +6162,6 @@ export type ActionTypeInputsOutputs = Components.Schemas.ActionTypeInputsOutputs
6265
6162
  export type ActionTypes = Components.Schemas.ActionTypes;
6266
6163
  export type Actions = Components.Schemas.Actions;
6267
6164
  export type AdministrableResources = Components.Schemas.AdministrableResources;
6268
- export type AuthApplication = Components.Schemas.AuthApplication;
6269
- export type AuthApplicationAttributes = Components.Schemas.AuthApplicationAttributes;
6270
- export type AuthApplicationData = Components.Schemas.AuthApplicationData;
6271
- export type AuthApplications = Components.Schemas.AuthApplications;
6272
6165
  export type BroadcastEvent = Components.Schemas.BroadcastEvent;
6273
6166
  export type BroadcastToEvent = Components.Schemas.BroadcastToEvent;
6274
6167
  export type CalculationAction = Components.Schemas.CalculationAction;
@@ -6319,7 +6212,6 @@ export type FieldSettingAttributes/properties/field_id = Components.Schemas.Fiel
6319
6212
  export type FieldSettingAttributes/properties/meta = Components.Schemas.FieldSettingAttributes.Properties.Meta;
6320
6213
  export type FieldSettingAttributes/properties/position = Components.Schemas.FieldSettingAttributes.Properties.Position;
6321
6214
  export type FieldSettingAttributes/properties/required = Components.Schemas.FieldSettingAttributes.Properties.Required;
6322
- export type FieldSettingAttributes/properties/role_ids = Components.Schemas.FieldSettingAttributes.Properties.RoleIds;
6323
6215
  export type FieldSettingAttributes/properties/template_id = Components.Schemas.FieldSettingAttributes.Properties.TemplateId;
6324
6216
  export type FieldSettingCreateAttributes = Components.Schemas.FieldSettingCreateAttributes;
6325
6217
  export type FieldSettingData = Components.Schemas.FieldSettingData;
package/dist/openapi.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "title": "Liaison Assist API",
5
5
  "description": "![Hero](./hero.svg)\n",
6
- "version": "0.0.348",
6
+ "version": "0.0.338-hotfix-3",
7
7
  "license": {
8
8
  "name": "MIT",
9
9
  "url": "https://opensource.org/licenses/MIT"
@@ -159,10 +159,6 @@
159
159
  {
160
160
  "name": "Password Resets",
161
161
  "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"
162
- },
163
- {
164
- "name": "Auth Applications",
165
- "description": "Auth Applications are used to store information about the applications that are allowed to use the API.\n"
166
162
  }
167
163
  ],
168
164
  "paths": {
@@ -9109,115 +9105,6 @@
9109
9105
  }
9110
9106
  }
9111
9107
  }
9112
- },
9113
- "/auth_applications": {
9114
- "get": {
9115
- "operationId": "index_auth_applications",
9116
- "summary": "List auth applications",
9117
- "tags": [
9118
- "Auth Applications"
9119
- ],
9120
- "security": [
9121
- {
9122
- "bearerAuth": []
9123
- },
9124
- {
9125
- "cookieAuth": []
9126
- }
9127
- ],
9128
- "responses": {
9129
- "200": {
9130
- "description": "OK",
9131
- "content": {
9132
- "application/vnd.api+json": {
9133
- "schema": {
9134
- "$ref": "#/components/schemas/AuthApplications"
9135
- }
9136
- }
9137
- }
9138
- },
9139
- "401": {
9140
- "description": "Unauthorized",
9141
- "content": {
9142
- "application/vnd.api+json": {
9143
- "schema": {
9144
- "$ref": "#/components/schemas/Errors"
9145
- }
9146
- }
9147
- }
9148
- },
9149
- "403": {
9150
- "description": "Forbidden",
9151
- "content": {
9152
- "application/vnd.api+json": {
9153
- "schema": {
9154
- "$ref": "#/components/schemas/Errors"
9155
- }
9156
- }
9157
- }
9158
- }
9159
- }
9160
- }
9161
- },
9162
- "/auth_applications/{id}": {
9163
- "get": {
9164
- "operationId": "show_auth_application",
9165
- "summary": "Show auth application",
9166
- "tags": [
9167
- "Auth Applications"
9168
- ],
9169
- "security": [
9170
- {
9171
- "bearerAuth": []
9172
- },
9173
- {
9174
- "cookieAuth": []
9175
- }
9176
- ],
9177
- "parameters": [
9178
- {
9179
- "name": "id",
9180
- "in": "path",
9181
- "required": true,
9182
- "schema": {
9183
- "type": "string",
9184
- "format": "uuid"
9185
- }
9186
- }
9187
- ],
9188
- "responses": {
9189
- "200": {
9190
- "description": "OK",
9191
- "content": {
9192
- "application/vnd.api+json": {
9193
- "schema": {
9194
- "$ref": "#/components/schemas/AuthApplication"
9195
- }
9196
- }
9197
- }
9198
- },
9199
- "401": {
9200
- "description": "Unauthorized",
9201
- "content": {
9202
- "application/vnd.api+json": {
9203
- "schema": {
9204
- "$ref": "#/components/schemas/Errors"
9205
- }
9206
- }
9207
- }
9208
- },
9209
- "403": {
9210
- "description": "Forbidden",
9211
- "content": {
9212
- "application/vnd.api+json": {
9213
- "schema": {
9214
- "$ref": "#/components/schemas/Errors"
9215
- }
9216
- }
9217
- }
9218
- }
9219
- }
9220
- }
9221
9108
  }
9222
9109
  },
9223
9110
  "components": {
@@ -9649,79 +9536,6 @@
9649
9536
  }
9650
9537
  }
9651
9538
  },
9652
- "AuthApplicationAttributes": {
9653
- "type": "object",
9654
- "properties": {
9655
- "name": {
9656
- "type": "string"
9657
- },
9658
- "uid": {
9659
- "type": "string"
9660
- }
9661
- }
9662
- },
9663
- "AuthApplicationData": {
9664
- "type": "object",
9665
- "additionalProperties": false,
9666
- "required": [
9667
- "type",
9668
- "id",
9669
- "attributes"
9670
- ],
9671
- "properties": {
9672
- "type": {
9673
- "type": "string",
9674
- "enum": [
9675
- "auth_application"
9676
- ]
9677
- },
9678
- "id": {
9679
- "type": "string"
9680
- },
9681
- "attributes": {
9682
- "$ref": "#/components/schemas/AuthApplicationAttributes"
9683
- }
9684
- }
9685
- },
9686
- "AuthApplication": {
9687
- "type": "object",
9688
- "additionalProperties": false,
9689
- "required": [
9690
- "data",
9691
- "links"
9692
- ],
9693
- "properties": {
9694
- "data": {
9695
- "$ref": "#/components/schemas/AuthApplicationData"
9696
- },
9697
- "links": {
9698
- "$ref": "#/components/schemas/Links"
9699
- }
9700
- }
9701
- },
9702
- "AuthApplications": {
9703
- "type": "object",
9704
- "additionalProperties": false,
9705
- "required": [
9706
- "data",
9707
- "meta",
9708
- "links"
9709
- ],
9710
- "properties": {
9711
- "data": {
9712
- "type": "array",
9713
- "items": {
9714
- "$ref": "#/components/schemas/AuthApplicationData"
9715
- }
9716
- },
9717
- "meta": {
9718
- "$ref": "#/components/schemas/Meta"
9719
- },
9720
- "links": {
9721
- "$ref": "#/components/schemas/Links"
9722
- }
9723
- }
9724
- },
9725
9539
  "CaseCreateAttributes": {
9726
9540
  "type": "object",
9727
9541
  "required": [
@@ -10857,15 +10671,6 @@
10857
10671
  "format": "uuid",
10858
10672
  "writeOnly": true
10859
10673
  },
10860
- "role_ids": {
10861
- "type": "array",
10862
- "description": "The roles that are allowed to access this field setting.\nIf not provided, the field setting will be accessible to all roles.\n",
10863
- "items": {
10864
- "type": "string",
10865
- "format": "uuid"
10866
- },
10867
- "writeOnly": true
10868
- },
10869
10674
  "required": {
10870
10675
  "type": "boolean"
10871
10676
  },
@@ -11069,9 +10874,6 @@
11069
10874
  "template_id": {
11070
10875
  "$ref": "#/components/schemas/FieldSettingAttributes/properties/template_id"
11071
10876
  },
11072
- "role_ids": {
11073
- "$ref": "#/components/schemas/FieldSettingAttributes/properties/role_ids"
11074
- },
11075
10877
  "required": {
11076
10878
  "$ref": "#/components/schemas/FieldSettingAttributes/properties/required"
11077
10879
  },
@@ -11113,9 +10915,6 @@
11113
10915
  "field": {
11114
10916
  "$ref": "#/components/schemas/FieldRelationship"
11115
10917
  },
11116
- "roles": {
11117
- "$ref": "#/components/schemas/RolesRelationship"
11118
- },
11119
10918
  "template": {
11120
10919
  "$ref": "#/components/schemas/TemplateRelationship"
11121
10920
  },
@@ -11170,9 +10969,6 @@
11170
10969
  {
11171
10970
  "$ref": "#/components/schemas/NoteInclusion"
11172
10971
  },
11173
- {
11174
- "$ref": "#/components/schemas/RoleInclusion"
11175
- },
11176
10972
  {
11177
10973
  "$ref": "#/components/schemas/TagInclusion"
11178
10974
  },
@@ -12638,14 +12434,11 @@
12638
12434
  "type": "object",
12639
12435
  "additionalProperties": false,
12640
12436
  "properties": {
12641
- "field_settings": {
12642
- "$ref": "#/components/schemas/FieldSettingsRelationship"
12437
+ "users": {
12438
+ "$ref": "#/components/schemas/UsersRelationship"
12643
12439
  },
12644
12440
  "teams": {
12645
12441
  "$ref": "#/components/schemas/TeamsRelationship"
12646
- },
12647
- "users": {
12648
- "$ref": "#/components/schemas/UsersRelationship"
12649
12442
  }
12650
12443
  }
12651
12444
  },
@@ -13036,12 +12829,10 @@
13036
12829
  "config": {
13037
12830
  "anyOf": [
13038
12831
  {
13039
- "$ref": "#/components/schemas/SamlConfig",
13040
- "name": "SAML Config"
12832
+ "$ref": "#/components/schemas/SamlConfig"
13041
12833
  },
13042
12834
  {
13043
- "$ref": "#/components/schemas/OidcConfig",
13044
- "name": "OIDC Config"
12835
+ "$ref": "#/components/schemas/OidcConfig"
13045
12836
  }
13046
12837
  ]
13047
12838
  },
@@ -14699,17 +14490,12 @@
14699
14490
  "send_invitation": {
14700
14491
  "type": "boolean",
14701
14492
  "default": false,
14702
- "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"
14703
- },
14704
- "invitation_destination_url": {
14705
- "type": "string",
14706
- "format": "uri",
14707
- "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"
14493
+ "description": "Can be set to true to send an invitation email to the user upon creation\n"
14708
14494
  },
14709
14495
  "set_password_destination_url": {
14710
14496
  "type": "string",
14711
14497
  "format": "uri",
14712
- "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",
14498
+ "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",
14713
14499
  "example": "https://localhost:3000/set-password"
14714
14500
  },
14715
14501
  "active": {
@@ -15496,8 +15282,7 @@
15496
15282
  "password_regex_message",
15497
15283
  "role_resources",
15498
15284
  "skip_rack_attack",
15499
- "task_delete_reasons",
15500
- "task_duration"
15285
+ "task_delete_reasons"
15501
15286
  ]
15502
15287
  },
15503
15288
  "AccessToken": {