@flipdish/authorization 0.0.3 → 0.0.6-rc.1764848040

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/api.ts CHANGED
@@ -146,17 +146,17 @@ export interface AssignRoleSuccessResponse {
146
146
  'message': string;
147
147
  }
148
148
  /**
149
- *
149
+ * Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on an AND of the result for each permission). For a granular response to multiple permissions, call the /authorize/batch endpoint.
150
150
  * @export
151
151
  * @interface AuthenticateAndAuthorizeRequest
152
152
  */
153
153
  export interface AuthenticateAndAuthorizeRequest {
154
154
  /**
155
155
  * Incoming request headers to be used for authentication
156
- * @type {{ [key: string]: any; }}
156
+ * @type {{ [key: string]: string; }}
157
157
  * @memberof AuthenticateAndAuthorizeRequest
158
158
  */
159
- 'headers': { [key: string]: any; };
159
+ 'headers': { [key: string]: string; };
160
160
  /**
161
161
  *
162
162
  * @type {AuthorizationRequestAction}
@@ -178,10 +178,10 @@ export interface AuthenticateAndAuthorizeRequest {
178
178
  export interface AuthenticateAndAuthorizeResponse {
179
179
  /**
180
180
  *
181
- * @type {AuthenticateAndAuthorizeResponseAuthentication}
181
+ * @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
182
182
  * @memberof AuthenticateAndAuthorizeResponse
183
183
  */
184
- 'authentication': AuthenticateAndAuthorizeResponseAuthentication;
184
+ 'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
185
185
  /**
186
186
  *
187
187
  * @type {AuthorizationResponse}
@@ -192,30 +192,170 @@ export interface AuthenticateAndAuthorizeResponse {
192
192
  /**
193
193
  *
194
194
  * @export
195
- * @interface AuthenticateAndAuthorizeResponseAuthentication
195
+ * @interface AuthenticateAndCheckIsInRoleRequest
196
+ */
197
+ export interface AuthenticateAndCheckIsInRoleRequest {
198
+ /**
199
+ * Incoming request headers to be used for authentication
200
+ * @type {{ [key: string]: string; }}
201
+ * @memberof AuthenticateAndCheckIsInRoleRequest
202
+ */
203
+ 'headers': { [key: string]: string; };
204
+ /**
205
+ * Array of roles to check if the principal is in
206
+ * @type {Array<string>}
207
+ * @memberof AuthenticateAndCheckIsInRoleRequest
208
+ */
209
+ 'roles': Array<AuthenticateAndCheckIsInRoleRequestRolesEnum>;
210
+ /**
211
+ * How to check if the principal is in any/all of the roles
212
+ * @type {string}
213
+ * @memberof AuthenticateAndCheckIsInRoleRequest
214
+ */
215
+ 'checkMode'?: AuthenticateAndCheckIsInRoleRequestCheckModeEnum;
216
+ }
217
+
218
+ export const AuthenticateAndCheckIsInRoleRequestRolesEnum = {
219
+ Admin: 'Admin',
220
+ Factory: 'Factory'
221
+ } as const;
222
+
223
+ export type AuthenticateAndCheckIsInRoleRequestRolesEnum = typeof AuthenticateAndCheckIsInRoleRequestRolesEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestRolesEnum];
224
+ export const AuthenticateAndCheckIsInRoleRequestCheckModeEnum = {
225
+ Any: 'any',
226
+ All: 'all'
227
+ } as const;
228
+
229
+ export type AuthenticateAndCheckIsInRoleRequestCheckModeEnum = typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum];
230
+
231
+ /**
232
+ * Response containing whether the principal is in any/all of the roles
233
+ * @export
234
+ * @interface AuthenticateAndCheckIsInRoleResponse
235
+ */
236
+ export interface AuthenticateAndCheckIsInRoleResponse {
237
+ /**
238
+ *
239
+ * @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
240
+ * @memberof AuthenticateAndCheckIsInRoleResponse
241
+ */
242
+ 'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
243
+ /**
244
+ * result of the check - whether the principal is in any/all of the roles
245
+ * @type {boolean}
246
+ * @memberof AuthenticateAndCheckIsInRoleResponse
247
+ */
248
+ 'authorized': boolean;
249
+ }
250
+ /**
251
+ *
252
+ * @export
253
+ * @interface AuthenticateAndCheckIsInRoleResponseAuthentication
196
254
  */
197
- export interface AuthenticateAndAuthorizeResponseAuthentication {
255
+ export interface AuthenticateAndCheckIsInRoleResponseAuthentication {
198
256
  /**
199
257
  *
200
258
  * @type {AuthorizationRequestPrincipal}
201
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
259
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
202
260
  */
203
261
  'principal': AuthorizationRequestPrincipal;
204
262
  /**
205
263
  * Whether the user is authenticated
206
264
  * @type {boolean}
207
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
265
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
208
266
  */
209
267
  'authenticated': boolean;
210
268
  /**
211
269
  * The reason for the authentication failure
212
270
  * @type {string}
213
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
271
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
214
272
  */
215
273
  'reason'?: string;
216
274
  }
217
275
  /**
218
- * Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on an AND of the result for each permission). For a granular response to multiple permissions, call the /authorize/batch endpoint.
276
+ *
277
+ * @export
278
+ * @interface AuthorizationBatchRequest
279
+ */
280
+ export interface AuthorizationBatchRequest {
281
+ /**
282
+ *
283
+ * @type {AuthorizationRequestPrincipal}
284
+ * @memberof AuthorizationBatchRequest
285
+ */
286
+ 'principal': AuthorizationRequestPrincipal;
287
+ /**
288
+ *
289
+ * @type {Permissions}
290
+ * @memberof AuthorizationBatchRequest
291
+ */
292
+ 'action': Permissions;
293
+ /**
294
+ * Array of resources to check authorisation for
295
+ * @type {Array<AuthorizationRequestResource>}
296
+ * @memberof AuthorizationBatchRequest
297
+ */
298
+ 'resources': Array<AuthorizationRequestResource>;
299
+ }
300
+ /**
301
+ *
302
+ * @export
303
+ * @interface AuthorizationBatchResponse
304
+ */
305
+ export interface AuthorizationBatchResponse {
306
+ /**
307
+ * Array of allowed resources
308
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
309
+ * @memberof AuthorizationBatchResponse
310
+ */
311
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
312
+ /**
313
+ * Array of denied resources
314
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
315
+ * @memberof AuthorizationBatchResponse
316
+ */
317
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
318
+ }
319
+ /**
320
+ *
321
+ * @export
322
+ * @interface AuthorizationBatchResponseAllowedResourcesInner
323
+ */
324
+ export interface AuthorizationBatchResponseAllowedResourcesInner {
325
+ /**
326
+ * The authorization decision
327
+ * @type {string}
328
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
329
+ */
330
+ 'decision': string;
331
+ /**
332
+ * Whether the action is allowed
333
+ * @type {boolean}
334
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
335
+ */
336
+ 'allowed': boolean;
337
+ /**
338
+ * The policy IDs that were used to make the decision
339
+ * @type {Array<string>}
340
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
341
+ */
342
+ 'policyIds': Array<string>;
343
+ /**
344
+ *
345
+ * @type {AuthorizationBatchResponseAllowedResourcesInnerResource}
346
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
347
+ */
348
+ 'resource': AuthorizationBatchResponseAllowedResourcesInnerResource;
349
+ }
350
+ /**
351
+ * @type AuthorizationBatchResponseAllowedResourcesInnerResource
352
+ *
353
+ * @export
354
+ */
355
+ export type AuthorizationBatchResponseAllowedResourcesInnerResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
356
+
357
+ /**
358
+ * Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on an AND of the result for each permission).
219
359
  * @export
220
360
  * @interface AuthorizationRequest
221
361
  */
@@ -440,203 +580,51 @@ export interface ErrorResponse {
440
580
  'message': string;
441
581
  }
442
582
  /**
443
- * Successful permissions retrieval response
444
- * @export
445
- * @interface GetPermissionsSuccessResponse
446
- */
447
- export interface GetPermissionsSuccessResponse {
448
- /**
449
- *
450
- * @type {Permissions & Array<string>}
451
- * @memberof GetPermissionsSuccessResponse
452
- */
453
- 'permissions': Permissions & Array<string>;
454
- }
455
- /**
456
- * Details for getting roles for a principal
457
- * @export
458
- * @interface GetPrincipalRolesRequestBody
459
- */
460
- export interface GetPrincipalRolesRequestBody {
461
- /**
462
- *
463
- * @type {AuthorizationRequestPrincipal}
464
- * @memberof GetPrincipalRolesRequestBody
465
- */
466
- 'principal': AuthorizationRequestPrincipal;
467
- /**
468
- *
469
- * @type {AuthorizationRequestResource}
470
- * @memberof GetPrincipalRolesRequestBody
471
- */
472
- 'resource'?: AuthorizationRequestResource;
473
- }
474
- /**
475
- * Successful roles retrieval response
476
- * @export
477
- * @interface GetPrincipalRolesSuccessResponse
478
- */
479
- export interface GetPrincipalRolesSuccessResponse {
480
- /**
481
- * List of roles assigned to the principal
482
- * @type {Array<GetPrincipalRolesSuccessResponseRolesInner>}
483
- * @memberof GetPrincipalRolesSuccessResponse
484
- */
485
- 'roles': Array<GetPrincipalRolesSuccessResponseRolesInner>;
486
- }
487
- /**
488
- *
583
+ * Feature based role and its permissions
489
584
  * @export
490
- * @interface GetPrincipalRolesSuccessResponseRolesInner
585
+ * @interface FeatureBasedRole
491
586
  */
492
- export interface GetPrincipalRolesSuccessResponseRolesInner {
587
+ export interface FeatureBasedRole {
493
588
  /**
494
- * Policy ID
589
+ * Name of the role
495
590
  * @type {string}
496
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
591
+ * @memberof FeatureBasedRole
497
592
  */
498
- 'policyId': string;
593
+ 'name': string;
499
594
  /**
500
595
  *
501
- * @type {GetPrincipalRolesSuccessResponseRolesInnerRoleName}
502
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
503
- */
504
- 'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleName;
505
- /**
506
- * Policy type
507
- * @type {string}
508
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
509
- */
510
- 'policyType': GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum;
511
- /**
512
- * Date and time the role was assigned
513
- * @type {string}
514
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
515
- */
516
- 'assignedAt': string;
517
- /**
518
- * User who assigned the role
519
- * @type {string}
520
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
521
- */
522
- 'assignedBy': string;
523
- /**
524
- * Type of resource the role is assigned to
525
- * @type {string}
526
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
527
- */
528
- 'resourceType': GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
529
- /**
530
- * Organization ID
531
- * @type {string}
532
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
533
- */
534
- 'orgId'?: string;
535
- /**
536
- * Property ID
537
- * @type {string}
538
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
539
- */
540
- 'propertyId'?: string;
541
- /**
542
- * Brand ID this role is scoped to
543
- * @type {string}
544
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
545
- */
546
- 'brandId'?: string;
547
- /**
548
- * Sales channel ID this role is scoped to
549
- * @type {string}
550
- * @memberof GetPrincipalRolesSuccessResponseRolesInner
596
+ * @type {Permissions & Array<string>}
597
+ * @memberof FeatureBasedRole
551
598
  */
552
- 'salesChannelId'?: string;
553
- }
554
-
555
- export const GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = {
556
- Main: 'Main',
557
- BrandOverride: 'BrandOverride',
558
- OrgOverride: 'OrgOverride',
559
- Forbidden: 'Forbidden'
560
- } as const;
561
-
562
- export type GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum];
563
- export const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = {
564
- Property: 'Property',
565
- Org: 'Org',
566
- Brand: 'Brand',
567
- SalesChannel: 'SalesChannel'
568
- } as const;
569
-
570
- export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum];
571
-
572
- /**
573
- * Role name
574
- * @export
575
- * @interface GetPrincipalRolesSuccessResponseRolesInnerRoleName
576
- */
577
- export interface GetPrincipalRolesSuccessResponseRolesInnerRoleName {
599
+ 'permissions': Permissions & Array<string>;
578
600
  }
579
601
  /**
580
- * Successful roles retrieval response
602
+ * Request to get authorized brands for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
581
603
  * @export
582
- * @interface GetRolesSuccessResponse
604
+ * @interface GetAuthorizedBrandsRequest
583
605
  */
584
- export interface GetRolesSuccessResponse {
606
+ export interface GetAuthorizedBrandsRequest {
585
607
  /**
586
- * List of roles available and their permissions
587
- * @type {Array<RolesInner>}
588
- * @memberof GetRolesSuccessResponse
608
+ *
609
+ * @type {GetAuthorizedOrgsRequestPrincipal}
610
+ * @memberof GetAuthorizedBrandsRequest
589
611
  */
590
- 'roles': Array<RolesInner>;
591
- }
592
- /**
593
- * Successful user permissions retrieval response
594
- * @export
595
- * @interface GetUserPermissionsSuccessResponse
596
- */
597
- export interface GetUserPermissionsSuccessResponse {
612
+ 'principal'?: GetAuthorizedOrgsRequestPrincipal;
598
613
  /**
599
- * Map of resource IDs to permissions
600
- * @type {{ [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }}
601
- * @memberof GetUserPermissionsSuccessResponse
614
+ * Incoming request headers to be used for authentication
615
+ * @type {{ [key: string]: string; }}
616
+ * @memberof GetAuthorizedBrandsRequest
602
617
  */
603
- 'resources': { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; };
604
- }
605
- /**
606
- *
607
- * @export
608
- * @interface GetUserPermissionsSuccessResponseResourcesValue
609
- */
610
- export interface GetUserPermissionsSuccessResponseResourcesValue {
618
+ 'headers'?: { [key: string]: string; };
611
619
  /**
612
- * Type of resource the permissions are assigned to
620
+ * The action to check authorisation for
613
621
  * @type {string}
614
- * @memberof GetUserPermissionsSuccessResponseResourcesValue
615
- */
616
- 'resourceType': GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum;
617
- /**
618
- *
619
- * @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
620
- * @memberof GetUserPermissionsSuccessResponseResourcesValue
622
+ * @memberof GetAuthorizedBrandsRequest
621
623
  */
622
- 'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
623
- /**
624
- * List of permissions that are assigned to the user for the resource
625
- * @type {Array<string>}
626
- * @memberof GetUserPermissionsSuccessResponseResourcesValue
627
- */
628
- 'permissions': Array<GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum>;
624
+ 'action': GetAuthorizedBrandsRequestActionEnum;
629
625
  }
630
626
 
631
- export const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = {
632
- Property: 'Property',
633
- Org: 'Org',
634
- Brand: 'Brand',
635
- SalesChannel: 'SalesChannel'
636
- } as const;
637
-
638
- export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum];
639
- export const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = {
627
+ export const GetAuthorizedBrandsRequestActionEnum = {
640
628
  AnyAuditLogs: 'AnyAuditLogs',
641
629
  ViewApp: 'ViewApp',
642
630
  CreateApp: 'CreateApp',
@@ -860,57 +848,61 @@ export const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = {
860
848
  EditEntityFeatureFlags: 'EditEntityFeatureFlags',
861
849
  CreateOrg: 'CreateOrg',
862
850
  EditOrg: 'EditOrg',
863
- ViewOrg: 'ViewOrg'
851
+ ViewOrg: 'ViewOrg',
852
+ ViewWebhooks: 'ViewWebhooks',
853
+ EditWebhooks: 'EditWebhooks',
854
+ RoleAdmin: 'RoleAdmin',
855
+ RoleFactory: 'RoleFactory'
864
856
  } as const;
865
857
 
866
- export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum];
858
+ export type GetAuthorizedBrandsRequestActionEnum = typeof GetAuthorizedBrandsRequestActionEnum[keyof typeof GetAuthorizedBrandsRequestActionEnum];
867
859
 
868
860
  /**
869
- * ID of the resource the permissions are assigned to
870
- * @export
871
- * @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
872
- */
873
- export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
874
- }
875
- /**
876
- *
861
+ * Response containing the authorized brands
877
862
  * @export
878
- * @interface OrgPathParam
863
+ * @interface GetAuthorizedBrandsResponse
879
864
  */
880
- export interface OrgPathParam {
865
+ export interface GetAuthorizedBrandsResponse {
881
866
  /**
882
- *
883
- * @type {string}
884
- * @memberof OrgPathParam
867
+ * Array of allowed resources
868
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
869
+ * @memberof GetAuthorizedBrandsResponse
870
+ */
871
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
872
+ /**
873
+ * Array of denied resources
874
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
875
+ * @memberof GetAuthorizedBrandsResponse
885
876
  */
886
- 'orgId': string;
877
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
887
878
  }
888
879
  /**
889
- *
880
+ * Request to get authorized orgs for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
890
881
  * @export
891
- * @interface PathParams
882
+ * @interface GetAuthorizedOrgsRequest
892
883
  */
893
- export interface PathParams {
884
+ export interface GetAuthorizedOrgsRequest {
894
885
  /**
895
886
  *
896
- * @type {string}
897
- * @memberof PathParams
887
+ * @type {GetAuthorizedOrgsRequestPrincipal}
888
+ * @memberof GetAuthorizedOrgsRequest
898
889
  */
899
- 'orgId': string;
890
+ 'principal'?: GetAuthorizedOrgsRequestPrincipal;
900
891
  /**
901
- *
892
+ * Incoming request headers to be used for authentication
893
+ * @type {{ [key: string]: string; }}
894
+ * @memberof GetAuthorizedOrgsRequest
895
+ */
896
+ 'headers'?: { [key: string]: string; };
897
+ /**
898
+ * The action to check authorisation for
902
899
  * @type {string}
903
- * @memberof PathParams
900
+ * @memberof GetAuthorizedOrgsRequest
904
901
  */
905
- 'userId': string;
902
+ 'action': GetAuthorizedOrgsRequestActionEnum;
906
903
  }
907
- /**
908
- *
909
- * @export
910
- * @enum {string}
911
- */
912
904
 
913
- export const Permissions = {
905
+ export const GetAuthorizedOrgsRequestActionEnum = {
914
906
  AnyAuditLogs: 'AnyAuditLogs',
915
907
  ViewApp: 'ViewApp',
916
908
  CreateApp: 'CreateApp',
@@ -1134,288 +1126,1807 @@ export const Permissions = {
1134
1126
  EditEntityFeatureFlags: 'EditEntityFeatureFlags',
1135
1127
  CreateOrg: 'CreateOrg',
1136
1128
  EditOrg: 'EditOrg',
1137
- ViewOrg: 'ViewOrg'
1129
+ ViewOrg: 'ViewOrg',
1130
+ ViewWebhooks: 'ViewWebhooks',
1131
+ EditWebhooks: 'EditWebhooks',
1132
+ RoleAdmin: 'RoleAdmin',
1133
+ RoleFactory: 'RoleFactory'
1138
1134
  } as const;
1139
1135
 
1140
- export type Permissions = typeof Permissions[keyof typeof Permissions];
1141
-
1136
+ export type GetAuthorizedOrgsRequestActionEnum = typeof GetAuthorizedOrgsRequestActionEnum[keyof typeof GetAuthorizedOrgsRequestActionEnum];
1142
1137
 
1143
1138
  /**
1144
- * Details for revoking a forbidden role from a principal
1139
+ * The principal to get authorized entities for
1145
1140
  * @export
1146
- * @interface RevokeForbiddenRoleRequestBody
1141
+ * @interface GetAuthorizedOrgsRequestPrincipal
1147
1142
  */
1148
- export interface RevokeForbiddenRoleRequestBody {
1143
+ export interface GetAuthorizedOrgsRequestPrincipal {
1149
1144
  /**
1150
1145
  *
1151
- * @type {AuthorizationRequestPrincipal}
1152
- * @memberof RevokeForbiddenRoleRequestBody
1153
- */
1154
- 'principal': AuthorizationRequestPrincipal;
1155
- /**
1156
- * Compensation role to revoke the forbidden role from
1157
1146
  * @type {string}
1158
- * @memberof RevokeForbiddenRoleRequestBody
1147
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1159
1148
  */
1160
- 'compensatingRole': RevokeForbiddenRoleRequestBodyCompensatingRoleEnum;
1161
- }
1162
-
1163
- export const RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = {
1164
- OwnerCompensating: 'OwnerCompensating',
1165
- PropertyOwnerCompensating: 'PropertyOwnerCompensating',
1166
- ManagedOwnerCompensating: 'ManagedOwnerCompensating',
1167
- IntegratorCompensating: 'IntegratorCompensating',
1168
- PropertyManagerCompensating: 'PropertyManagerCompensating',
1169
- FinanceManagerCompensating: 'FinanceManagerCompensating'
1170
- } as const;
1171
-
1172
- export type RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum[keyof typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum];
1173
-
1174
- /**
1175
- * Details for revoking a role from a principal
1176
- * @export
1177
- * @interface RevokeRoleRequestBody
1178
- */
1179
- export interface RevokeRoleRequestBody {
1149
+ 'type': GetAuthorizedOrgsRequestPrincipalTypeEnum;
1180
1150
  /**
1181
1151
  *
1182
1152
  * @type {string}
1183
- * @memberof RevokeRoleRequestBody
1153
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1184
1154
  */
1185
- 'role': RevokeRoleRequestBodyRoleEnum;
1155
+ 'id': string;
1186
1156
  /**
1187
1157
  *
1188
- * @type {AuthorizationRequestResource}
1189
- * @memberof RevokeRoleRequestBody
1158
+ * @type {string}
1159
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1190
1160
  */
1191
- 'resource': AuthorizationRequestResource;
1161
+ 'name'?: string;
1192
1162
  /**
1193
1163
  *
1194
- * @type {AuthorizationRequestPrincipal}
1195
- * @memberof RevokeRoleRequestBody
1164
+ * @type {string}
1165
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1196
1166
  */
1197
- 'principal': AuthorizationRequestPrincipal;
1167
+ 'email'?: string;
1198
1168
  /**
1199
1169
  *
1200
1170
  * @type {string}
1201
- * @memberof RevokeRoleRequestBody
1171
+ * @memberof GetAuthorizedOrgsRequestPrincipal
1202
1172
  */
1203
- 'brandId': string;
1173
+ 'phone'?: string;
1204
1174
  }
1205
1175
 
1206
- export const RevokeRoleRequestBodyRoleEnum = {
1207
- OrgViewer: 'OrgViewer',
1208
- OrgManager: 'OrgManager',
1209
- OrgAdmin: 'OrgAdmin',
1210
- BrandViewer: 'BrandViewer',
1211
- BrandManager: 'BrandManager',
1212
- BrandAdmin: 'BrandAdmin',
1213
- StoreViewer: 'StoreViewer',
1214
- StoreEditor: 'StoreEditor',
1215
- StoreManager: 'StoreManager',
1216
- CustomerViewer: 'CustomerViewer',
1217
- CustomerManager: 'CustomerManager',
1218
- VoucherViewer: 'VoucherViewer',
1219
- VoucherEditor: 'VoucherEditor',
1220
- VoucherManager: 'VoucherManager',
1221
- VoucherCampaignManager: 'VoucherCampaignManager',
1222
- VoucherStatisticsViewer: 'VoucherStatisticsViewer',
1223
- AnalyticsViewer: 'AnalyticsViewer',
1224
- ReportsViewer: 'ReportsViewer',
1225
- FinanceViewer: 'FinanceViewer',
1226
- FinanceManager: 'FinanceManager',
1227
- TeamViewer: 'TeamViewer',
1228
- TeamManager: 'TeamManager',
1229
- TeamAdmin: 'TeamAdmin',
1230
- TechViewer: 'TechViewer',
1231
- TechManager: 'TechManager',
1232
- AppStoreViewer: 'AppStoreViewer',
1233
- AppStoreManager: 'AppStoreManager',
1234
- SalesChannelViewer: 'SalesChannelViewer',
1235
- SalesChannelEditor: 'SalesChannelEditor',
1236
- SalesChannelManager: 'SalesChannelManager',
1237
- DeliveryViewer: 'DeliveryViewer',
1238
- DeliveryManager: 'DeliveryManager',
1239
- DriverManager: 'DriverManager',
1240
- AuditViewer: 'AuditViewer',
1241
- AuditManager: 'AuditManager',
1242
- AccountsViewer: 'AccountsViewer',
1243
- AccountsEditor: 'AccountsEditor',
1244
- DocumentExplorerViewer: 'DocumentExplorerViewer',
1245
- DocumentExplorerEditor: 'DocumentExplorerEditor',
1246
- PayrollViewer: 'PayrollViewer',
1247
- PayrollEditor: 'PayrollEditor',
1248
- PropertyViewer: 'PropertyViewer',
1249
- PropertyManager: 'PropertyManager',
1250
- PropertyAdmin: 'PropertyAdmin',
1251
- WebsiteContentEditor: 'WebsiteContentEditor',
1252
- WebsiteContentViewer: 'WebsiteContentViewer',
1253
- WebsiteTechViewer: 'WebsiteTechViewer',
1254
- MenuViewer: 'MenuViewer',
1255
- MenuEditor: 'MenuEditor',
1256
- MenuManager: 'MenuManager',
1257
- MenuMetaFieldManager: 'MenuMetaFieldManager',
1258
- MenuMetaFieldEditor: 'MenuMetaFieldEditor',
1259
- MenuMetaFieldViewer: 'MenuMetaFieldViewer',
1260
- StoreDeliveryZoneManager: 'StoreDeliveryZoneManager',
1261
- StoreDeliveryZoneEditor: 'StoreDeliveryZoneEditor',
1262
- StoreDeliveryZoneViewer: 'StoreDeliveryZoneViewer',
1263
- OrderFulfillmentManager: 'OrderFulfillmentManager',
1264
- OrderManager: 'OrderManager',
1265
- OrderEditor: 'OrderEditor',
1266
- OrderViewer: 'OrderViewer',
1267
- InventoryManager: 'InventoryManager',
1268
- InventoryEditor: 'InventoryEditor',
1269
- InventoryViewer: 'InventoryViewer',
1270
- PaymentManager: 'PaymentManager',
1271
- OnboardingManager: 'OnboardingManager',
1272
- FeatureFlagManager: 'FeatureFlagManager',
1273
- PropertyOwnerMisc: 'PropertyOwnerMisc',
1274
- ManagedOwnerMisc: 'ManagedOwnerMisc',
1275
- IntegratorMisc: 'IntegratorMisc',
1276
- PropertyManagerMisc: 'PropertyManagerMisc',
1277
- FinanceManagerMisc: 'FinanceManagerMisc',
1278
- SupportMisc: 'SupportMisc'
1176
+ export const GetAuthorizedOrgsRequestPrincipalTypeEnum = {
1177
+ User: 'User',
1178
+ Automation: 'Automation'
1279
1179
  } as const;
1280
1180
 
1281
- export type RevokeRoleRequestBodyRoleEnum = typeof RevokeRoleRequestBodyRoleEnum[keyof typeof RevokeRoleRequestBodyRoleEnum];
1181
+ export type GetAuthorizedOrgsRequestPrincipalTypeEnum = typeof GetAuthorizedOrgsRequestPrincipalTypeEnum[keyof typeof GetAuthorizedOrgsRequestPrincipalTypeEnum];
1282
1182
 
1283
1183
  /**
1284
- * Successful role revocation response
1285
- * @export
1286
- * @interface RevokeRoleSuccessResponse
1287
- */
1288
- export interface RevokeRoleSuccessResponse {
1289
- /**
1290
- * Confirmation message
1291
- * @type {string}
1292
- * @memberof RevokeRoleSuccessResponse
1293
- */
1294
- 'message': string;
1295
- }
1296
- /**
1297
- *
1184
+ * Response containing the authorized orgs
1298
1185
  * @export
1299
- * @interface RolesInner
1186
+ * @interface GetAuthorizedOrgsResponse
1300
1187
  */
1301
- export interface RolesInner {
1188
+ export interface GetAuthorizedOrgsResponse {
1302
1189
  /**
1303
- * Name of the role
1304
- * @type {string}
1305
- * @memberof RolesInner
1190
+ * Array of allowed resources
1191
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1192
+ * @memberof GetAuthorizedOrgsResponse
1306
1193
  */
1307
- 'name': string;
1194
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1308
1195
  /**
1309
- *
1310
- * @type {Permissions & Array<string>}
1311
- * @memberof RolesInner
1196
+ * Array of denied resources
1197
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1198
+ * @memberof GetAuthorizedOrgsResponse
1312
1199
  */
1313
- 'permissions': Permissions & Array<string>;
1200
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1314
1201
  }
1315
1202
  /**
1316
- *
1203
+ * Request to get authorized properties for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used.
1317
1204
  * @export
1318
- * @interface ValidationErrorsInner
1205
+ * @interface GetAuthorizedPropertiesRequest
1319
1206
  */
1320
- export interface ValidationErrorsInner {
1207
+ export interface GetAuthorizedPropertiesRequest {
1321
1208
  /**
1322
1209
  *
1323
- * @type {Array<ValidationErrorsInnerPathInner>}
1324
- * @memberof ValidationErrorsInner
1210
+ * @type {GetAuthorizedOrgsRequestPrincipal}
1211
+ * @memberof GetAuthorizedPropertiesRequest
1325
1212
  */
1326
- 'path'?: Array<ValidationErrorsInnerPathInner>;
1213
+ 'principal'?: GetAuthorizedOrgsRequestPrincipal;
1327
1214
  /**
1328
- *
1215
+ * Incoming request headers to be used for authentication
1216
+ * @type {{ [key: string]: string; }}
1217
+ * @memberof GetAuthorizedPropertiesRequest
1218
+ */
1219
+ 'headers'?: { [key: string]: string; };
1220
+ /**
1221
+ * The action to check authorisation for
1329
1222
  * @type {string}
1330
- * @memberof ValidationErrorsInner
1223
+ * @memberof GetAuthorizedPropertiesRequest
1331
1224
  */
1332
- 'message': string;
1333
- }
1334
- /**
1335
- *
1336
- * @export
1337
- * @interface ValidationErrorsInnerPathInner
1338
- */
1339
- export interface ValidationErrorsInnerPathInner {
1225
+ 'action': GetAuthorizedPropertiesRequestActionEnum;
1340
1226
  }
1341
1227
 
1342
- /**
1343
- * AuthenticationApi - axios parameter creator
1344
- * @export
1345
- */
1346
- export const AuthenticationApiAxiosParamCreator = function (configuration?: Configuration) {
1347
- return {
1348
- /**
1349
- * Authenticate and authorize a user to perform an action
1350
- * @summary Authenticate and authorize Request
1351
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1352
- * @param {*} [options] Override http request option.
1353
- * @throws {RequiredError}
1354
- */
1355
- authenticateAndAuthorize: async (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1356
- // verify required parameter 'authenticateAndAuthorizeRequest' is not null or undefined
1357
- assertParamExists('authenticateAndAuthorize', 'authenticateAndAuthorizeRequest', authenticateAndAuthorizeRequest)
1358
- const localVarPath = `/authenticateAndAuthorize`;
1359
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
1360
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1361
- let baseOptions;
1362
- if (configuration) {
1363
- baseOptions = configuration.baseOptions;
1364
- }
1365
-
1366
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1367
- const localVarHeaderParameter = {} as any;
1368
- const localVarQueryParameter = {} as any;
1369
-
1370
- // authentication ApiKeyAuth required
1371
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1372
-
1373
-
1374
-
1375
- localVarHeaderParameter['Content-Type'] = 'application/json';
1376
-
1377
- setSearchParams(localVarUrlObj, localVarQueryParameter);
1378
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1379
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1380
- localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndAuthorizeRequest, localVarRequestOptions, configuration)
1381
-
1382
- return {
1383
- url: toPathString(localVarUrlObj),
1384
- options: localVarRequestOptions,
1385
- };
1386
- },
1387
- }
1388
- };
1389
-
1390
- /**
1391
- * AuthenticationApi - functional programming interface
1392
- * @export
1393
- */
1394
- export const AuthenticationApiFp = function(configuration?: Configuration) {
1395
- const localVarAxiosParamCreator = AuthenticationApiAxiosParamCreator(configuration)
1396
- return {
1397
- /**
1398
- * Authenticate and authorize a user to perform an action
1399
- * @summary Authenticate and authorize Request
1400
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1401
- * @param {*} [options] Override http request option.
1402
- * @throws {RequiredError}
1403
- */
1404
- async authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>> {
1405
- const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options);
1406
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1407
- const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.authenticateAndAuthorize']?.[localVarOperationServerIndex]?.url;
1408
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1409
- },
1228
+ export const GetAuthorizedPropertiesRequestActionEnum = {
1229
+ AnyAuditLogs: 'AnyAuditLogs',
1230
+ ViewApp: 'ViewApp',
1231
+ CreateApp: 'CreateApp',
1232
+ UpdateApp: 'UpdateApp',
1233
+ ViewAppName: 'ViewAppName',
1234
+ EditAppAssets: 'EditAppAssets',
1235
+ EditAppFeatures: 'EditAppFeatures',
1236
+ ViewTeammates: 'ViewTeammates',
1237
+ EditTeammates: 'EditTeammates',
1238
+ CreateTeammateOwner: 'CreateTeammateOwner',
1239
+ CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
1240
+ CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
1241
+ CreateTeammateStoreManager: 'CreateTeammateStoreManager',
1242
+ CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
1243
+ CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
1244
+ CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
1245
+ CreateTeammateIntegrator: 'CreateTeammateIntegrator',
1246
+ CreateTeammateOnboarding: 'CreateTeammateOnboarding',
1247
+ CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
1248
+ CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
1249
+ ViewApmConfigurations: 'ViewApmConfigurations',
1250
+ EditApmConfigurations: 'EditApmConfigurations',
1251
+ ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
1252
+ CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
1253
+ UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
1254
+ DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
1255
+ StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
1256
+ ViewDevelopersSettings: 'ViewDevelopersSettings',
1257
+ EditDevelopersSettings: 'EditDevelopersSettings',
1258
+ ViewOrders: 'ViewOrders',
1259
+ UpdateOrdersAccept: 'UpdateOrdersAccept',
1260
+ UpdateOrdersReject: 'UpdateOrdersReject',
1261
+ UpdateOrdersRefund: 'UpdateOrdersRefund',
1262
+ UpdateOrdersDispatch: 'UpdateOrdersDispatch',
1263
+ ViewStores: 'ViewStores',
1264
+ CreateStores: 'CreateStores',
1265
+ EditStores: 'EditStores',
1266
+ ViewStoresOpeningHours: 'ViewStoresOpeningHours',
1267
+ UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
1268
+ UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
1269
+ ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
1270
+ EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
1271
+ EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
1272
+ UpdateStoresName: 'UpdateStoresName',
1273
+ EditStoreKioskSettings: 'EditStoreKioskSettings',
1274
+ EditStoreOrderCapacity: 'EditStoreOrderCapacity',
1275
+ EditStoreNotifications: 'EditStoreNotifications',
1276
+ ArchiveStores: 'ArchiveStores',
1277
+ PublishStores: 'PublishStores',
1278
+ UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
1279
+ UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
1280
+ ViewStoreGroups: 'ViewStoreGroups',
1281
+ CreateStoreGroups: 'CreateStoreGroups',
1282
+ UpdateStoreGroups: 'UpdateStoreGroups',
1283
+ DeleteStoreGroups: 'DeleteStoreGroups',
1284
+ ViewDeliveryZones: 'ViewDeliveryZones',
1285
+ CreateDeliveryZones: 'CreateDeliveryZones',
1286
+ UpdateDeliveryZones: 'UpdateDeliveryZones',
1287
+ DeleteDeliveryZones: 'DeleteDeliveryZones',
1288
+ ViewMenu: 'ViewMenu',
1289
+ CreateMenu: 'CreateMenu',
1290
+ UpdateMenu: 'UpdateMenu',
1291
+ DeleteMenu: 'DeleteMenu',
1292
+ UpdateMenuLock: 'UpdateMenuLock',
1293
+ UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
1294
+ EditMenuImage: 'EditMenuImage',
1295
+ ViewVouchers: 'ViewVouchers',
1296
+ EditVouchers: 'EditVouchers',
1297
+ ViewWebsiteContent: 'ViewWebsiteContent',
1298
+ EditWebsiteContent: 'EditWebsiteContent',
1299
+ ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
1300
+ ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
1301
+ ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
1302
+ ViewBankAccounts: 'ViewBankAccounts',
1303
+ CreateBankAccounts: 'CreateBankAccounts',
1304
+ UpdateBankAccounts: 'UpdateBankAccounts',
1305
+ UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
1306
+ ViewAssignedBankAccount: 'ViewAssignedBankAccount',
1307
+ VerifyBankAccounts: 'VerifyBankAccounts',
1308
+ ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
1309
+ EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
1310
+ EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
1311
+ EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
1312
+ ViewHydraConfig: 'ViewHydraConfig',
1313
+ UpdateHydraConfigManage: 'UpdateHydraConfigManage',
1314
+ InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
1315
+ DeleteTerminal: 'DeleteTerminal',
1316
+ ViewKioskTelemetry: 'ViewKioskTelemetry',
1317
+ ViewCustomers: 'ViewCustomers',
1318
+ EditCustomers: 'EditCustomers',
1319
+ CreateCustomers: 'CreateCustomers',
1320
+ CreateCatalogElements: 'CreateCatalogElements',
1321
+ UpdateCatalogElements: 'UpdateCatalogElements',
1322
+ ViewCatalogElements: 'ViewCatalogElements',
1323
+ DeleteCatalogElements: 'DeleteCatalogElements',
1324
+ ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
1325
+ CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
1326
+ UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
1327
+ DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
1328
+ UpdateMetafields: 'UpdateMetafields',
1329
+ ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
1330
+ PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
1331
+ ViewAppStatistics: 'ViewAppStatistics',
1332
+ ViewApmStatistics: 'ViewApmStatistics',
1333
+ ViewCampaignsStatistics: 'ViewCampaignsStatistics',
1334
+ ViewCustomerStatistics: 'ViewCustomerStatistics',
1335
+ ViewLiveStatistics: 'ViewLiveStatistics',
1336
+ ViewOrderStatistics: 'ViewOrderStatistics',
1337
+ ViewSalesStatistics: 'ViewSalesStatistics',
1338
+ ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
1339
+ ViewVouchersStatistics: 'ViewVouchersStatistics',
1340
+ DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
1341
+ ViewApmAuditLogs: 'ViewApmAuditLogs',
1342
+ ViewStoreAuditLogs: 'ViewStoreAuditLogs',
1343
+ ViewMenuAuditLogs: 'ViewMenuAuditLogs',
1344
+ ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
1345
+ ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
1346
+ ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
1347
+ ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
1348
+ ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
1349
+ ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
1350
+ ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
1351
+ ViewAppAuditLogs: 'ViewAppAuditLogs',
1352
+ ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
1353
+ ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
1354
+ ViewHydraAuditLogs: 'ViewHydraAuditLogs',
1355
+ ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
1356
+ ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
1357
+ ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
1358
+ ViewExternalAuditLogs: 'ViewExternalAuditLogs',
1359
+ CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
1360
+ ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
1361
+ ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
1362
+ ViewChannelAuditLogs: 'ViewChannelAuditLogs',
1363
+ ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
1364
+ SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
1365
+ InviteDriverToApp: 'InviteDriverToApp',
1366
+ GetDriverForApp: 'GetDriverForApp',
1367
+ RemoveDriverFromApp: 'RemoveDriverFromApp',
1368
+ AssignDriverToOrder: 'AssignDriverToOrder',
1369
+ UnassignDriverFromOrder: 'UnassignDriverFromOrder',
1370
+ UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
1371
+ UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
1372
+ ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
1373
+ CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
1374
+ UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
1375
+ DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
1376
+ ViewPayouts: 'ViewPayouts',
1377
+ ViewChannels: 'ViewChannels',
1378
+ ViewOnboarding: 'ViewOnboarding',
1379
+ UpdateOnboarding: 'UpdateOnboarding',
1380
+ ViewClientDevices: 'ViewClientDevices',
1381
+ UpdateClientDevices: 'UpdateClientDevices',
1382
+ EnrollClientDevices: 'EnrollClientDevices',
1383
+ AssignClientDevices: 'AssignClientDevices',
1384
+ ViewClientAuditLogs: 'ViewClientAuditLogs',
1385
+ CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
1386
+ ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
1387
+ UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
1388
+ DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
1389
+ UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
1390
+ CreateAppStoreSubscription: 'CreateAppStoreSubscription',
1391
+ UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
1392
+ DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
1393
+ ViewSalesChannels: 'ViewSalesChannels',
1394
+ EditSalesChannels: 'EditSalesChannels',
1395
+ CreateSalesChannel: 'CreateSalesChannel',
1396
+ ArchiveSalesChannel: 'ArchiveSalesChannel',
1397
+ UnarchiveSalesChannel: 'UnarchiveSalesChannel',
1398
+ PublishSalesChannel: 'PublishSalesChannel',
1399
+ UnpublishSalesChannel: 'UnpublishSalesChannel',
1400
+ CloneSalesChannel: 'CloneSalesChannel',
1401
+ ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
1402
+ CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
1403
+ UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
1404
+ UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
1405
+ ViewSubscriptions: 'ViewSubscriptions',
1406
+ ViewInvoices: 'ViewInvoices',
1407
+ EditAccountsBills: 'EditAccountsBills',
1408
+ ViewAccountsBills: 'ViewAccountsBills',
1409
+ EditAccountsCategories: 'EditAccountsCategories',
1410
+ ViewAccountsCategories: 'ViewAccountsCategories',
1411
+ EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
1412
+ ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
1413
+ EditAccountsCreditBooks: 'EditAccountsCreditBooks',
1414
+ ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
1415
+ EditAccountsExpenses: 'EditAccountsExpenses',
1416
+ ViewAccountsExpenses: 'ViewAccountsExpenses',
1417
+ EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
1418
+ ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
1419
+ EditDocumentExplorer: 'EditDocumentExplorer',
1420
+ ViewDocumentExplorer: 'ViewDocumentExplorer',
1421
+ ViewInventoryReports: 'ViewInventoryReports',
1422
+ EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
1423
+ ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
1424
+ EditInventoryStockItems: 'EditInventoryStockItems',
1425
+ ViewInventoryStockItems: 'ViewInventoryStockItems',
1426
+ EditInventorySupplier: 'EditInventorySupplier',
1427
+ ViewInventorySupplier: 'ViewInventorySupplier',
1428
+ EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
1429
+ ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
1430
+ ViewPayrollReports: 'ViewPayrollReports',
1431
+ EditPayrollHoliday: 'EditPayrollHoliday',
1432
+ ViewPayrollHoliday: 'ViewPayrollHoliday',
1433
+ EditPayrollRota: 'EditPayrollRota',
1434
+ ViewPayrollRota: 'ViewPayrollRota',
1435
+ EditPayrollStaff: 'EditPayrollStaff',
1436
+ ViewPayrollStaff: 'ViewPayrollStaff',
1437
+ ViewSalesReports: 'ViewSalesReports',
1438
+ ViewCostReports: 'ViewCostReports',
1439
+ ViewMenuReports: 'ViewMenuReports',
1440
+ ViewBrand: 'ViewBrand',
1441
+ EditBrand: 'EditBrand',
1442
+ CreateBrand: 'CreateBrand',
1443
+ TransferBrand: 'TransferBrand',
1444
+ ViewProperty: 'ViewProperty',
1445
+ EditProperty: 'EditProperty',
1446
+ CreateProperty: 'CreateProperty',
1447
+ ArchiveProperty: 'ArchiveProperty',
1448
+ ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
1449
+ EditEntityFeatureFlags: 'EditEntityFeatureFlags',
1450
+ CreateOrg: 'CreateOrg',
1451
+ EditOrg: 'EditOrg',
1452
+ ViewOrg: 'ViewOrg',
1453
+ ViewWebhooks: 'ViewWebhooks',
1454
+ EditWebhooks: 'EditWebhooks',
1455
+ RoleAdmin: 'RoleAdmin',
1456
+ RoleFactory: 'RoleFactory'
1457
+ } as const;
1458
+
1459
+ export type GetAuthorizedPropertiesRequestActionEnum = typeof GetAuthorizedPropertiesRequestActionEnum[keyof typeof GetAuthorizedPropertiesRequestActionEnum];
1460
+
1461
+ /**
1462
+ * Response containing the authorized properties
1463
+ * @export
1464
+ * @interface GetAuthorizedPropertiesResponse
1465
+ */
1466
+ export interface GetAuthorizedPropertiesResponse {
1467
+ /**
1468
+ * Array of allowed resources
1469
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1470
+ * @memberof GetAuthorizedPropertiesResponse
1471
+ */
1472
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1473
+ /**
1474
+ * Array of denied resources
1475
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
1476
+ * @memberof GetAuthorizedPropertiesResponse
1477
+ */
1478
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
1479
+ }
1480
+ /**
1481
+ * Details for getting roles for a principal
1482
+ * @export
1483
+ * @interface GetPrincipalRolesRequestBody
1484
+ */
1485
+ export interface GetPrincipalRolesRequestBody {
1486
+ /**
1487
+ *
1488
+ * @type {AuthorizationRequestPrincipal}
1489
+ * @memberof GetPrincipalRolesRequestBody
1490
+ */
1491
+ 'principal': AuthorizationRequestPrincipal;
1492
+ /**
1493
+ *
1494
+ * @type {AuthorizationRequestResource}
1495
+ * @memberof GetPrincipalRolesRequestBody
1496
+ */
1497
+ 'resource'?: AuthorizationRequestResource;
1498
+ }
1499
+ /**
1500
+ * Successful roles retrieval response
1501
+ * @export
1502
+ * @interface GetPrincipalRolesSuccessResponse
1503
+ */
1504
+ export interface GetPrincipalRolesSuccessResponse {
1505
+ /**
1506
+ * List of roles assigned to the principal
1507
+ * @type {Array<GetPrincipalRolesSuccessResponseRolesInner>}
1508
+ * @memberof GetPrincipalRolesSuccessResponse
1509
+ */
1510
+ 'roles': Array<GetPrincipalRolesSuccessResponseRolesInner>;
1511
+ }
1512
+ /**
1513
+ *
1514
+ * @export
1515
+ * @interface GetPrincipalRolesSuccessResponseRolesInner
1516
+ */
1517
+ export interface GetPrincipalRolesSuccessResponseRolesInner {
1518
+ /**
1519
+ * Policy ID
1520
+ * @type {string}
1521
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1522
+ */
1523
+ 'policyId': string;
1524
+ /**
1525
+ *
1526
+ * @type {GetPrincipalRolesSuccessResponseRolesInnerRoleName}
1527
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1528
+ */
1529
+ 'roleName': GetPrincipalRolesSuccessResponseRolesInnerRoleName;
1530
+ /**
1531
+ * Policy type
1532
+ * @type {string}
1533
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1534
+ */
1535
+ 'policyType': GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum;
1536
+ /**
1537
+ * Date and time the role was assigned
1538
+ * @type {string}
1539
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1540
+ */
1541
+ 'assignedAt': string;
1542
+ /**
1543
+ * User who assigned the role
1544
+ * @type {string}
1545
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1546
+ */
1547
+ 'assignedBy': string;
1548
+ /**
1549
+ * Type of resource the role is assigned to
1550
+ * @type {string}
1551
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1552
+ */
1553
+ 'resourceType'?: GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
1554
+ /**
1555
+ * Organization ID
1556
+ * @type {string}
1557
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1558
+ */
1559
+ 'orgId'?: string;
1560
+ /**
1561
+ * Property ID
1562
+ * @type {string}
1563
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1564
+ */
1565
+ 'propertyId'?: string;
1566
+ /**
1567
+ * Brand ID this role is scoped to
1568
+ * @type {string}
1569
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1570
+ */
1571
+ 'brandId'?: string;
1572
+ /**
1573
+ * Sales channel ID this role is scoped to
1574
+ * @type {string}
1575
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1576
+ */
1577
+ 'salesChannelId'?: string;
1578
+ /**
1579
+ * Principal ID this role is assigned to
1580
+ * @type {string}
1581
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1582
+ */
1583
+ 'principalId': string;
1584
+ /**
1585
+ * Type of principal this role is assigned to
1586
+ * @type {string}
1587
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
1588
+ */
1589
+ 'principalType': GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum;
1590
+ }
1591
+
1592
+ export const GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = {
1593
+ Main: 'Main',
1594
+ BrandOverride: 'BrandOverride',
1595
+ OrgOverride: 'OrgOverride',
1596
+ Forbidden: 'Forbidden',
1597
+ NamedRole: 'NamedRole'
1598
+ } as const;
1599
+
1600
+ export type GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum];
1601
+ export const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = {
1602
+ Property: 'Property',
1603
+ Org: 'Org',
1604
+ Brand: 'Brand',
1605
+ SalesChannel: 'SalesChannel'
1606
+ } as const;
1607
+
1608
+ export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum];
1609
+ export const GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum = {
1610
+ User: 'User',
1611
+ Automation: 'Automation'
1612
+ } as const;
1613
+
1614
+ export type GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum];
1615
+
1616
+ /**
1617
+ * Role name
1618
+ * @export
1619
+ * @interface GetPrincipalRolesSuccessResponseRolesInnerRoleName
1620
+ */
1621
+ export interface GetPrincipalRolesSuccessResponseRolesInnerRoleName {
1622
+ }
1623
+ /**
1624
+ * Successful user permissions retrieval response
1625
+ * @export
1626
+ * @interface GetUserPermissionsSuccessResponse
1627
+ */
1628
+ export interface GetUserPermissionsSuccessResponse {
1629
+ /**
1630
+ * Map of resource IDs to permissions
1631
+ * @type {{ [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }}
1632
+ * @memberof GetUserPermissionsSuccessResponse
1633
+ */
1634
+ 'resources': { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; };
1635
+ }
1636
+ /**
1637
+ *
1638
+ * @export
1639
+ * @interface GetUserPermissionsSuccessResponseResourcesValue
1640
+ */
1641
+ export interface GetUserPermissionsSuccessResponseResourcesValue {
1642
+ /**
1643
+ * Type of resource the permissions are assigned to
1644
+ * @type {string}
1645
+ * @memberof GetUserPermissionsSuccessResponseResourcesValue
1646
+ */
1647
+ 'resourceType': GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum;
1648
+ /**
1649
+ *
1650
+ * @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
1651
+ * @memberof GetUserPermissionsSuccessResponseResourcesValue
1652
+ */
1653
+ 'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
1654
+ /**
1655
+ * List of permissions that are assigned to the user for the resource
1656
+ * @type {Array<string>}
1657
+ * @memberof GetUserPermissionsSuccessResponseResourcesValue
1658
+ */
1659
+ 'permissions': Array<GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum>;
1660
+ }
1661
+
1662
+ export const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = {
1663
+ Property: 'Property',
1664
+ Org: 'Org',
1665
+ Brand: 'Brand',
1666
+ SalesChannel: 'SalesChannel'
1667
+ } as const;
1668
+
1669
+ export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum];
1670
+ export const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = {
1671
+ AnyAuditLogs: 'AnyAuditLogs',
1672
+ ViewApp: 'ViewApp',
1673
+ CreateApp: 'CreateApp',
1674
+ UpdateApp: 'UpdateApp',
1675
+ ViewAppName: 'ViewAppName',
1676
+ EditAppAssets: 'EditAppAssets',
1677
+ EditAppFeatures: 'EditAppFeatures',
1678
+ ViewTeammates: 'ViewTeammates',
1679
+ EditTeammates: 'EditTeammates',
1680
+ CreateTeammateOwner: 'CreateTeammateOwner',
1681
+ CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
1682
+ CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
1683
+ CreateTeammateStoreManager: 'CreateTeammateStoreManager',
1684
+ CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
1685
+ CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
1686
+ CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
1687
+ CreateTeammateIntegrator: 'CreateTeammateIntegrator',
1688
+ CreateTeammateOnboarding: 'CreateTeammateOnboarding',
1689
+ CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
1690
+ CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
1691
+ ViewApmConfigurations: 'ViewApmConfigurations',
1692
+ EditApmConfigurations: 'EditApmConfigurations',
1693
+ ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
1694
+ CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
1695
+ UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
1696
+ DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
1697
+ StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
1698
+ ViewDevelopersSettings: 'ViewDevelopersSettings',
1699
+ EditDevelopersSettings: 'EditDevelopersSettings',
1700
+ ViewOrders: 'ViewOrders',
1701
+ UpdateOrdersAccept: 'UpdateOrdersAccept',
1702
+ UpdateOrdersReject: 'UpdateOrdersReject',
1703
+ UpdateOrdersRefund: 'UpdateOrdersRefund',
1704
+ UpdateOrdersDispatch: 'UpdateOrdersDispatch',
1705
+ ViewStores: 'ViewStores',
1706
+ CreateStores: 'CreateStores',
1707
+ EditStores: 'EditStores',
1708
+ ViewStoresOpeningHours: 'ViewStoresOpeningHours',
1709
+ UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
1710
+ UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
1711
+ ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
1712
+ EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
1713
+ EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
1714
+ UpdateStoresName: 'UpdateStoresName',
1715
+ EditStoreKioskSettings: 'EditStoreKioskSettings',
1716
+ EditStoreOrderCapacity: 'EditStoreOrderCapacity',
1717
+ EditStoreNotifications: 'EditStoreNotifications',
1718
+ ArchiveStores: 'ArchiveStores',
1719
+ PublishStores: 'PublishStores',
1720
+ UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
1721
+ UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
1722
+ ViewStoreGroups: 'ViewStoreGroups',
1723
+ CreateStoreGroups: 'CreateStoreGroups',
1724
+ UpdateStoreGroups: 'UpdateStoreGroups',
1725
+ DeleteStoreGroups: 'DeleteStoreGroups',
1726
+ ViewDeliveryZones: 'ViewDeliveryZones',
1727
+ CreateDeliveryZones: 'CreateDeliveryZones',
1728
+ UpdateDeliveryZones: 'UpdateDeliveryZones',
1729
+ DeleteDeliveryZones: 'DeleteDeliveryZones',
1730
+ ViewMenu: 'ViewMenu',
1731
+ CreateMenu: 'CreateMenu',
1732
+ UpdateMenu: 'UpdateMenu',
1733
+ DeleteMenu: 'DeleteMenu',
1734
+ UpdateMenuLock: 'UpdateMenuLock',
1735
+ UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
1736
+ EditMenuImage: 'EditMenuImage',
1737
+ ViewVouchers: 'ViewVouchers',
1738
+ EditVouchers: 'EditVouchers',
1739
+ ViewWebsiteContent: 'ViewWebsiteContent',
1740
+ EditWebsiteContent: 'EditWebsiteContent',
1741
+ ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
1742
+ ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
1743
+ ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
1744
+ ViewBankAccounts: 'ViewBankAccounts',
1745
+ CreateBankAccounts: 'CreateBankAccounts',
1746
+ UpdateBankAccounts: 'UpdateBankAccounts',
1747
+ UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
1748
+ ViewAssignedBankAccount: 'ViewAssignedBankAccount',
1749
+ VerifyBankAccounts: 'VerifyBankAccounts',
1750
+ ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
1751
+ EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
1752
+ EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
1753
+ EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
1754
+ ViewHydraConfig: 'ViewHydraConfig',
1755
+ UpdateHydraConfigManage: 'UpdateHydraConfigManage',
1756
+ InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
1757
+ DeleteTerminal: 'DeleteTerminal',
1758
+ ViewKioskTelemetry: 'ViewKioskTelemetry',
1759
+ ViewCustomers: 'ViewCustomers',
1760
+ EditCustomers: 'EditCustomers',
1761
+ CreateCustomers: 'CreateCustomers',
1762
+ CreateCatalogElements: 'CreateCatalogElements',
1763
+ UpdateCatalogElements: 'UpdateCatalogElements',
1764
+ ViewCatalogElements: 'ViewCatalogElements',
1765
+ DeleteCatalogElements: 'DeleteCatalogElements',
1766
+ ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
1767
+ CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
1768
+ UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
1769
+ DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
1770
+ UpdateMetafields: 'UpdateMetafields',
1771
+ ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
1772
+ PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
1773
+ ViewAppStatistics: 'ViewAppStatistics',
1774
+ ViewApmStatistics: 'ViewApmStatistics',
1775
+ ViewCampaignsStatistics: 'ViewCampaignsStatistics',
1776
+ ViewCustomerStatistics: 'ViewCustomerStatistics',
1777
+ ViewLiveStatistics: 'ViewLiveStatistics',
1778
+ ViewOrderStatistics: 'ViewOrderStatistics',
1779
+ ViewSalesStatistics: 'ViewSalesStatistics',
1780
+ ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
1781
+ ViewVouchersStatistics: 'ViewVouchersStatistics',
1782
+ DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
1783
+ ViewApmAuditLogs: 'ViewApmAuditLogs',
1784
+ ViewStoreAuditLogs: 'ViewStoreAuditLogs',
1785
+ ViewMenuAuditLogs: 'ViewMenuAuditLogs',
1786
+ ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
1787
+ ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
1788
+ ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
1789
+ ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
1790
+ ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
1791
+ ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
1792
+ ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
1793
+ ViewAppAuditLogs: 'ViewAppAuditLogs',
1794
+ ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
1795
+ ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
1796
+ ViewHydraAuditLogs: 'ViewHydraAuditLogs',
1797
+ ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
1798
+ ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
1799
+ ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
1800
+ ViewExternalAuditLogs: 'ViewExternalAuditLogs',
1801
+ CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
1802
+ ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
1803
+ ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
1804
+ ViewChannelAuditLogs: 'ViewChannelAuditLogs',
1805
+ ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
1806
+ SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
1807
+ InviteDriverToApp: 'InviteDriverToApp',
1808
+ GetDriverForApp: 'GetDriverForApp',
1809
+ RemoveDriverFromApp: 'RemoveDriverFromApp',
1810
+ AssignDriverToOrder: 'AssignDriverToOrder',
1811
+ UnassignDriverFromOrder: 'UnassignDriverFromOrder',
1812
+ UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
1813
+ UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
1814
+ ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
1815
+ CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
1816
+ UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
1817
+ DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
1818
+ ViewPayouts: 'ViewPayouts',
1819
+ ViewChannels: 'ViewChannels',
1820
+ ViewOnboarding: 'ViewOnboarding',
1821
+ UpdateOnboarding: 'UpdateOnboarding',
1822
+ ViewClientDevices: 'ViewClientDevices',
1823
+ UpdateClientDevices: 'UpdateClientDevices',
1824
+ EnrollClientDevices: 'EnrollClientDevices',
1825
+ AssignClientDevices: 'AssignClientDevices',
1826
+ ViewClientAuditLogs: 'ViewClientAuditLogs',
1827
+ CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
1828
+ ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
1829
+ UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
1830
+ DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
1831
+ UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
1832
+ CreateAppStoreSubscription: 'CreateAppStoreSubscription',
1833
+ UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
1834
+ DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
1835
+ ViewSalesChannels: 'ViewSalesChannels',
1836
+ EditSalesChannels: 'EditSalesChannels',
1837
+ CreateSalesChannel: 'CreateSalesChannel',
1838
+ ArchiveSalesChannel: 'ArchiveSalesChannel',
1839
+ UnarchiveSalesChannel: 'UnarchiveSalesChannel',
1840
+ PublishSalesChannel: 'PublishSalesChannel',
1841
+ UnpublishSalesChannel: 'UnpublishSalesChannel',
1842
+ CloneSalesChannel: 'CloneSalesChannel',
1843
+ ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
1844
+ CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
1845
+ UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
1846
+ UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
1847
+ ViewSubscriptions: 'ViewSubscriptions',
1848
+ ViewInvoices: 'ViewInvoices',
1849
+ EditAccountsBills: 'EditAccountsBills',
1850
+ ViewAccountsBills: 'ViewAccountsBills',
1851
+ EditAccountsCategories: 'EditAccountsCategories',
1852
+ ViewAccountsCategories: 'ViewAccountsCategories',
1853
+ EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
1854
+ ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
1855
+ EditAccountsCreditBooks: 'EditAccountsCreditBooks',
1856
+ ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
1857
+ EditAccountsExpenses: 'EditAccountsExpenses',
1858
+ ViewAccountsExpenses: 'ViewAccountsExpenses',
1859
+ EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
1860
+ ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
1861
+ EditDocumentExplorer: 'EditDocumentExplorer',
1862
+ ViewDocumentExplorer: 'ViewDocumentExplorer',
1863
+ ViewInventoryReports: 'ViewInventoryReports',
1864
+ EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
1865
+ ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
1866
+ EditInventoryStockItems: 'EditInventoryStockItems',
1867
+ ViewInventoryStockItems: 'ViewInventoryStockItems',
1868
+ EditInventorySupplier: 'EditInventorySupplier',
1869
+ ViewInventorySupplier: 'ViewInventorySupplier',
1870
+ EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
1871
+ ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
1872
+ ViewPayrollReports: 'ViewPayrollReports',
1873
+ EditPayrollHoliday: 'EditPayrollHoliday',
1874
+ ViewPayrollHoliday: 'ViewPayrollHoliday',
1875
+ EditPayrollRota: 'EditPayrollRota',
1876
+ ViewPayrollRota: 'ViewPayrollRota',
1877
+ EditPayrollStaff: 'EditPayrollStaff',
1878
+ ViewPayrollStaff: 'ViewPayrollStaff',
1879
+ ViewSalesReports: 'ViewSalesReports',
1880
+ ViewCostReports: 'ViewCostReports',
1881
+ ViewMenuReports: 'ViewMenuReports',
1882
+ ViewBrand: 'ViewBrand',
1883
+ EditBrand: 'EditBrand',
1884
+ CreateBrand: 'CreateBrand',
1885
+ TransferBrand: 'TransferBrand',
1886
+ ViewProperty: 'ViewProperty',
1887
+ EditProperty: 'EditProperty',
1888
+ CreateProperty: 'CreateProperty',
1889
+ ArchiveProperty: 'ArchiveProperty',
1890
+ ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
1891
+ EditEntityFeatureFlags: 'EditEntityFeatureFlags',
1892
+ CreateOrg: 'CreateOrg',
1893
+ EditOrg: 'EditOrg',
1894
+ ViewOrg: 'ViewOrg',
1895
+ ViewWebhooks: 'ViewWebhooks',
1896
+ EditWebhooks: 'EditWebhooks',
1897
+ RoleAdmin: 'RoleAdmin',
1898
+ RoleFactory: 'RoleFactory'
1899
+ } as const;
1900
+
1901
+ export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum];
1902
+
1903
+ /**
1904
+ * ID of the resource the permissions are assigned to
1905
+ * @export
1906
+ * @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
1907
+ */
1908
+ export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
1909
+ }
1910
+ /**
1911
+ *
1912
+ * @export
1913
+ * @interface IsInRoleRequest
1914
+ */
1915
+ export interface IsInRoleRequest {
1916
+ /**
1917
+ *
1918
+ * @type {AuthorizationRequestPrincipal}
1919
+ * @memberof IsInRoleRequest
1920
+ */
1921
+ 'principal': AuthorizationRequestPrincipal;
1922
+ /**
1923
+ * Array of roles to check if the principal is in
1924
+ * @type {Array<string>}
1925
+ * @memberof IsInRoleRequest
1926
+ */
1927
+ 'roles': Array<IsInRoleRequestRolesEnum>;
1928
+ /**
1929
+ * How to check if the principal is in any/all of the roles
1930
+ * @type {string}
1931
+ * @memberof IsInRoleRequest
1932
+ */
1933
+ 'checkMode'?: IsInRoleRequestCheckModeEnum;
1934
+ }
1935
+
1936
+ export const IsInRoleRequestRolesEnum = {
1937
+ Admin: 'Admin',
1938
+ Factory: 'Factory'
1939
+ } as const;
1940
+
1941
+ export type IsInRoleRequestRolesEnum = typeof IsInRoleRequestRolesEnum[keyof typeof IsInRoleRequestRolesEnum];
1942
+ export const IsInRoleRequestCheckModeEnum = {
1943
+ Any: 'any',
1944
+ All: 'all'
1945
+ } as const;
1946
+
1947
+ export type IsInRoleRequestCheckModeEnum = typeof IsInRoleRequestCheckModeEnum[keyof typeof IsInRoleRequestCheckModeEnum];
1948
+
1949
+ /**
1950
+ * Response containing whether the principal is in any/all of the roles
1951
+ * @export
1952
+ * @interface IsInRoleResponse
1953
+ */
1954
+ export interface IsInRoleResponse {
1955
+ /**
1956
+ * result of the check - whether the principal is in any/all of the roles
1957
+ * @type {boolean}
1958
+ * @memberof IsInRoleResponse
1959
+ */
1960
+ 'authorized': boolean;
1961
+ }
1962
+ /**
1963
+ * Successful feature based roles retrieval response
1964
+ * @export
1965
+ * @interface ListFeatureBasedRolesSuccessResponse
1966
+ */
1967
+ export interface ListFeatureBasedRolesSuccessResponse {
1968
+ /**
1969
+ *
1970
+ * @type {Array<FeatureBasedRole>}
1971
+ * @memberof ListFeatureBasedRolesSuccessResponse
1972
+ */
1973
+ 'roles': Array<FeatureBasedRole>;
1974
+ }
1975
+ /**
1976
+ *
1977
+ * @export
1978
+ * @interface ListOrgRolesSuccessResponseValueValue
1979
+ */
1980
+ export interface ListOrgRolesSuccessResponseValueValue {
1981
+ /**
1982
+ * Type of resource the permissions are assigned to
1983
+ * @type {string}
1984
+ * @memberof ListOrgRolesSuccessResponseValueValue
1985
+ */
1986
+ 'resourceType': ListOrgRolesSuccessResponseValueValueResourceTypeEnum;
1987
+ /**
1988
+ *
1989
+ * @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
1990
+ * @memberof ListOrgRolesSuccessResponseValueValue
1991
+ */
1992
+ 'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
1993
+ /**
1994
+ * List of roles that are assigned to the user for the resource
1995
+ * @type {Array<string>}
1996
+ * @memberof ListOrgRolesSuccessResponseValueValue
1997
+ */
1998
+ 'roles': Array<ListOrgRolesSuccessResponseValueValueRolesEnum>;
1999
+ }
2000
+
2001
+ export const ListOrgRolesSuccessResponseValueValueResourceTypeEnum = {
2002
+ Property: 'Property',
2003
+ Org: 'Org',
2004
+ Brand: 'Brand',
2005
+ SalesChannel: 'SalesChannel'
2006
+ } as const;
2007
+
2008
+ export type ListOrgRolesSuccessResponseValueValueResourceTypeEnum = typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum[keyof typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum];
2009
+ export const ListOrgRolesSuccessResponseValueValueRolesEnum = {
2010
+ OrgViewer: 'OrgViewer',
2011
+ OrgManager: 'OrgManager',
2012
+ OrgAdmin: 'OrgAdmin',
2013
+ BrandViewer: 'BrandViewer',
2014
+ BrandManager: 'BrandManager',
2015
+ BrandAdmin: 'BrandAdmin',
2016
+ StoreViewer: 'StoreViewer',
2017
+ StoreEditor: 'StoreEditor',
2018
+ StoreManager: 'StoreManager',
2019
+ CustomerViewer: 'CustomerViewer',
2020
+ CustomerManager: 'CustomerManager',
2021
+ VoucherViewer: 'VoucherViewer',
2022
+ VoucherEditor: 'VoucherEditor',
2023
+ VoucherManager: 'VoucherManager',
2024
+ VoucherCampaignManager: 'VoucherCampaignManager',
2025
+ VoucherStatisticsViewer: 'VoucherStatisticsViewer',
2026
+ AnalyticsViewer: 'AnalyticsViewer',
2027
+ ReportsViewer: 'ReportsViewer',
2028
+ FinanceViewer: 'FinanceViewer',
2029
+ FinanceManager: 'FinanceManager',
2030
+ TeamViewer: 'TeamViewer',
2031
+ TeamManager: 'TeamManager',
2032
+ TeamAdmin: 'TeamAdmin',
2033
+ TechViewer: 'TechViewer',
2034
+ TechManager: 'TechManager',
2035
+ AppStoreViewer: 'AppStoreViewer',
2036
+ AppStoreManager: 'AppStoreManager',
2037
+ SalesChannelViewer: 'SalesChannelViewer',
2038
+ SalesChannelEditor: 'SalesChannelEditor',
2039
+ SalesChannelManager: 'SalesChannelManager',
2040
+ DeliveryViewer: 'DeliveryViewer',
2041
+ DeliveryManager: 'DeliveryManager',
2042
+ DriverManager: 'DriverManager',
2043
+ AuditViewer: 'AuditViewer',
2044
+ AuditManager: 'AuditManager',
2045
+ AccountsViewer: 'AccountsViewer',
2046
+ AccountsEditor: 'AccountsEditor',
2047
+ DocumentExplorerViewer: 'DocumentExplorerViewer',
2048
+ DocumentExplorerEditor: 'DocumentExplorerEditor',
2049
+ PayrollViewer: 'PayrollViewer',
2050
+ PayrollEditor: 'PayrollEditor',
2051
+ PropertyViewer: 'PropertyViewer',
2052
+ PropertyManager: 'PropertyManager',
2053
+ PropertyAdmin: 'PropertyAdmin',
2054
+ WebsiteContentEditor: 'WebsiteContentEditor',
2055
+ WebsiteContentViewer: 'WebsiteContentViewer',
2056
+ WebsiteTechViewer: 'WebsiteTechViewer',
2057
+ MenuViewer: 'MenuViewer',
2058
+ MenuEditor: 'MenuEditor',
2059
+ MenuManager: 'MenuManager',
2060
+ MenuMetaFieldManager: 'MenuMetaFieldManager',
2061
+ MenuMetaFieldEditor: 'MenuMetaFieldEditor',
2062
+ MenuMetaFieldViewer: 'MenuMetaFieldViewer',
2063
+ StoreDeliveryZoneManager: 'StoreDeliveryZoneManager',
2064
+ StoreDeliveryZoneEditor: 'StoreDeliveryZoneEditor',
2065
+ StoreDeliveryZoneViewer: 'StoreDeliveryZoneViewer',
2066
+ OrderFulfillmentManager: 'OrderFulfillmentManager',
2067
+ OrderManager: 'OrderManager',
2068
+ OrderEditor: 'OrderEditor',
2069
+ OrderViewer: 'OrderViewer',
2070
+ InventoryManager: 'InventoryManager',
2071
+ InventoryEditor: 'InventoryEditor',
2072
+ InventoryViewer: 'InventoryViewer',
2073
+ PaymentManager: 'PaymentManager',
2074
+ OnboardingManager: 'OnboardingManager',
2075
+ FeatureFlagManager: 'FeatureFlagManager',
2076
+ PropertyOwnerMisc: 'PropertyOwnerMisc',
2077
+ ManagedOwnerMisc: 'ManagedOwnerMisc',
2078
+ IntegratorMisc: 'IntegratorMisc',
2079
+ PropertyManagerMisc: 'PropertyManagerMisc',
2080
+ FinanceManagerMisc: 'FinanceManagerMisc',
2081
+ SupportMisc: 'SupportMisc'
2082
+ } as const;
2083
+
2084
+ export type ListOrgRolesSuccessResponseValueValueRolesEnum = typeof ListOrgRolesSuccessResponseValueValueRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueValueRolesEnum];
2085
+
2086
+ /**
2087
+ * Successful permissions retrieval response
2088
+ * @export
2089
+ * @interface ListPermissionsSuccessResponse
2090
+ */
2091
+ export interface ListPermissionsSuccessResponse {
2092
+ /**
2093
+ *
2094
+ * @type {Permissions & Array<string>}
2095
+ * @memberof ListPermissionsSuccessResponse
2096
+ */
2097
+ 'permissions': Permissions & Array<string>;
2098
+ }
2099
+ /**
2100
+ * Successful roles retrieval response
2101
+ * @export
2102
+ * @interface ListRolesSuccessResponse
2103
+ */
2104
+ export interface ListRolesSuccessResponse {
2105
+ /**
2106
+ * List of named roles
2107
+ * @type {Array<string>}
2108
+ * @memberof ListRolesSuccessResponse
2109
+ */
2110
+ 'roles': Array<ListRolesSuccessResponseRolesEnum>;
2111
+ }
2112
+
2113
+ export const ListRolesSuccessResponseRolesEnum = {
2114
+ Admin: 'Admin',
2115
+ Factory: 'Factory'
2116
+ } as const;
2117
+
2118
+ export type ListRolesSuccessResponseRolesEnum = typeof ListRolesSuccessResponseRolesEnum[keyof typeof ListRolesSuccessResponseRolesEnum];
2119
+
2120
+ /**
2121
+ *
2122
+ * @export
2123
+ * @enum {string}
2124
+ */
2125
+
2126
+ export const Permissions = {
2127
+ AnyAuditLogs: 'AnyAuditLogs',
2128
+ ViewApp: 'ViewApp',
2129
+ CreateApp: 'CreateApp',
2130
+ UpdateApp: 'UpdateApp',
2131
+ ViewAppName: 'ViewAppName',
2132
+ EditAppAssets: 'EditAppAssets',
2133
+ EditAppFeatures: 'EditAppFeatures',
2134
+ ViewTeammates: 'ViewTeammates',
2135
+ EditTeammates: 'EditTeammates',
2136
+ CreateTeammateOwner: 'CreateTeammateOwner',
2137
+ CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
2138
+ CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
2139
+ CreateTeammateStoreManager: 'CreateTeammateStoreManager',
2140
+ CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
2141
+ CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
2142
+ CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
2143
+ CreateTeammateIntegrator: 'CreateTeammateIntegrator',
2144
+ CreateTeammateOnboarding: 'CreateTeammateOnboarding',
2145
+ CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
2146
+ CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
2147
+ ViewApmConfigurations: 'ViewApmConfigurations',
2148
+ EditApmConfigurations: 'EditApmConfigurations',
2149
+ ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
2150
+ CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
2151
+ UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
2152
+ DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
2153
+ StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
2154
+ ViewDevelopersSettings: 'ViewDevelopersSettings',
2155
+ EditDevelopersSettings: 'EditDevelopersSettings',
2156
+ ViewOrders: 'ViewOrders',
2157
+ UpdateOrdersAccept: 'UpdateOrdersAccept',
2158
+ UpdateOrdersReject: 'UpdateOrdersReject',
2159
+ UpdateOrdersRefund: 'UpdateOrdersRefund',
2160
+ UpdateOrdersDispatch: 'UpdateOrdersDispatch',
2161
+ ViewStores: 'ViewStores',
2162
+ CreateStores: 'CreateStores',
2163
+ EditStores: 'EditStores',
2164
+ ViewStoresOpeningHours: 'ViewStoresOpeningHours',
2165
+ UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
2166
+ UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
2167
+ ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
2168
+ EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
2169
+ EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
2170
+ UpdateStoresName: 'UpdateStoresName',
2171
+ EditStoreKioskSettings: 'EditStoreKioskSettings',
2172
+ EditStoreOrderCapacity: 'EditStoreOrderCapacity',
2173
+ EditStoreNotifications: 'EditStoreNotifications',
2174
+ ArchiveStores: 'ArchiveStores',
2175
+ PublishStores: 'PublishStores',
2176
+ UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
2177
+ UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
2178
+ ViewStoreGroups: 'ViewStoreGroups',
2179
+ CreateStoreGroups: 'CreateStoreGroups',
2180
+ UpdateStoreGroups: 'UpdateStoreGroups',
2181
+ DeleteStoreGroups: 'DeleteStoreGroups',
2182
+ ViewDeliveryZones: 'ViewDeliveryZones',
2183
+ CreateDeliveryZones: 'CreateDeliveryZones',
2184
+ UpdateDeliveryZones: 'UpdateDeliveryZones',
2185
+ DeleteDeliveryZones: 'DeleteDeliveryZones',
2186
+ ViewMenu: 'ViewMenu',
2187
+ CreateMenu: 'CreateMenu',
2188
+ UpdateMenu: 'UpdateMenu',
2189
+ DeleteMenu: 'DeleteMenu',
2190
+ UpdateMenuLock: 'UpdateMenuLock',
2191
+ UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
2192
+ EditMenuImage: 'EditMenuImage',
2193
+ ViewVouchers: 'ViewVouchers',
2194
+ EditVouchers: 'EditVouchers',
2195
+ ViewWebsiteContent: 'ViewWebsiteContent',
2196
+ EditWebsiteContent: 'EditWebsiteContent',
2197
+ ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
2198
+ ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
2199
+ ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
2200
+ ViewBankAccounts: 'ViewBankAccounts',
2201
+ CreateBankAccounts: 'CreateBankAccounts',
2202
+ UpdateBankAccounts: 'UpdateBankAccounts',
2203
+ UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
2204
+ ViewAssignedBankAccount: 'ViewAssignedBankAccount',
2205
+ VerifyBankAccounts: 'VerifyBankAccounts',
2206
+ ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
2207
+ EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
2208
+ EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
2209
+ EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
2210
+ ViewHydraConfig: 'ViewHydraConfig',
2211
+ UpdateHydraConfigManage: 'UpdateHydraConfigManage',
2212
+ InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
2213
+ DeleteTerminal: 'DeleteTerminal',
2214
+ ViewKioskTelemetry: 'ViewKioskTelemetry',
2215
+ ViewCustomers: 'ViewCustomers',
2216
+ EditCustomers: 'EditCustomers',
2217
+ CreateCustomers: 'CreateCustomers',
2218
+ CreateCatalogElements: 'CreateCatalogElements',
2219
+ UpdateCatalogElements: 'UpdateCatalogElements',
2220
+ ViewCatalogElements: 'ViewCatalogElements',
2221
+ DeleteCatalogElements: 'DeleteCatalogElements',
2222
+ ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
2223
+ CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
2224
+ UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
2225
+ DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
2226
+ UpdateMetafields: 'UpdateMetafields',
2227
+ ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
2228
+ PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
2229
+ ViewAppStatistics: 'ViewAppStatistics',
2230
+ ViewApmStatistics: 'ViewApmStatistics',
2231
+ ViewCampaignsStatistics: 'ViewCampaignsStatistics',
2232
+ ViewCustomerStatistics: 'ViewCustomerStatistics',
2233
+ ViewLiveStatistics: 'ViewLiveStatistics',
2234
+ ViewOrderStatistics: 'ViewOrderStatistics',
2235
+ ViewSalesStatistics: 'ViewSalesStatistics',
2236
+ ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
2237
+ ViewVouchersStatistics: 'ViewVouchersStatistics',
2238
+ DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
2239
+ ViewApmAuditLogs: 'ViewApmAuditLogs',
2240
+ ViewStoreAuditLogs: 'ViewStoreAuditLogs',
2241
+ ViewMenuAuditLogs: 'ViewMenuAuditLogs',
2242
+ ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
2243
+ ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
2244
+ ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
2245
+ ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
2246
+ ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
2247
+ ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
2248
+ ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
2249
+ ViewAppAuditLogs: 'ViewAppAuditLogs',
2250
+ ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
2251
+ ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
2252
+ ViewHydraAuditLogs: 'ViewHydraAuditLogs',
2253
+ ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
2254
+ ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
2255
+ ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
2256
+ ViewExternalAuditLogs: 'ViewExternalAuditLogs',
2257
+ CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
2258
+ ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
2259
+ ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
2260
+ ViewChannelAuditLogs: 'ViewChannelAuditLogs',
2261
+ ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
2262
+ SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
2263
+ InviteDriverToApp: 'InviteDriverToApp',
2264
+ GetDriverForApp: 'GetDriverForApp',
2265
+ RemoveDriverFromApp: 'RemoveDriverFromApp',
2266
+ AssignDriverToOrder: 'AssignDriverToOrder',
2267
+ UnassignDriverFromOrder: 'UnassignDriverFromOrder',
2268
+ UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
2269
+ UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
2270
+ ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
2271
+ CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
2272
+ UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
2273
+ DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
2274
+ ViewPayouts: 'ViewPayouts',
2275
+ ViewChannels: 'ViewChannels',
2276
+ ViewOnboarding: 'ViewOnboarding',
2277
+ UpdateOnboarding: 'UpdateOnboarding',
2278
+ ViewClientDevices: 'ViewClientDevices',
2279
+ UpdateClientDevices: 'UpdateClientDevices',
2280
+ EnrollClientDevices: 'EnrollClientDevices',
2281
+ AssignClientDevices: 'AssignClientDevices',
2282
+ ViewClientAuditLogs: 'ViewClientAuditLogs',
2283
+ CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
2284
+ ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
2285
+ UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
2286
+ DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
2287
+ UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
2288
+ CreateAppStoreSubscription: 'CreateAppStoreSubscription',
2289
+ UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
2290
+ DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
2291
+ ViewSalesChannels: 'ViewSalesChannels',
2292
+ EditSalesChannels: 'EditSalesChannels',
2293
+ CreateSalesChannel: 'CreateSalesChannel',
2294
+ ArchiveSalesChannel: 'ArchiveSalesChannel',
2295
+ UnarchiveSalesChannel: 'UnarchiveSalesChannel',
2296
+ PublishSalesChannel: 'PublishSalesChannel',
2297
+ UnpublishSalesChannel: 'UnpublishSalesChannel',
2298
+ CloneSalesChannel: 'CloneSalesChannel',
2299
+ ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
2300
+ CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
2301
+ UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
2302
+ UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
2303
+ ViewSubscriptions: 'ViewSubscriptions',
2304
+ ViewInvoices: 'ViewInvoices',
2305
+ EditAccountsBills: 'EditAccountsBills',
2306
+ ViewAccountsBills: 'ViewAccountsBills',
2307
+ EditAccountsCategories: 'EditAccountsCategories',
2308
+ ViewAccountsCategories: 'ViewAccountsCategories',
2309
+ EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
2310
+ ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
2311
+ EditAccountsCreditBooks: 'EditAccountsCreditBooks',
2312
+ ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
2313
+ EditAccountsExpenses: 'EditAccountsExpenses',
2314
+ ViewAccountsExpenses: 'ViewAccountsExpenses',
2315
+ EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
2316
+ ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
2317
+ EditDocumentExplorer: 'EditDocumentExplorer',
2318
+ ViewDocumentExplorer: 'ViewDocumentExplorer',
2319
+ ViewInventoryReports: 'ViewInventoryReports',
2320
+ EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
2321
+ ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
2322
+ EditInventoryStockItems: 'EditInventoryStockItems',
2323
+ ViewInventoryStockItems: 'ViewInventoryStockItems',
2324
+ EditInventorySupplier: 'EditInventorySupplier',
2325
+ ViewInventorySupplier: 'ViewInventorySupplier',
2326
+ EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
2327
+ ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
2328
+ ViewPayrollReports: 'ViewPayrollReports',
2329
+ EditPayrollHoliday: 'EditPayrollHoliday',
2330
+ ViewPayrollHoliday: 'ViewPayrollHoliday',
2331
+ EditPayrollRota: 'EditPayrollRota',
2332
+ ViewPayrollRota: 'ViewPayrollRota',
2333
+ EditPayrollStaff: 'EditPayrollStaff',
2334
+ ViewPayrollStaff: 'ViewPayrollStaff',
2335
+ ViewSalesReports: 'ViewSalesReports',
2336
+ ViewCostReports: 'ViewCostReports',
2337
+ ViewMenuReports: 'ViewMenuReports',
2338
+ ViewBrand: 'ViewBrand',
2339
+ EditBrand: 'EditBrand',
2340
+ CreateBrand: 'CreateBrand',
2341
+ TransferBrand: 'TransferBrand',
2342
+ ViewProperty: 'ViewProperty',
2343
+ EditProperty: 'EditProperty',
2344
+ CreateProperty: 'CreateProperty',
2345
+ ArchiveProperty: 'ArchiveProperty',
2346
+ ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
2347
+ EditEntityFeatureFlags: 'EditEntityFeatureFlags',
2348
+ CreateOrg: 'CreateOrg',
2349
+ EditOrg: 'EditOrg',
2350
+ ViewOrg: 'ViewOrg',
2351
+ ViewWebhooks: 'ViewWebhooks',
2352
+ EditWebhooks: 'EditWebhooks',
2353
+ RoleAdmin: 'RoleAdmin',
2354
+ RoleFactory: 'RoleFactory'
2355
+ } as const;
2356
+
2357
+ export type Permissions = typeof Permissions[keyof typeof Permissions];
2358
+
2359
+
2360
+ /**
2361
+ * Details for revoking a forbidden role from a principal
2362
+ * @export
2363
+ * @interface RevokeForbiddenRoleRequestBody
2364
+ */
2365
+ export interface RevokeForbiddenRoleRequestBody {
2366
+ /**
2367
+ *
2368
+ * @type {AuthorizationRequestPrincipal}
2369
+ * @memberof RevokeForbiddenRoleRequestBody
2370
+ */
2371
+ 'principal': AuthorizationRequestPrincipal;
2372
+ /**
2373
+ * Compensation role to revoke the forbidden role from
2374
+ * @type {string}
2375
+ * @memberof RevokeForbiddenRoleRequestBody
2376
+ */
2377
+ 'compensatingRole': RevokeForbiddenRoleRequestBodyCompensatingRoleEnum;
2378
+ }
2379
+
2380
+ export const RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = {
2381
+ OwnerCompensating: 'OwnerCompensating',
2382
+ PropertyOwnerCompensating: 'PropertyOwnerCompensating',
2383
+ ManagedOwnerCompensating: 'ManagedOwnerCompensating',
2384
+ IntegratorCompensating: 'IntegratorCompensating',
2385
+ PropertyManagerCompensating: 'PropertyManagerCompensating',
2386
+ FinanceManagerCompensating: 'FinanceManagerCompensating'
2387
+ } as const;
2388
+
2389
+ export type RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum[keyof typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum];
2390
+
2391
+ /**
2392
+ * Details for revoking a role from a principal
2393
+ * @export
2394
+ * @interface RevokeRoleRequestBody
2395
+ */
2396
+ export interface RevokeRoleRequestBody {
2397
+ /**
2398
+ *
2399
+ * @type {string}
2400
+ * @memberof RevokeRoleRequestBody
2401
+ */
2402
+ 'role': RevokeRoleRequestBodyRoleEnum;
2403
+ /**
2404
+ *
2405
+ * @type {AuthorizationRequestResource}
2406
+ * @memberof RevokeRoleRequestBody
2407
+ */
2408
+ 'resource': AuthorizationRequestResource;
2409
+ /**
2410
+ *
2411
+ * @type {AuthorizationRequestPrincipal}
2412
+ * @memberof RevokeRoleRequestBody
2413
+ */
2414
+ 'principal': AuthorizationRequestPrincipal;
2415
+ /**
2416
+ *
2417
+ * @type {string}
2418
+ * @memberof RevokeRoleRequestBody
2419
+ */
2420
+ 'brandId': string;
2421
+ }
2422
+
2423
+ export const RevokeRoleRequestBodyRoleEnum = {
2424
+ OrgViewer: 'OrgViewer',
2425
+ OrgManager: 'OrgManager',
2426
+ OrgAdmin: 'OrgAdmin',
2427
+ BrandViewer: 'BrandViewer',
2428
+ BrandManager: 'BrandManager',
2429
+ BrandAdmin: 'BrandAdmin',
2430
+ StoreViewer: 'StoreViewer',
2431
+ StoreEditor: 'StoreEditor',
2432
+ StoreManager: 'StoreManager',
2433
+ CustomerViewer: 'CustomerViewer',
2434
+ CustomerManager: 'CustomerManager',
2435
+ VoucherViewer: 'VoucherViewer',
2436
+ VoucherEditor: 'VoucherEditor',
2437
+ VoucherManager: 'VoucherManager',
2438
+ VoucherCampaignManager: 'VoucherCampaignManager',
2439
+ VoucherStatisticsViewer: 'VoucherStatisticsViewer',
2440
+ AnalyticsViewer: 'AnalyticsViewer',
2441
+ ReportsViewer: 'ReportsViewer',
2442
+ FinanceViewer: 'FinanceViewer',
2443
+ FinanceManager: 'FinanceManager',
2444
+ TeamViewer: 'TeamViewer',
2445
+ TeamManager: 'TeamManager',
2446
+ TeamAdmin: 'TeamAdmin',
2447
+ TechViewer: 'TechViewer',
2448
+ TechManager: 'TechManager',
2449
+ AppStoreViewer: 'AppStoreViewer',
2450
+ AppStoreManager: 'AppStoreManager',
2451
+ SalesChannelViewer: 'SalesChannelViewer',
2452
+ SalesChannelEditor: 'SalesChannelEditor',
2453
+ SalesChannelManager: 'SalesChannelManager',
2454
+ DeliveryViewer: 'DeliveryViewer',
2455
+ DeliveryManager: 'DeliveryManager',
2456
+ DriverManager: 'DriverManager',
2457
+ AuditViewer: 'AuditViewer',
2458
+ AuditManager: 'AuditManager',
2459
+ AccountsViewer: 'AccountsViewer',
2460
+ AccountsEditor: 'AccountsEditor',
2461
+ DocumentExplorerViewer: 'DocumentExplorerViewer',
2462
+ DocumentExplorerEditor: 'DocumentExplorerEditor',
2463
+ PayrollViewer: 'PayrollViewer',
2464
+ PayrollEditor: 'PayrollEditor',
2465
+ PropertyViewer: 'PropertyViewer',
2466
+ PropertyManager: 'PropertyManager',
2467
+ PropertyAdmin: 'PropertyAdmin',
2468
+ WebsiteContentEditor: 'WebsiteContentEditor',
2469
+ WebsiteContentViewer: 'WebsiteContentViewer',
2470
+ WebsiteTechViewer: 'WebsiteTechViewer',
2471
+ MenuViewer: 'MenuViewer',
2472
+ MenuEditor: 'MenuEditor',
2473
+ MenuManager: 'MenuManager',
2474
+ MenuMetaFieldManager: 'MenuMetaFieldManager',
2475
+ MenuMetaFieldEditor: 'MenuMetaFieldEditor',
2476
+ MenuMetaFieldViewer: 'MenuMetaFieldViewer',
2477
+ StoreDeliveryZoneManager: 'StoreDeliveryZoneManager',
2478
+ StoreDeliveryZoneEditor: 'StoreDeliveryZoneEditor',
2479
+ StoreDeliveryZoneViewer: 'StoreDeliveryZoneViewer',
2480
+ OrderFulfillmentManager: 'OrderFulfillmentManager',
2481
+ OrderManager: 'OrderManager',
2482
+ OrderEditor: 'OrderEditor',
2483
+ OrderViewer: 'OrderViewer',
2484
+ InventoryManager: 'InventoryManager',
2485
+ InventoryEditor: 'InventoryEditor',
2486
+ InventoryViewer: 'InventoryViewer',
2487
+ PaymentManager: 'PaymentManager',
2488
+ OnboardingManager: 'OnboardingManager',
2489
+ FeatureFlagManager: 'FeatureFlagManager',
2490
+ PropertyOwnerMisc: 'PropertyOwnerMisc',
2491
+ ManagedOwnerMisc: 'ManagedOwnerMisc',
2492
+ IntegratorMisc: 'IntegratorMisc',
2493
+ PropertyManagerMisc: 'PropertyManagerMisc',
2494
+ FinanceManagerMisc: 'FinanceManagerMisc',
2495
+ SupportMisc: 'SupportMisc'
2496
+ } as const;
2497
+
2498
+ export type RevokeRoleRequestBodyRoleEnum = typeof RevokeRoleRequestBodyRoleEnum[keyof typeof RevokeRoleRequestBodyRoleEnum];
2499
+
2500
+ /**
2501
+ * Successful role revocation response
2502
+ * @export
2503
+ * @interface RevokeRoleSuccessResponse
2504
+ */
2505
+ export interface RevokeRoleSuccessResponse {
2506
+ /**
2507
+ * Confirmation message
2508
+ * @type {string}
2509
+ * @memberof RevokeRoleSuccessResponse
2510
+ */
2511
+ 'message': string;
2512
+ }
2513
+ /**
2514
+ *
2515
+ * @export
2516
+ * @interface ValidationErrorsInner
2517
+ */
2518
+ export interface ValidationErrorsInner {
2519
+ /**
2520
+ *
2521
+ * @type {Array<ValidationErrorsInnerPathInner>}
2522
+ * @memberof ValidationErrorsInner
2523
+ */
2524
+ 'path'?: Array<ValidationErrorsInnerPathInner>;
2525
+ /**
2526
+ *
2527
+ * @type {string}
2528
+ * @memberof ValidationErrorsInner
2529
+ */
2530
+ 'message': string;
2531
+ }
2532
+ /**
2533
+ *
2534
+ * @export
2535
+ * @interface ValidationErrorsInnerPathInner
2536
+ */
2537
+ export interface ValidationErrorsInnerPathInner {
2538
+ }
2539
+
2540
+ /**
2541
+ * AuthenticationApi - axios parameter creator
2542
+ * @export
2543
+ */
2544
+ export const AuthenticationApiAxiosParamCreator = function (configuration?: Configuration) {
2545
+ return {
2546
+ /**
2547
+ * Authenticate and authorize a user to perform an action
2548
+ * @summary Authenticate and authorize Request
2549
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2550
+ * @param {*} [options] Override http request option.
2551
+ * @throws {RequiredError}
2552
+ */
2553
+ authenticateAndAuthorize: async (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2554
+ // verify required parameter 'authenticateAndAuthorizeRequest' is not null or undefined
2555
+ assertParamExists('authenticateAndAuthorize', 'authenticateAndAuthorizeRequest', authenticateAndAuthorizeRequest)
2556
+ const localVarPath = `/authenticateAndAuthorize`;
2557
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2558
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2559
+ let baseOptions;
2560
+ if (configuration) {
2561
+ baseOptions = configuration.baseOptions;
2562
+ }
2563
+
2564
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2565
+ const localVarHeaderParameter = {} as any;
2566
+ const localVarQueryParameter = {} as any;
2567
+
2568
+ // authentication ApiKeyAuth required
2569
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2570
+
2571
+
2572
+
2573
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2574
+
2575
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2576
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2577
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2578
+ localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndAuthorizeRequest, localVarRequestOptions, configuration)
2579
+
2580
+ return {
2581
+ url: toPathString(localVarUrlObj),
2582
+ options: localVarRequestOptions,
2583
+ };
2584
+ },
2585
+ }
2586
+ };
2587
+
2588
+ /**
2589
+ * AuthenticationApi - functional programming interface
2590
+ * @export
2591
+ */
2592
+ export const AuthenticationApiFp = function(configuration?: Configuration) {
2593
+ const localVarAxiosParamCreator = AuthenticationApiAxiosParamCreator(configuration)
2594
+ return {
2595
+ /**
2596
+ * Authenticate and authorize a user to perform an action
2597
+ * @summary Authenticate and authorize Request
2598
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2599
+ * @param {*} [options] Override http request option.
2600
+ * @throws {RequiredError}
2601
+ */
2602
+ async authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>> {
2603
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options);
2604
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2605
+ const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.authenticateAndAuthorize']?.[localVarOperationServerIndex]?.url;
2606
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2607
+ },
2608
+ }
2609
+ };
2610
+
2611
+ /**
2612
+ * AuthenticationApi - factory interface
2613
+ * @export
2614
+ */
2615
+ export const AuthenticationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2616
+ const localVarFp = AuthenticationApiFp(configuration)
2617
+ return {
2618
+ /**
2619
+ * Authenticate and authorize a user to perform an action
2620
+ * @summary Authenticate and authorize Request
2621
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2622
+ * @param {*} [options] Override http request option.
2623
+ * @throws {RequiredError}
2624
+ */
2625
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse> {
2626
+ return localVarFp.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(axios, basePath));
2627
+ },
2628
+ };
2629
+ };
2630
+
2631
+ /**
2632
+ * AuthenticationApi - object-oriented interface
2633
+ * @export
2634
+ * @class AuthenticationApi
2635
+ * @extends {BaseAPI}
2636
+ */
2637
+ export class AuthenticationApi extends BaseAPI {
2638
+ /**
2639
+ * Authenticate and authorize a user to perform an action
2640
+ * @summary Authenticate and authorize Request
2641
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2642
+ * @param {*} [options] Override http request option.
2643
+ * @throws {RequiredError}
2644
+ * @memberof AuthenticationApi
2645
+ */
2646
+ public authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) {
2647
+ return AuthenticationApiFp(this.configuration).authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
2648
+ }
2649
+ }
2650
+
2651
+
2652
+
2653
+ /**
2654
+ * AuthorizationApi - axios parameter creator
2655
+ * @export
2656
+ */
2657
+ export const AuthorizationApiAxiosParamCreator = function (configuration?: Configuration) {
2658
+ return {
2659
+ /**
2660
+ * Authenticate and authorize a user to perform an action
2661
+ * @summary Authenticate and authorize Request
2662
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2663
+ * @param {*} [options] Override http request option.
2664
+ * @throws {RequiredError}
2665
+ */
2666
+ authenticateAndAuthorize: async (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2667
+ // verify required parameter 'authenticateAndAuthorizeRequest' is not null or undefined
2668
+ assertParamExists('authenticateAndAuthorize', 'authenticateAndAuthorizeRequest', authenticateAndAuthorizeRequest)
2669
+ const localVarPath = `/authenticateAndAuthorize`;
2670
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2671
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2672
+ let baseOptions;
2673
+ if (configuration) {
2674
+ baseOptions = configuration.baseOptions;
2675
+ }
2676
+
2677
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2678
+ const localVarHeaderParameter = {} as any;
2679
+ const localVarQueryParameter = {} as any;
2680
+
2681
+ // authentication ApiKeyAuth required
2682
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2683
+
2684
+
2685
+
2686
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2687
+
2688
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2689
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2690
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2691
+ localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndAuthorizeRequest, localVarRequestOptions, configuration)
2692
+
2693
+ return {
2694
+ url: toPathString(localVarUrlObj),
2695
+ options: localVarRequestOptions,
2696
+ };
2697
+ },
2698
+ /**
2699
+ * Authenticate and check if a user is in any/all of the roles
2700
+ * @summary Authenticate and Check Is In Role
2701
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
2702
+ * @param {*} [options] Override http request option.
2703
+ * @throws {RequiredError}
2704
+ */
2705
+ authenticateAndCheckIsInRole: async (authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2706
+ const localVarPath = `/authenticateAndCheckIsInRole`;
2707
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2708
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2709
+ let baseOptions;
2710
+ if (configuration) {
2711
+ baseOptions = configuration.baseOptions;
2712
+ }
2713
+
2714
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2715
+ const localVarHeaderParameter = {} as any;
2716
+ const localVarQueryParameter = {} as any;
2717
+
2718
+ // authentication ApiKeyAuth required
2719
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2720
+
2721
+
2722
+
2723
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2724
+
2725
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2726
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2727
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2728
+ localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndCheckIsInRoleRequest, localVarRequestOptions, configuration)
2729
+
2730
+ return {
2731
+ url: toPathString(localVarUrlObj),
2732
+ options: localVarRequestOptions,
2733
+ };
2734
+ },
2735
+ /**
2736
+ * Check if a user is authorized to perform an action
2737
+ * @summary Authorize Request
2738
+ * @param {AuthorizationRequest} [authorizationRequest]
2739
+ * @param {*} [options] Override http request option.
2740
+ * @throws {RequiredError}
2741
+ */
2742
+ authorize: async (authorizationRequest?: AuthorizationRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2743
+ const localVarPath = `/authorize`;
2744
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2745
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2746
+ let baseOptions;
2747
+ if (configuration) {
2748
+ baseOptions = configuration.baseOptions;
2749
+ }
2750
+
2751
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2752
+ const localVarHeaderParameter = {} as any;
2753
+ const localVarQueryParameter = {} as any;
2754
+
2755
+ // authentication ApiKeyAuth required
2756
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2757
+
2758
+
2759
+
2760
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2761
+
2762
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2763
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2764
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2765
+ localVarRequestOptions.data = serializeDataIfNeeded(authorizationRequest, localVarRequestOptions, configuration)
2766
+
2767
+ return {
2768
+ url: toPathString(localVarUrlObj),
2769
+ options: localVarRequestOptions,
2770
+ };
2771
+ },
2772
+ /**
2773
+ * Check if a user is authorized to perform an action on multiple resources
2774
+ * @summary Authorize Batch Request
2775
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
2776
+ * @param {*} [options] Override http request option.
2777
+ * @throws {RequiredError}
2778
+ */
2779
+ authorizeBatch: async (authorizationBatchRequest?: AuthorizationBatchRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2780
+ const localVarPath = `/authorize/batch`;
2781
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2782
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2783
+ let baseOptions;
2784
+ if (configuration) {
2785
+ baseOptions = configuration.baseOptions;
2786
+ }
2787
+
2788
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2789
+ const localVarHeaderParameter = {} as any;
2790
+ const localVarQueryParameter = {} as any;
2791
+
2792
+ // authentication ApiKeyAuth required
2793
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2794
+
2795
+
2796
+
2797
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2798
+
2799
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2800
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2801
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2802
+ localVarRequestOptions.data = serializeDataIfNeeded(authorizationBatchRequest, localVarRequestOptions, configuration)
2803
+
2804
+ return {
2805
+ url: toPathString(localVarUrlObj),
2806
+ options: localVarRequestOptions,
2807
+ };
2808
+ },
2809
+ /**
2810
+ * Check if a user is in any/all of the roles
2811
+ * @summary Check Is In Role
2812
+ * @param {IsInRoleRequest} [isInRoleRequest]
2813
+ * @param {*} [options] Override http request option.
2814
+ * @throws {RequiredError}
2815
+ */
2816
+ checkIsInRole: async (isInRoleRequest?: IsInRoleRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2817
+ const localVarPath = `/checkIsInRole`;
2818
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2819
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2820
+ let baseOptions;
2821
+ if (configuration) {
2822
+ baseOptions = configuration.baseOptions;
2823
+ }
2824
+
2825
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2826
+ const localVarHeaderParameter = {} as any;
2827
+ const localVarQueryParameter = {} as any;
2828
+
2829
+ // authentication ApiKeyAuth required
2830
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2831
+
2832
+
2833
+
2834
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2835
+
2836
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2837
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2838
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2839
+ localVarRequestOptions.data = serializeDataIfNeeded(isInRoleRequest, localVarRequestOptions, configuration)
2840
+
2841
+ return {
2842
+ url: toPathString(localVarUrlObj),
2843
+ options: localVarRequestOptions,
2844
+ };
2845
+ },
1410
2846
  }
1411
2847
  };
1412
2848
 
1413
2849
  /**
1414
- * AuthenticationApi - factory interface
2850
+ * AuthorizationApi - functional programming interface
1415
2851
  * @export
1416
2852
  */
1417
- export const AuthenticationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1418
- const localVarFp = AuthenticationApiFp(configuration)
2853
+ export const AuthorizationApiFp = function(configuration?: Configuration) {
2854
+ const localVarAxiosParamCreator = AuthorizationApiAxiosParamCreator(configuration)
2855
+ return {
2856
+ /**
2857
+ * Authenticate and authorize a user to perform an action
2858
+ * @summary Authenticate and authorize Request
2859
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2860
+ * @param {*} [options] Override http request option.
2861
+ * @throws {RequiredError}
2862
+ */
2863
+ async authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>> {
2864
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options);
2865
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2866
+ const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authenticateAndAuthorize']?.[localVarOperationServerIndex]?.url;
2867
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2868
+ },
2869
+ /**
2870
+ * Authenticate and check if a user is in any/all of the roles
2871
+ * @summary Authenticate and Check Is In Role
2872
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
2873
+ * @param {*} [options] Override http request option.
2874
+ * @throws {RequiredError}
2875
+ */
2876
+ async authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndCheckIsInRoleResponse>> {
2877
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest, options);
2878
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2879
+ const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authenticateAndCheckIsInRole']?.[localVarOperationServerIndex]?.url;
2880
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2881
+ },
2882
+ /**
2883
+ * Check if a user is authorized to perform an action
2884
+ * @summary Authorize Request
2885
+ * @param {AuthorizationRequest} [authorizationRequest]
2886
+ * @param {*} [options] Override http request option.
2887
+ * @throws {RequiredError}
2888
+ */
2889
+ async authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>> {
2890
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authorize(authorizationRequest, options);
2891
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2892
+ const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authorize']?.[localVarOperationServerIndex]?.url;
2893
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2894
+ },
2895
+ /**
2896
+ * Check if a user is authorized to perform an action on multiple resources
2897
+ * @summary Authorize Batch Request
2898
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
2899
+ * @param {*} [options] Override http request option.
2900
+ * @throws {RequiredError}
2901
+ */
2902
+ async authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationBatchResponse>> {
2903
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authorizeBatch(authorizationBatchRequest, options);
2904
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2905
+ const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authorizeBatch']?.[localVarOperationServerIndex]?.url;
2906
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2907
+ },
2908
+ /**
2909
+ * Check if a user is in any/all of the roles
2910
+ * @summary Check Is In Role
2911
+ * @param {IsInRoleRequest} [isInRoleRequest]
2912
+ * @param {*} [options] Override http request option.
2913
+ * @throws {RequiredError}
2914
+ */
2915
+ async checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IsInRoleResponse>> {
2916
+ const localVarAxiosArgs = await localVarAxiosParamCreator.checkIsInRole(isInRoleRequest, options);
2917
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2918
+ const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.checkIsInRole']?.[localVarOperationServerIndex]?.url;
2919
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2920
+ },
2921
+ }
2922
+ };
2923
+
2924
+ /**
2925
+ * AuthorizationApi - factory interface
2926
+ * @export
2927
+ */
2928
+ export const AuthorizationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2929
+ const localVarFp = AuthorizationApiFp(configuration)
1419
2930
  return {
1420
2931
  /**
1421
2932
  * Authenticate and authorize a user to perform an action
@@ -1427,48 +2938,138 @@ export const AuthenticationApiFactory = function (configuration?: Configuration,
1427
2938
  authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse> {
1428
2939
  return localVarFp.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(axios, basePath));
1429
2940
  },
2941
+ /**
2942
+ * Authenticate and check if a user is in any/all of the roles
2943
+ * @summary Authenticate and Check Is In Role
2944
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
2945
+ * @param {*} [options] Override http request option.
2946
+ * @throws {RequiredError}
2947
+ */
2948
+ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndCheckIsInRoleResponse> {
2949
+ return localVarFp.authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest, options).then((request) => request(axios, basePath));
2950
+ },
2951
+ /**
2952
+ * Check if a user is authorized to perform an action
2953
+ * @summary Authorize Request
2954
+ * @param {AuthorizationRequest} [authorizationRequest]
2955
+ * @param {*} [options] Override http request option.
2956
+ * @throws {RequiredError}
2957
+ */
2958
+ authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationResponse> {
2959
+ return localVarFp.authorize(authorizationRequest, options).then((request) => request(axios, basePath));
2960
+ },
2961
+ /**
2962
+ * Check if a user is authorized to perform an action on multiple resources
2963
+ * @summary Authorize Batch Request
2964
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
2965
+ * @param {*} [options] Override http request option.
2966
+ * @throws {RequiredError}
2967
+ */
2968
+ authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationBatchResponse> {
2969
+ return localVarFp.authorizeBatch(authorizationBatchRequest, options).then((request) => request(axios, basePath));
2970
+ },
2971
+ /**
2972
+ * Check if a user is in any/all of the roles
2973
+ * @summary Check Is In Role
2974
+ * @param {IsInRoleRequest} [isInRoleRequest]
2975
+ * @param {*} [options] Override http request option.
2976
+ * @throws {RequiredError}
2977
+ */
2978
+ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<IsInRoleResponse> {
2979
+ return localVarFp.checkIsInRole(isInRoleRequest, options).then((request) => request(axios, basePath));
2980
+ },
1430
2981
  };
1431
2982
  };
1432
2983
 
1433
- /**
1434
- * AuthenticationApi - object-oriented interface
1435
- * @export
1436
- * @class AuthenticationApi
1437
- * @extends {BaseAPI}
1438
- */
1439
- export class AuthenticationApi extends BaseAPI {
2984
+ /**
2985
+ * AuthorizationApi - object-oriented interface
2986
+ * @export
2987
+ * @class AuthorizationApi
2988
+ * @extends {BaseAPI}
2989
+ */
2990
+ export class AuthorizationApi extends BaseAPI {
2991
+ /**
2992
+ * Authenticate and authorize a user to perform an action
2993
+ * @summary Authenticate and authorize Request
2994
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2995
+ * @param {*} [options] Override http request option.
2996
+ * @throws {RequiredError}
2997
+ * @memberof AuthorizationApi
2998
+ */
2999
+ public authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) {
3000
+ return AuthorizationApiFp(this.configuration).authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
3001
+ }
3002
+
3003
+ /**
3004
+ * Authenticate and check if a user is in any/all of the roles
3005
+ * @summary Authenticate and Check Is In Role
3006
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
3007
+ * @param {*} [options] Override http request option.
3008
+ * @throws {RequiredError}
3009
+ * @memberof AuthorizationApi
3010
+ */
3011
+ public authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig) {
3012
+ return AuthorizationApiFp(this.configuration).authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest, options).then((request) => request(this.axios, this.basePath));
3013
+ }
3014
+
3015
+ /**
3016
+ * Check if a user is authorized to perform an action
3017
+ * @summary Authorize Request
3018
+ * @param {AuthorizationRequest} [authorizationRequest]
3019
+ * @param {*} [options] Override http request option.
3020
+ * @throws {RequiredError}
3021
+ * @memberof AuthorizationApi
3022
+ */
3023
+ public authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig) {
3024
+ return AuthorizationApiFp(this.configuration).authorize(authorizationRequest, options).then((request) => request(this.axios, this.basePath));
3025
+ }
3026
+
1440
3027
  /**
1441
- * Authenticate and authorize a user to perform an action
1442
- * @summary Authenticate and authorize Request
1443
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3028
+ * Check if a user is authorized to perform an action on multiple resources
3029
+ * @summary Authorize Batch Request
3030
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
1444
3031
  * @param {*} [options] Override http request option.
1445
3032
  * @throws {RequiredError}
1446
- * @memberof AuthenticationApi
3033
+ * @memberof AuthorizationApi
1447
3034
  */
1448
- public authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) {
1449
- return AuthenticationApiFp(this.configuration).authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
3035
+ public authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig) {
3036
+ return AuthorizationApiFp(this.configuration).authorizeBatch(authorizationBatchRequest, options).then((request) => request(this.axios, this.basePath));
3037
+ }
3038
+
3039
+ /**
3040
+ * Check if a user is in any/all of the roles
3041
+ * @summary Check Is In Role
3042
+ * @param {IsInRoleRequest} [isInRoleRequest]
3043
+ * @param {*} [options] Override http request option.
3044
+ * @throws {RequiredError}
3045
+ * @memberof AuthorizationApi
3046
+ */
3047
+ public checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig) {
3048
+ return AuthorizationApiFp(this.configuration).checkIsInRole(isInRoleRequest, options).then((request) => request(this.axios, this.basePath));
1450
3049
  }
1451
3050
  }
1452
3051
 
1453
3052
 
1454
3053
 
1455
3054
  /**
1456
- * AuthorizationApi - axios parameter creator
3055
+ * AuthorizedEntitiesApi - axios parameter creator
1457
3056
  * @export
1458
3057
  */
1459
- export const AuthorizationApiAxiosParamCreator = function (configuration?: Configuration) {
3058
+ export const AuthorizedEntitiesApiAxiosParamCreator = function (configuration?: Configuration) {
1460
3059
  return {
1461
3060
  /**
1462
- * Authenticate and authorize a user to perform an action
1463
- * @summary Authenticate and authorize Request
1464
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3061
+ * Get the authorized brands for a given org
3062
+ * @summary Get Authorized Brands
3063
+ * @param {string} orgId
3064
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
1465
3065
  * @param {*} [options] Override http request option.
1466
3066
  * @throws {RequiredError}
1467
3067
  */
1468
- authenticateAndAuthorize: async (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1469
- // verify required parameter 'authenticateAndAuthorizeRequest' is not null or undefined
1470
- assertParamExists('authenticateAndAuthorize', 'authenticateAndAuthorizeRequest', authenticateAndAuthorizeRequest)
1471
- const localVarPath = `/authenticateAndAuthorize`;
3068
+ getAuthorizedBrands: async (orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3069
+ // verify required parameter 'orgId' is not null or undefined
3070
+ assertParamExists('getAuthorizedBrands', 'orgId', orgId)
3071
+ const localVarPath = `/orgs/{orgId}/getAuthorizedBrands`
3072
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
1472
3073
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1473
3074
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1474
3075
  let baseOptions;
@@ -1490,7 +3091,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
1490
3091
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1491
3092
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1492
3093
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1493
- localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndAuthorizeRequest, localVarRequestOptions, configuration)
3094
+ localVarRequestOptions.data = serializeDataIfNeeded(getAuthorizedBrandsRequest, localVarRequestOptions, configuration)
1494
3095
 
1495
3096
  return {
1496
3097
  url: toPathString(localVarUrlObj),
@@ -1498,14 +3099,14 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
1498
3099
  };
1499
3100
  },
1500
3101
  /**
1501
- * Check if a user is authorized to perform an action
1502
- * @summary Authorize Request
1503
- * @param {AuthorizationRequest} [authorizationRequest]
3102
+ * Get the authorized orgs for a given principal
3103
+ * @summary Get Authorized Orgs
3104
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
1504
3105
  * @param {*} [options] Override http request option.
1505
3106
  * @throws {RequiredError}
1506
3107
  */
1507
- authorize: async (authorizationRequest?: AuthorizationRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1508
- const localVarPath = `/authorize`;
3108
+ getAuthorizedOrgs: async (getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3109
+ const localVarPath = `/getAuthorizedOrgs`;
1509
3110
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1510
3111
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1511
3112
  let baseOptions;
@@ -1527,7 +3128,48 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
1527
3128
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1528
3129
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1529
3130
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1530
- localVarRequestOptions.data = serializeDataIfNeeded(authorizationRequest, localVarRequestOptions, configuration)
3131
+ localVarRequestOptions.data = serializeDataIfNeeded(getAuthorizedOrgsRequest, localVarRequestOptions, configuration)
3132
+
3133
+ return {
3134
+ url: toPathString(localVarUrlObj),
3135
+ options: localVarRequestOptions,
3136
+ };
3137
+ },
3138
+ /**
3139
+ * Get the authorized properties for a given org
3140
+ * @summary Get Authorized Properties
3141
+ * @param {string} orgId
3142
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
3143
+ * @param {*} [options] Override http request option.
3144
+ * @throws {RequiredError}
3145
+ */
3146
+ getAuthorizedProperties: async (orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3147
+ // verify required parameter 'orgId' is not null or undefined
3148
+ assertParamExists('getAuthorizedProperties', 'orgId', orgId)
3149
+ const localVarPath = `/orgs/{orgId}/getAuthorizedProperties`
3150
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
3151
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3152
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3153
+ let baseOptions;
3154
+ if (configuration) {
3155
+ baseOptions = configuration.baseOptions;
3156
+ }
3157
+
3158
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
3159
+ const localVarHeaderParameter = {} as any;
3160
+ const localVarQueryParameter = {} as any;
3161
+
3162
+ // authentication ApiKeyAuth required
3163
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3164
+
3165
+
3166
+
3167
+ localVarHeaderParameter['Content-Type'] = 'application/json';
3168
+
3169
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3170
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3171
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3172
+ localVarRequestOptions.data = serializeDataIfNeeded(getAuthorizedPropertiesRequest, localVarRequestOptions, configuration)
1531
3173
 
1532
3174
  return {
1533
3175
  url: toPathString(localVarUrlObj),
@@ -1538,111 +3180,284 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
1538
3180
  };
1539
3181
 
1540
3182
  /**
1541
- * AuthorizationApi - functional programming interface
3183
+ * AuthorizedEntitiesApi - functional programming interface
1542
3184
  * @export
1543
3185
  */
1544
- export const AuthorizationApiFp = function(configuration?: Configuration) {
1545
- const localVarAxiosParamCreator = AuthorizationApiAxiosParamCreator(configuration)
3186
+ export const AuthorizedEntitiesApiFp = function(configuration?: Configuration) {
3187
+ const localVarAxiosParamCreator = AuthorizedEntitiesApiAxiosParamCreator(configuration)
1546
3188
  return {
1547
3189
  /**
1548
- * Authenticate and authorize a user to perform an action
1549
- * @summary Authenticate and authorize Request
1550
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3190
+ * Get the authorized brands for a given org
3191
+ * @summary Get Authorized Brands
3192
+ * @param {string} orgId
3193
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
1551
3194
  * @param {*} [options] Override http request option.
1552
3195
  * @throws {RequiredError}
1553
3196
  */
1554
- async authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>> {
1555
- const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options);
3197
+ async getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedBrandsResponse>> {
3198
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthorizedBrands(orgId, getAuthorizedBrandsRequest, options);
1556
3199
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1557
- const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authenticateAndAuthorize']?.[localVarOperationServerIndex]?.url;
3200
+ const localVarOperationServerBasePath = operationServerMap['AuthorizedEntitiesApi.getAuthorizedBrands']?.[localVarOperationServerIndex]?.url;
1558
3201
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1559
3202
  },
1560
3203
  /**
1561
- * Check if a user is authorized to perform an action
1562
- * @summary Authorize Request
1563
- * @param {AuthorizationRequest} [authorizationRequest]
3204
+ * Get the authorized orgs for a given principal
3205
+ * @summary Get Authorized Orgs
3206
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
1564
3207
  * @param {*} [options] Override http request option.
1565
3208
  * @throws {RequiredError}
1566
3209
  */
1567
- async authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>> {
1568
- const localVarAxiosArgs = await localVarAxiosParamCreator.authorize(authorizationRequest, options);
3210
+ async getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedOrgsResponse>> {
3211
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthorizedOrgs(getAuthorizedOrgsRequest, options);
1569
3212
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1570
- const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authorize']?.[localVarOperationServerIndex]?.url;
3213
+ const localVarOperationServerBasePath = operationServerMap['AuthorizedEntitiesApi.getAuthorizedOrgs']?.[localVarOperationServerIndex]?.url;
3214
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3215
+ },
3216
+ /**
3217
+ * Get the authorized properties for a given org
3218
+ * @summary Get Authorized Properties
3219
+ * @param {string} orgId
3220
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
3221
+ * @param {*} [options] Override http request option.
3222
+ * @throws {RequiredError}
3223
+ */
3224
+ async getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedPropertiesResponse>> {
3225
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthorizedProperties(orgId, getAuthorizedPropertiesRequest, options);
3226
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3227
+ const localVarOperationServerBasePath = operationServerMap['AuthorizedEntitiesApi.getAuthorizedProperties']?.[localVarOperationServerIndex]?.url;
1571
3228
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1572
3229
  },
1573
3230
  }
1574
3231
  };
1575
3232
 
1576
3233
  /**
1577
- * AuthorizationApi - factory interface
3234
+ * AuthorizedEntitiesApi - factory interface
1578
3235
  * @export
1579
3236
  */
1580
- export const AuthorizationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1581
- const localVarFp = AuthorizationApiFp(configuration)
3237
+ export const AuthorizedEntitiesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
3238
+ const localVarFp = AuthorizedEntitiesApiFp(configuration)
1582
3239
  return {
1583
3240
  /**
1584
- * Authenticate and authorize a user to perform an action
1585
- * @summary Authenticate and authorize Request
1586
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3241
+ * Get the authorized brands for a given org
3242
+ * @summary Get Authorized Brands
3243
+ * @param {string} orgId
3244
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
1587
3245
  * @param {*} [options] Override http request option.
1588
3246
  * @throws {RequiredError}
1589
3247
  */
1590
- authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse> {
1591
- return localVarFp.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(axios, basePath));
3248
+ getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedBrandsResponse> {
3249
+ return localVarFp.getAuthorizedBrands(orgId, getAuthorizedBrandsRequest, options).then((request) => request(axios, basePath));
1592
3250
  },
1593
3251
  /**
1594
- * Check if a user is authorized to perform an action
1595
- * @summary Authorize Request
1596
- * @param {AuthorizationRequest} [authorizationRequest]
3252
+ * Get the authorized orgs for a given principal
3253
+ * @summary Get Authorized Orgs
3254
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
1597
3255
  * @param {*} [options] Override http request option.
1598
3256
  * @throws {RequiredError}
1599
3257
  */
1600
- authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationResponse> {
1601
- return localVarFp.authorize(authorizationRequest, options).then((request) => request(axios, basePath));
3258
+ getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedOrgsResponse> {
3259
+ return localVarFp.getAuthorizedOrgs(getAuthorizedOrgsRequest, options).then((request) => request(axios, basePath));
3260
+ },
3261
+ /**
3262
+ * Get the authorized properties for a given org
3263
+ * @summary Get Authorized Properties
3264
+ * @param {string} orgId
3265
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
3266
+ * @param {*} [options] Override http request option.
3267
+ * @throws {RequiredError}
3268
+ */
3269
+ getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedPropertiesResponse> {
3270
+ return localVarFp.getAuthorizedProperties(orgId, getAuthorizedPropertiesRequest, options).then((request) => request(axios, basePath));
1602
3271
  },
1603
3272
  };
1604
3273
  };
1605
3274
 
1606
3275
  /**
1607
- * AuthorizationApi - object-oriented interface
3276
+ * AuthorizedEntitiesApi - object-oriented interface
1608
3277
  * @export
1609
- * @class AuthorizationApi
3278
+ * @class AuthorizedEntitiesApi
1610
3279
  * @extends {BaseAPI}
1611
3280
  */
1612
- export class AuthorizationApi extends BaseAPI {
3281
+ export class AuthorizedEntitiesApi extends BaseAPI {
1613
3282
  /**
1614
- * Authenticate and authorize a user to perform an action
1615
- * @summary Authenticate and authorize Request
1616
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
3283
+ * Get the authorized brands for a given org
3284
+ * @summary Get Authorized Brands
3285
+ * @param {string} orgId
3286
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
1617
3287
  * @param {*} [options] Override http request option.
1618
3288
  * @throws {RequiredError}
1619
- * @memberof AuthorizationApi
3289
+ * @memberof AuthorizedEntitiesApi
1620
3290
  */
1621
- public authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) {
1622
- return AuthorizationApiFp(this.configuration).authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
3291
+ public getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig) {
3292
+ return AuthorizedEntitiesApiFp(this.configuration).getAuthorizedBrands(orgId, getAuthorizedBrandsRequest, options).then((request) => request(this.axios, this.basePath));
1623
3293
  }
1624
3294
 
1625
3295
  /**
1626
- * Check if a user is authorized to perform an action
1627
- * @summary Authorize Request
1628
- * @param {AuthorizationRequest} [authorizationRequest]
3296
+ * Get the authorized orgs for a given principal
3297
+ * @summary Get Authorized Orgs
3298
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
1629
3299
  * @param {*} [options] Override http request option.
1630
3300
  * @throws {RequiredError}
1631
- * @memberof AuthorizationApi
3301
+ * @memberof AuthorizedEntitiesApi
1632
3302
  */
1633
- public authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig) {
1634
- return AuthorizationApiFp(this.configuration).authorize(authorizationRequest, options).then((request) => request(this.axios, this.basePath));
3303
+ public getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig) {
3304
+ return AuthorizedEntitiesApiFp(this.configuration).getAuthorizedOrgs(getAuthorizedOrgsRequest, options).then((request) => request(this.axios, this.basePath));
3305
+ }
3306
+
3307
+ /**
3308
+ * Get the authorized properties for a given org
3309
+ * @summary Get Authorized Properties
3310
+ * @param {string} orgId
3311
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
3312
+ * @param {*} [options] Override http request option.
3313
+ * @throws {RequiredError}
3314
+ * @memberof AuthorizedEntitiesApi
3315
+ */
3316
+ public getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig) {
3317
+ return AuthorizedEntitiesApiFp(this.configuration).getAuthorizedProperties(orgId, getAuthorizedPropertiesRequest, options).then((request) => request(this.axios, this.basePath));
1635
3318
  }
1636
3319
  }
1637
3320
 
1638
3321
 
1639
3322
 
1640
- /**
1641
- * PermissionsApi - axios parameter creator
1642
- * @export
1643
- */
1644
- export const PermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
1645
- return {
3323
+ /**
3324
+ * ConfigurationDataApi - axios parameter creator
3325
+ * @export
3326
+ */
3327
+ export const ConfigurationDataApiAxiosParamCreator = function (configuration?: Configuration) {
3328
+ return {
3329
+ /**
3330
+ * List the available feature based roles
3331
+ * @summary List Feature Based Roles
3332
+ * @param {*} [options] Override http request option.
3333
+ * @throws {RequiredError}
3334
+ */
3335
+ configListFeatureBasedRoles: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3336
+ const localVarPath = `/config/featureBasedRoles`;
3337
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3338
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3339
+ let baseOptions;
3340
+ if (configuration) {
3341
+ baseOptions = configuration.baseOptions;
3342
+ }
3343
+
3344
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3345
+ const localVarHeaderParameter = {} as any;
3346
+ const localVarQueryParameter = {} as any;
3347
+
3348
+ // authentication ApiKeyAuth required
3349
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3350
+
3351
+
3352
+
3353
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3354
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3355
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3356
+
3357
+ return {
3358
+ url: toPathString(localVarUrlObj),
3359
+ options: localVarRequestOptions,
3360
+ };
3361
+ },
3362
+ /**
3363
+ * List the available permissions
3364
+ * @summary List Permissions
3365
+ * @param {*} [options] Override http request option.
3366
+ * @throws {RequiredError}
3367
+ */
3368
+ configListPermissions: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3369
+ const localVarPath = `/config/permissions`;
3370
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3371
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3372
+ let baseOptions;
3373
+ if (configuration) {
3374
+ baseOptions = configuration.baseOptions;
3375
+ }
3376
+
3377
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3378
+ const localVarHeaderParameter = {} as any;
3379
+ const localVarQueryParameter = {} as any;
3380
+
3381
+ // authentication ApiKeyAuth required
3382
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3383
+
3384
+
3385
+
3386
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3387
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3388
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3389
+
3390
+ return {
3391
+ url: toPathString(localVarUrlObj),
3392
+ options: localVarRequestOptions,
3393
+ };
3394
+ },
3395
+ /**
3396
+ * List the available roles
3397
+ * @summary List Roles
3398
+ * @param {*} [options] Override http request option.
3399
+ * @throws {RequiredError}
3400
+ */
3401
+ configListRoles: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3402
+ const localVarPath = `/config/roles`;
3403
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3404
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3405
+ let baseOptions;
3406
+ if (configuration) {
3407
+ baseOptions = configuration.baseOptions;
3408
+ }
3409
+
3410
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3411
+ const localVarHeaderParameter = {} as any;
3412
+ const localVarQueryParameter = {} as any;
3413
+
3414
+ // authentication ApiKeyAuth required
3415
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3416
+
3417
+
3418
+
3419
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3420
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3421
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3422
+
3423
+ return {
3424
+ url: toPathString(localVarUrlObj),
3425
+ options: localVarRequestOptions,
3426
+ };
3427
+ },
3428
+ /**
3429
+ * List the available feature based roles
3430
+ * @summary List Feature Based Roles
3431
+ * @param {*} [options] Override http request option.
3432
+ * @throws {RequiredError}
3433
+ */
3434
+ listFeatureBasedRoles: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3435
+ const localVarPath = `/featureBasedRoles`;
3436
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3437
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3438
+ let baseOptions;
3439
+ if (configuration) {
3440
+ baseOptions = configuration.baseOptions;
3441
+ }
3442
+
3443
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3444
+ const localVarHeaderParameter = {} as any;
3445
+ const localVarQueryParameter = {} as any;
3446
+
3447
+ // authentication ApiKeyAuth required
3448
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3449
+
3450
+
3451
+
3452
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3453
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3454
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3455
+
3456
+ return {
3457
+ url: toPathString(localVarUrlObj),
3458
+ options: localVarRequestOptions,
3459
+ };
3460
+ },
1646
3461
  /**
1647
3462
  * List the available permissions
1648
3463
  * @summary List Permissions
@@ -1667,6 +3482,39 @@ export const PermissionsApiAxiosParamCreator = function (configuration?: Configu
1667
3482
 
1668
3483
 
1669
3484
 
3485
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3486
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3487
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3488
+
3489
+ return {
3490
+ url: toPathString(localVarUrlObj),
3491
+ options: localVarRequestOptions,
3492
+ };
3493
+ },
3494
+ /**
3495
+ * List the available roles
3496
+ * @summary List Roles
3497
+ * @param {*} [options] Override http request option.
3498
+ * @throws {RequiredError}
3499
+ */
3500
+ listRoles: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3501
+ const localVarPath = `/roles`;
3502
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3503
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3504
+ let baseOptions;
3505
+ if (configuration) {
3506
+ baseOptions = configuration.baseOptions;
3507
+ }
3508
+
3509
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3510
+ const localVarHeaderParameter = {} as any;
3511
+ const localVarQueryParameter = {} as any;
3512
+
3513
+ // authentication ApiKeyAuth required
3514
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3515
+
3516
+
3517
+
1670
3518
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1671
3519
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1672
3520
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -1680,62 +3528,222 @@ export const PermissionsApiAxiosParamCreator = function (configuration?: Configu
1680
3528
  };
1681
3529
 
1682
3530
  /**
1683
- * PermissionsApi - functional programming interface
3531
+ * ConfigurationDataApi - functional programming interface
1684
3532
  * @export
1685
3533
  */
1686
- export const PermissionsApiFp = function(configuration?: Configuration) {
1687
- const localVarAxiosParamCreator = PermissionsApiAxiosParamCreator(configuration)
3534
+ export const ConfigurationDataApiFp = function(configuration?: Configuration) {
3535
+ const localVarAxiosParamCreator = ConfigurationDataApiAxiosParamCreator(configuration)
1688
3536
  return {
3537
+ /**
3538
+ * List the available feature based roles
3539
+ * @summary List Feature Based Roles
3540
+ * @param {*} [options] Override http request option.
3541
+ * @throws {RequiredError}
3542
+ */
3543
+ async configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>> {
3544
+ const localVarAxiosArgs = await localVarAxiosParamCreator.configListFeatureBasedRoles(options);
3545
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3546
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.configListFeatureBasedRoles']?.[localVarOperationServerIndex]?.url;
3547
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3548
+ },
3549
+ /**
3550
+ * List the available permissions
3551
+ * @summary List Permissions
3552
+ * @param {*} [options] Override http request option.
3553
+ * @throws {RequiredError}
3554
+ */
3555
+ async configListPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>> {
3556
+ const localVarAxiosArgs = await localVarAxiosParamCreator.configListPermissions(options);
3557
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3558
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.configListPermissions']?.[localVarOperationServerIndex]?.url;
3559
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3560
+ },
3561
+ /**
3562
+ * List the available roles
3563
+ * @summary List Roles
3564
+ * @param {*} [options] Override http request option.
3565
+ * @throws {RequiredError}
3566
+ */
3567
+ async configListRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>> {
3568
+ const localVarAxiosArgs = await localVarAxiosParamCreator.configListRoles(options);
3569
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3570
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.configListRoles']?.[localVarOperationServerIndex]?.url;
3571
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3572
+ },
3573
+ /**
3574
+ * List the available feature based roles
3575
+ * @summary List Feature Based Roles
3576
+ * @param {*} [options] Override http request option.
3577
+ * @throws {RequiredError}
3578
+ */
3579
+ async listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>> {
3580
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listFeatureBasedRoles(options);
3581
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3582
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.listFeatureBasedRoles']?.[localVarOperationServerIndex]?.url;
3583
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3584
+ },
1689
3585
  /**
1690
3586
  * List the available permissions
1691
3587
  * @summary List Permissions
1692
3588
  * @param {*} [options] Override http request option.
1693
3589
  * @throws {RequiredError}
1694
3590
  */
1695
- async listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPermissionsSuccessResponse>> {
3591
+ async listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>> {
1696
3592
  const localVarAxiosArgs = await localVarAxiosParamCreator.listPermissions(options);
1697
3593
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1698
- const localVarOperationServerBasePath = operationServerMap['PermissionsApi.listPermissions']?.[localVarOperationServerIndex]?.url;
3594
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.listPermissions']?.[localVarOperationServerIndex]?.url;
3595
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3596
+ },
3597
+ /**
3598
+ * List the available roles
3599
+ * @summary List Roles
3600
+ * @param {*} [options] Override http request option.
3601
+ * @throws {RequiredError}
3602
+ */
3603
+ async listRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>> {
3604
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listRoles(options);
3605
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3606
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.listRoles']?.[localVarOperationServerIndex]?.url;
1699
3607
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1700
3608
  },
1701
3609
  }
1702
3610
  };
1703
3611
 
1704
3612
  /**
1705
- * PermissionsApi - factory interface
3613
+ * ConfigurationDataApi - factory interface
1706
3614
  * @export
1707
3615
  */
1708
- export const PermissionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1709
- const localVarFp = PermissionsApiFp(configuration)
3616
+ export const ConfigurationDataApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
3617
+ const localVarFp = ConfigurationDataApiFp(configuration)
1710
3618
  return {
3619
+ /**
3620
+ * List the available feature based roles
3621
+ * @summary List Feature Based Roles
3622
+ * @param {*} [options] Override http request option.
3623
+ * @throws {RequiredError}
3624
+ */
3625
+ configListFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse> {
3626
+ return localVarFp.configListFeatureBasedRoles(options).then((request) => request(axios, basePath));
3627
+ },
3628
+ /**
3629
+ * List the available permissions
3630
+ * @summary List Permissions
3631
+ * @param {*} [options] Override http request option.
3632
+ * @throws {RequiredError}
3633
+ */
3634
+ configListPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse> {
3635
+ return localVarFp.configListPermissions(options).then((request) => request(axios, basePath));
3636
+ },
3637
+ /**
3638
+ * List the available roles
3639
+ * @summary List Roles
3640
+ * @param {*} [options] Override http request option.
3641
+ * @throws {RequiredError}
3642
+ */
3643
+ configListRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse> {
3644
+ return localVarFp.configListRoles(options).then((request) => request(axios, basePath));
3645
+ },
3646
+ /**
3647
+ * List the available feature based roles
3648
+ * @summary List Feature Based Roles
3649
+ * @param {*} [options] Override http request option.
3650
+ * @throws {RequiredError}
3651
+ */
3652
+ listFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse> {
3653
+ return localVarFp.listFeatureBasedRoles(options).then((request) => request(axios, basePath));
3654
+ },
1711
3655
  /**
1712
3656
  * List the available permissions
1713
3657
  * @summary List Permissions
1714
3658
  * @param {*} [options] Override http request option.
1715
3659
  * @throws {RequiredError}
1716
3660
  */
1717
- listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<GetPermissionsSuccessResponse> {
3661
+ listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse> {
1718
3662
  return localVarFp.listPermissions(options).then((request) => request(axios, basePath));
1719
3663
  },
3664
+ /**
3665
+ * List the available roles
3666
+ * @summary List Roles
3667
+ * @param {*} [options] Override http request option.
3668
+ * @throws {RequiredError}
3669
+ */
3670
+ listRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse> {
3671
+ return localVarFp.listRoles(options).then((request) => request(axios, basePath));
3672
+ },
1720
3673
  };
1721
3674
  };
1722
3675
 
1723
3676
  /**
1724
- * PermissionsApi - object-oriented interface
3677
+ * ConfigurationDataApi - object-oriented interface
1725
3678
  * @export
1726
- * @class PermissionsApi
3679
+ * @class ConfigurationDataApi
1727
3680
  * @extends {BaseAPI}
1728
3681
  */
1729
- export class PermissionsApi extends BaseAPI {
3682
+ export class ConfigurationDataApi extends BaseAPI {
3683
+ /**
3684
+ * List the available feature based roles
3685
+ * @summary List Feature Based Roles
3686
+ * @param {*} [options] Override http request option.
3687
+ * @throws {RequiredError}
3688
+ * @memberof ConfigurationDataApi
3689
+ */
3690
+ public configListFeatureBasedRoles(options?: RawAxiosRequestConfig) {
3691
+ return ConfigurationDataApiFp(this.configuration).configListFeatureBasedRoles(options).then((request) => request(this.axios, this.basePath));
3692
+ }
3693
+
3694
+ /**
3695
+ * List the available permissions
3696
+ * @summary List Permissions
3697
+ * @param {*} [options] Override http request option.
3698
+ * @throws {RequiredError}
3699
+ * @memberof ConfigurationDataApi
3700
+ */
3701
+ public configListPermissions(options?: RawAxiosRequestConfig) {
3702
+ return ConfigurationDataApiFp(this.configuration).configListPermissions(options).then((request) => request(this.axios, this.basePath));
3703
+ }
3704
+
3705
+ /**
3706
+ * List the available roles
3707
+ * @summary List Roles
3708
+ * @param {*} [options] Override http request option.
3709
+ * @throws {RequiredError}
3710
+ * @memberof ConfigurationDataApi
3711
+ */
3712
+ public configListRoles(options?: RawAxiosRequestConfig) {
3713
+ return ConfigurationDataApiFp(this.configuration).configListRoles(options).then((request) => request(this.axios, this.basePath));
3714
+ }
3715
+
3716
+ /**
3717
+ * List the available feature based roles
3718
+ * @summary List Feature Based Roles
3719
+ * @param {*} [options] Override http request option.
3720
+ * @throws {RequiredError}
3721
+ * @memberof ConfigurationDataApi
3722
+ */
3723
+ public listFeatureBasedRoles(options?: RawAxiosRequestConfig) {
3724
+ return ConfigurationDataApiFp(this.configuration).listFeatureBasedRoles(options).then((request) => request(this.axios, this.basePath));
3725
+ }
3726
+
1730
3727
  /**
1731
3728
  * List the available permissions
1732
3729
  * @summary List Permissions
1733
3730
  * @param {*} [options] Override http request option.
1734
3731
  * @throws {RequiredError}
1735
- * @memberof PermissionsApi
3732
+ * @memberof ConfigurationDataApi
1736
3733
  */
1737
3734
  public listPermissions(options?: RawAxiosRequestConfig) {
1738
- return PermissionsApiFp(this.configuration).listPermissions(options).then((request) => request(this.axios, this.basePath));
3735
+ return ConfigurationDataApiFp(this.configuration).listPermissions(options).then((request) => request(this.axios, this.basePath));
3736
+ }
3737
+
3738
+ /**
3739
+ * List the available roles
3740
+ * @summary List Roles
3741
+ * @param {*} [options] Override http request option.
3742
+ * @throws {RequiredError}
3743
+ * @memberof ConfigurationDataApi
3744
+ */
3745
+ public listRoles(options?: RawAxiosRequestConfig) {
3746
+ return ConfigurationDataApiFp(this.configuration).listRoles(options).then((request) => request(this.axios, this.basePath));
1739
3747
  }
1740
3748
  }
1741
3749
 
@@ -2102,6 +4110,80 @@ export class RoleAssignmentApi extends BaseAPI {
2102
4110
  */
2103
4111
  export const UserPermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
2104
4112
  return {
4113
+ /**
4114
+ * List the available permissions for the current user
4115
+ * @summary List Org Permissions
4116
+ * @param {string} orgId
4117
+ * @param {*} [options] Override http request option.
4118
+ * @throws {RequiredError}
4119
+ */
4120
+ listOrgPermissions: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
4121
+ // verify required parameter 'orgId' is not null or undefined
4122
+ assertParamExists('listOrgPermissions', 'orgId', orgId)
4123
+ const localVarPath = `/orgs/{orgId}/permissions`
4124
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
4125
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4126
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4127
+ let baseOptions;
4128
+ if (configuration) {
4129
+ baseOptions = configuration.baseOptions;
4130
+ }
4131
+
4132
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
4133
+ const localVarHeaderParameter = {} as any;
4134
+ const localVarQueryParameter = {} as any;
4135
+
4136
+ // authentication ApiKeyAuth required
4137
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4138
+
4139
+
4140
+
4141
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4142
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4143
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4144
+
4145
+ return {
4146
+ url: toPathString(localVarUrlObj),
4147
+ options: localVarRequestOptions,
4148
+ };
4149
+ },
4150
+ /**
4151
+ * List the available roles for the current user
4152
+ * @summary List Org Roles
4153
+ * @param {string} orgId
4154
+ * @param {*} [options] Override http request option.
4155
+ * @throws {RequiredError}
4156
+ */
4157
+ listOrgRoles: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
4158
+ // verify required parameter 'orgId' is not null or undefined
4159
+ assertParamExists('listOrgRoles', 'orgId', orgId)
4160
+ const localVarPath = `/orgs/{orgId}/roles`
4161
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
4162
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
4163
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
4164
+ let baseOptions;
4165
+ if (configuration) {
4166
+ baseOptions = configuration.baseOptions;
4167
+ }
4168
+
4169
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
4170
+ const localVarHeaderParameter = {} as any;
4171
+ const localVarQueryParameter = {} as any;
4172
+
4173
+ // authentication ApiKeyAuth required
4174
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
4175
+
4176
+
4177
+
4178
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
4179
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
4180
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
4181
+
4182
+ return {
4183
+ url: toPathString(localVarUrlObj),
4184
+ options: localVarRequestOptions,
4185
+ };
4186
+ },
2105
4187
  /**
2106
4188
  * List the available permissions for the current user
2107
4189
  * @summary List Own Permissions
@@ -2190,6 +4272,32 @@ export const UserPermissionsApiAxiosParamCreator = function (configuration?: Con
2190
4272
  export const UserPermissionsApiFp = function(configuration?: Configuration) {
2191
4273
  const localVarAxiosParamCreator = UserPermissionsApiAxiosParamCreator(configuration)
2192
4274
  return {
4275
+ /**
4276
+ * List the available permissions for the current user
4277
+ * @summary List Org Permissions
4278
+ * @param {string} orgId
4279
+ * @param {*} [options] Override http request option.
4280
+ * @throws {RequiredError}
4281
+ */
4282
+ async listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }; }>> {
4283
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listOrgPermissions(orgId, options);
4284
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4285
+ const localVarOperationServerBasePath = operationServerMap['UserPermissionsApi.listOrgPermissions']?.[localVarOperationServerIndex]?.url;
4286
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4287
+ },
4288
+ /**
4289
+ * List the available roles for the current user
4290
+ * @summary List Org Roles
4291
+ * @param {string} orgId
4292
+ * @param {*} [options] Override http request option.
4293
+ * @throws {RequiredError}
4294
+ */
4295
+ async listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: { [key: string]: ListOrgRolesSuccessResponseValueValue; }; }>> {
4296
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listOrgRoles(orgId, options);
4297
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
4298
+ const localVarOperationServerBasePath = operationServerMap['UserPermissionsApi.listOrgRoles']?.[localVarOperationServerIndex]?.url;
4299
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
4300
+ },
2193
4301
  /**
2194
4302
  * List the available permissions for the current user
2195
4303
  * @summary List Own Permissions
@@ -2227,6 +4335,26 @@ export const UserPermissionsApiFp = function(configuration?: Configuration) {
2227
4335
  export const UserPermissionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2228
4336
  const localVarFp = UserPermissionsApiFp(configuration)
2229
4337
  return {
4338
+ /**
4339
+ * List the available permissions for the current user
4340
+ * @summary List Org Permissions
4341
+ * @param {string} orgId
4342
+ * @param {*} [options] Override http request option.
4343
+ * @throws {RequiredError}
4344
+ */
4345
+ listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }; }> {
4346
+ return localVarFp.listOrgPermissions(orgId, options).then((request) => request(axios, basePath));
4347
+ },
4348
+ /**
4349
+ * List the available roles for the current user
4350
+ * @summary List Org Roles
4351
+ * @param {string} orgId
4352
+ * @param {*} [options] Override http request option.
4353
+ * @throws {RequiredError}
4354
+ */
4355
+ listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: { [key: string]: ListOrgRolesSuccessResponseValueValue; }; }> {
4356
+ return localVarFp.listOrgRoles(orgId, options).then((request) => request(axios, basePath));
4357
+ },
2230
4358
  /**
2231
4359
  * List the available permissions for the current user
2232
4360
  * @summary List Own Permissions
@@ -2258,6 +4386,30 @@ export const UserPermissionsApiFactory = function (configuration?: Configuration
2258
4386
  * @extends {BaseAPI}
2259
4387
  */
2260
4388
  export class UserPermissionsApi extends BaseAPI {
4389
+ /**
4390
+ * List the available permissions for the current user
4391
+ * @summary List Org Permissions
4392
+ * @param {string} orgId
4393
+ * @param {*} [options] Override http request option.
4394
+ * @throws {RequiredError}
4395
+ * @memberof UserPermissionsApi
4396
+ */
4397
+ public listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig) {
4398
+ return UserPermissionsApiFp(this.configuration).listOrgPermissions(orgId, options).then((request) => request(this.axios, this.basePath));
4399
+ }
4400
+
4401
+ /**
4402
+ * List the available roles for the current user
4403
+ * @summary List Org Roles
4404
+ * @param {string} orgId
4405
+ * @param {*} [options] Override http request option.
4406
+ * @throws {RequiredError}
4407
+ * @memberof UserPermissionsApi
4408
+ */
4409
+ public listOrgRoles(orgId: string, options?: RawAxiosRequestConfig) {
4410
+ return UserPermissionsApiFp(this.configuration).listOrgRoles(orgId, options).then((request) => request(this.axios, this.basePath));
4411
+ }
4412
+
2261
4413
  /**
2262
4414
  * List the available permissions for the current user
2263
4415
  * @summary List Own Permissions