@flipdish/authorization 0.0.3 → 0.0.4-rc.1766093992

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}
@@ -169,7 +169,21 @@ export interface AuthenticateAndAuthorizeRequest {
169
169
  * @memberof AuthenticateAndAuthorizeRequest
170
170
  */
171
171
  'resource'?: AuthorizationRequestResource;
172
+ /**
173
+ * How to check authorisation - any or all of the actions must be allowed
174
+ * @type {string}
175
+ * @memberof AuthenticateAndAuthorizeRequest
176
+ */
177
+ 'checkMode'?: AuthenticateAndAuthorizeRequestCheckModeEnum;
172
178
  }
179
+
180
+ export const AuthenticateAndAuthorizeRequestCheckModeEnum = {
181
+ Any: 'any',
182
+ All: 'all'
183
+ } as const;
184
+
185
+ export type AuthenticateAndAuthorizeRequestCheckModeEnum = typeof AuthenticateAndAuthorizeRequestCheckModeEnum[keyof typeof AuthenticateAndAuthorizeRequestCheckModeEnum];
186
+
173
187
  /**
174
188
  * Response containing the authentication and authorization decision
175
189
  * @export
@@ -178,10 +192,10 @@ export interface AuthenticateAndAuthorizeRequest {
178
192
  export interface AuthenticateAndAuthorizeResponse {
179
193
  /**
180
194
  *
181
- * @type {AuthenticateAndAuthorizeResponseAuthentication}
195
+ * @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
182
196
  * @memberof AuthenticateAndAuthorizeResponse
183
197
  */
184
- 'authentication': AuthenticateAndAuthorizeResponseAuthentication;
198
+ 'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
185
199
  /**
186
200
  *
187
201
  * @type {AuthorizationResponse}
@@ -192,30 +206,166 @@ export interface AuthenticateAndAuthorizeResponse {
192
206
  /**
193
207
  *
194
208
  * @export
195
- * @interface AuthenticateAndAuthorizeResponseAuthentication
209
+ * @interface AuthenticateAndCheckIsInRoleRequest
210
+ */
211
+ export interface AuthenticateAndCheckIsInRoleRequest {
212
+ /**
213
+ * Incoming request headers to be used for authentication
214
+ * @type {{ [key: string]: string; }}
215
+ * @memberof AuthenticateAndCheckIsInRoleRequest
216
+ */
217
+ 'headers': { [key: string]: string; };
218
+ /**
219
+ * Array of roles to check if the principal is in
220
+ * @type {Array<RoleNames>}
221
+ * @memberof AuthenticateAndCheckIsInRoleRequest
222
+ */
223
+ 'roles': Array<RoleNames>;
224
+ /**
225
+ *
226
+ * @type {string}
227
+ * @memberof AuthenticateAndCheckIsInRoleRequest
228
+ */
229
+ 'checkMode'?: AuthenticateAndCheckIsInRoleRequestCheckModeEnum;
230
+ }
231
+
232
+ export const AuthenticateAndCheckIsInRoleRequestCheckModeEnum = {
233
+ Any: 'any',
234
+ All: 'all'
235
+ } as const;
236
+
237
+ export type AuthenticateAndCheckIsInRoleRequestCheckModeEnum = typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum];
238
+
239
+ /**
240
+ * Response containing whether the principal is in any/all of the roles
241
+ * @export
242
+ * @interface AuthenticateAndCheckIsInRoleResponse
243
+ */
244
+ export interface AuthenticateAndCheckIsInRoleResponse {
245
+ /**
246
+ *
247
+ * @type {AuthenticateAndCheckIsInRoleResponseAuthentication}
248
+ * @memberof AuthenticateAndCheckIsInRoleResponse
249
+ */
250
+ 'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication;
251
+ /**
252
+ * result of the check - whether the principal is in any/all of the roles
253
+ * @type {boolean}
254
+ * @memberof AuthenticateAndCheckIsInRoleResponse
255
+ */
256
+ 'authorized': boolean;
257
+ }
258
+ /**
259
+ *
260
+ * @export
261
+ * @interface AuthenticateAndCheckIsInRoleResponseAuthentication
196
262
  */
197
- export interface AuthenticateAndAuthorizeResponseAuthentication {
263
+ export interface AuthenticateAndCheckIsInRoleResponseAuthentication {
198
264
  /**
199
265
  *
200
266
  * @type {AuthorizationRequestPrincipal}
201
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
267
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
202
268
  */
203
269
  'principal': AuthorizationRequestPrincipal;
204
270
  /**
205
271
  * Whether the user is authenticated
206
272
  * @type {boolean}
207
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
273
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
208
274
  */
209
275
  'authenticated': boolean;
210
276
  /**
211
277
  * The reason for the authentication failure
212
278
  * @type {string}
213
- * @memberof AuthenticateAndAuthorizeResponseAuthentication
279
+ * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication
214
280
  */
215
281
  'reason'?: string;
216
282
  }
217
283
  /**
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.
284
+ *
285
+ * @export
286
+ * @interface AuthorizationBatchRequest
287
+ */
288
+ export interface AuthorizationBatchRequest {
289
+ /**
290
+ *
291
+ * @type {AuthorizationRequestPrincipal}
292
+ * @memberof AuthorizationBatchRequest
293
+ */
294
+ 'principal': AuthorizationRequestPrincipal;
295
+ /**
296
+ *
297
+ * @type {Permissions}
298
+ * @memberof AuthorizationBatchRequest
299
+ */
300
+ 'action': Permissions;
301
+ /**
302
+ * Array of resources to check authorisation for
303
+ * @type {Array<AuthorizationRequestResource>}
304
+ * @memberof AuthorizationBatchRequest
305
+ */
306
+ 'resources': Array<AuthorizationRequestResource>;
307
+ }
308
+
309
+
310
+ /**
311
+ *
312
+ * @export
313
+ * @interface AuthorizationBatchResponse
314
+ */
315
+ export interface AuthorizationBatchResponse {
316
+ /**
317
+ * Array of allowed resources
318
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
319
+ * @memberof AuthorizationBatchResponse
320
+ */
321
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
322
+ /**
323
+ * Array of denied resources
324
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
325
+ * @memberof AuthorizationBatchResponse
326
+ */
327
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
328
+ }
329
+ /**
330
+ *
331
+ * @export
332
+ * @interface AuthorizationBatchResponseAllowedResourcesInner
333
+ */
334
+ export interface AuthorizationBatchResponseAllowedResourcesInner {
335
+ /**
336
+ * The authorization decision
337
+ * @type {string}
338
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
339
+ */
340
+ 'decision': string;
341
+ /**
342
+ * Whether the action is allowed
343
+ * @type {boolean}
344
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
345
+ */
346
+ 'allowed': boolean;
347
+ /**
348
+ * The policy IDs that were used to make the decision
349
+ * @type {Array<string>}
350
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
351
+ */
352
+ 'policyIds': Array<string>;
353
+ /**
354
+ *
355
+ * @type {AuthorizationBatchResponseAllowedResourcesInnerResource}
356
+ * @memberof AuthorizationBatchResponseAllowedResourcesInner
357
+ */
358
+ 'resource': AuthorizationBatchResponseAllowedResourcesInnerResource;
359
+ }
360
+ /**
361
+ * @type AuthorizationBatchResponseAllowedResourcesInnerResource
362
+ * Resource that the action was checked for
363
+ * @export
364
+ */
365
+ export type AuthorizationBatchResponseAllowedResourcesInnerResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3;
366
+
367
+ /**
368
+ * 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 the checkMode - any or all of the permissions must be allowed).
219
369
  * @export
220
370
  * @interface AuthorizationRequest
221
371
  */
@@ -238,9 +388,23 @@ export interface AuthorizationRequest {
238
388
  * @memberof AuthorizationRequest
239
389
  */
240
390
  'resource'?: AuthorizationRequestResource;
391
+ /**
392
+ * How to check authorisation - any or all of the actions must be allowed
393
+ * @type {string}
394
+ * @memberof AuthorizationRequest
395
+ */
396
+ 'checkMode'?: AuthorizationRequestCheckModeEnum;
241
397
  }
398
+
399
+ export const AuthorizationRequestCheckModeEnum = {
400
+ Any: 'any',
401
+ All: 'all'
402
+ } as const;
403
+
404
+ export type AuthorizationRequestCheckModeEnum = typeof AuthorizationRequestCheckModeEnum[keyof typeof AuthorizationRequestCheckModeEnum];
405
+
242
406
  /**
243
- *
407
+ * Permission or array of permissions - note that you still only receive a single allow / deny response (calculated based on the checkMode)
244
408
  * @export
245
409
  * @interface AuthorizationRequestAction
246
410
  */
@@ -440,17 +604,206 @@ export interface ErrorResponse {
440
604
  'message': string;
441
605
  }
442
606
  /**
443
- * Successful permissions retrieval response
607
+ * Feature based role and its permissions
608
+ * @export
609
+ * @interface FeatureBasedRole
610
+ */
611
+ export interface FeatureBasedRole {
612
+ /**
613
+ * Name of the role
614
+ * @type {string}
615
+ * @memberof FeatureBasedRole
616
+ */
617
+ 'name': string;
618
+ /**
619
+ *
620
+ * @type {Permissions & Array<Permissions>}
621
+ * @memberof FeatureBasedRole
622
+ */
623
+ 'permissions': Permissions & Array<Permissions>;
624
+ }
625
+ /**
626
+ * 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.
627
+ * @export
628
+ * @interface GetAuthorizedBrandsRequest
629
+ */
630
+ export interface GetAuthorizedBrandsRequest {
631
+ /**
632
+ *
633
+ * @type {GetAuthorizedOrgsRequestPrincipal}
634
+ * @memberof GetAuthorizedBrandsRequest
635
+ */
636
+ 'principal'?: GetAuthorizedOrgsRequestPrincipal;
637
+ /**
638
+ * Incoming request headers to be used for authentication
639
+ * @type {{ [key: string]: string; }}
640
+ * @memberof GetAuthorizedBrandsRequest
641
+ */
642
+ 'headers'?: { [key: string]: string; };
643
+ /**
644
+ *
645
+ * @type {Permissions}
646
+ * @memberof GetAuthorizedBrandsRequest
647
+ */
648
+ 'action': Permissions;
649
+ }
650
+
651
+
652
+ /**
653
+ * Response containing the authorized brands
654
+ * @export
655
+ * @interface GetAuthorizedBrandsResponse
656
+ */
657
+ export interface GetAuthorizedBrandsResponse {
658
+ /**
659
+ * Array of allowed resources
660
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
661
+ * @memberof GetAuthorizedBrandsResponse
662
+ */
663
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
664
+ /**
665
+ * Array of denied resources
666
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
667
+ * @memberof GetAuthorizedBrandsResponse
668
+ */
669
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
670
+ }
671
+ /**
672
+ * 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.
673
+ * @export
674
+ * @interface GetAuthorizedOrgsRequest
675
+ */
676
+ export interface GetAuthorizedOrgsRequest {
677
+ /**
678
+ *
679
+ * @type {GetAuthorizedOrgsRequestPrincipal}
680
+ * @memberof GetAuthorizedOrgsRequest
681
+ */
682
+ 'principal'?: GetAuthorizedOrgsRequestPrincipal;
683
+ /**
684
+ * Incoming request headers to be used for authentication
685
+ * @type {{ [key: string]: string; }}
686
+ * @memberof GetAuthorizedOrgsRequest
687
+ */
688
+ 'headers'?: { [key: string]: string; };
689
+ /**
690
+ *
691
+ * @type {Permissions}
692
+ * @memberof GetAuthorizedOrgsRequest
693
+ */
694
+ 'action': Permissions;
695
+ }
696
+
697
+
698
+ /**
699
+ * The principal to get authorized entities for
700
+ * @export
701
+ * @interface GetAuthorizedOrgsRequestPrincipal
702
+ */
703
+ export interface GetAuthorizedOrgsRequestPrincipal {
704
+ /**
705
+ *
706
+ * @type {string}
707
+ * @memberof GetAuthorizedOrgsRequestPrincipal
708
+ */
709
+ 'type': GetAuthorizedOrgsRequestPrincipalTypeEnum;
710
+ /**
711
+ *
712
+ * @type {string}
713
+ * @memberof GetAuthorizedOrgsRequestPrincipal
714
+ */
715
+ 'id': string;
716
+ /**
717
+ *
718
+ * @type {string}
719
+ * @memberof GetAuthorizedOrgsRequestPrincipal
720
+ */
721
+ 'name'?: string;
722
+ /**
723
+ *
724
+ * @type {string}
725
+ * @memberof GetAuthorizedOrgsRequestPrincipal
726
+ */
727
+ 'email'?: string;
728
+ /**
729
+ *
730
+ * @type {string}
731
+ * @memberof GetAuthorizedOrgsRequestPrincipal
732
+ */
733
+ 'phone'?: string;
734
+ }
735
+
736
+ export const GetAuthorizedOrgsRequestPrincipalTypeEnum = {
737
+ User: 'User',
738
+ Automation: 'Automation'
739
+ } as const;
740
+
741
+ export type GetAuthorizedOrgsRequestPrincipalTypeEnum = typeof GetAuthorizedOrgsRequestPrincipalTypeEnum[keyof typeof GetAuthorizedOrgsRequestPrincipalTypeEnum];
742
+
743
+ /**
744
+ * Response containing the authorized orgs
745
+ * @export
746
+ * @interface GetAuthorizedOrgsResponse
747
+ */
748
+ export interface GetAuthorizedOrgsResponse {
749
+ /**
750
+ * Array of allowed resources
751
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
752
+ * @memberof GetAuthorizedOrgsResponse
753
+ */
754
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
755
+ /**
756
+ * Array of denied resources
757
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
758
+ * @memberof GetAuthorizedOrgsResponse
759
+ */
760
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
761
+ }
762
+ /**
763
+ * 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.
444
764
  * @export
445
- * @interface GetPermissionsSuccessResponse
765
+ * @interface GetAuthorizedPropertiesRequest
446
766
  */
447
- export interface GetPermissionsSuccessResponse {
767
+ export interface GetAuthorizedPropertiesRequest {
768
+ /**
769
+ *
770
+ * @type {GetAuthorizedOrgsRequestPrincipal}
771
+ * @memberof GetAuthorizedPropertiesRequest
772
+ */
773
+ 'principal'?: GetAuthorizedOrgsRequestPrincipal;
774
+ /**
775
+ * Incoming request headers to be used for authentication
776
+ * @type {{ [key: string]: string; }}
777
+ * @memberof GetAuthorizedPropertiesRequest
778
+ */
779
+ 'headers'?: { [key: string]: string; };
448
780
  /**
449
781
  *
450
- * @type {Permissions & Array<string>}
451
- * @memberof GetPermissionsSuccessResponse
782
+ * @type {Permissions}
783
+ * @memberof GetAuthorizedPropertiesRequest
784
+ */
785
+ 'action': Permissions;
786
+ }
787
+
788
+
789
+ /**
790
+ * Response containing the authorized properties
791
+ * @export
792
+ * @interface GetAuthorizedPropertiesResponse
793
+ */
794
+ export interface GetAuthorizedPropertiesResponse {
795
+ /**
796
+ * Array of allowed resources
797
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
798
+ * @memberof GetAuthorizedPropertiesResponse
452
799
  */
453
- 'permissions': Permissions & Array<string>;
800
+ 'allowedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
801
+ /**
802
+ * Array of denied resources
803
+ * @type {Array<AuthorizationBatchResponseAllowedResourcesInner>}
804
+ * @memberof GetAuthorizedPropertiesResponse
805
+ */
806
+ 'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
454
807
  }
455
808
  /**
456
809
  * Details for getting roles for a principal
@@ -525,7 +878,7 @@ export interface GetPrincipalRolesSuccessResponseRolesInner {
525
878
  * @type {string}
526
879
  * @memberof GetPrincipalRolesSuccessResponseRolesInner
527
880
  */
528
- 'resourceType': GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
881
+ 'resourceType'?: GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum;
529
882
  /**
530
883
  * Organization ID
531
884
  * @type {string}
@@ -550,13 +903,26 @@ export interface GetPrincipalRolesSuccessResponseRolesInner {
550
903
  * @memberof GetPrincipalRolesSuccessResponseRolesInner
551
904
  */
552
905
  'salesChannelId'?: string;
906
+ /**
907
+ * Principal ID this role is assigned to
908
+ * @type {string}
909
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
910
+ */
911
+ 'principalId': string;
912
+ /**
913
+ * Type of principal this role is assigned to
914
+ * @type {string}
915
+ * @memberof GetPrincipalRolesSuccessResponseRolesInner
916
+ */
917
+ 'principalType': GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum;
553
918
  }
554
919
 
555
920
  export const GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = {
556
921
  Main: 'Main',
557
922
  BrandOverride: 'BrandOverride',
558
923
  OrgOverride: 'OrgOverride',
559
- Forbidden: 'Forbidden'
924
+ Forbidden: 'Forbidden',
925
+ NamedRole: 'NamedRole'
560
926
  } as const;
561
927
 
562
928
  export type GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPolicyTypeEnum];
@@ -568,6 +934,12 @@ export const GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = {
568
934
  } as const;
569
935
 
570
936
  export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum];
937
+ export const GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum = {
938
+ User: 'User',
939
+ Automation: 'Automation'
940
+ } as const;
941
+
942
+ export type GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum = typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum[keyof typeof GetPrincipalRolesSuccessResponseRolesInnerPrincipalTypeEnum];
571
943
 
572
944
  /**
573
945
  * Role name
@@ -576,19 +948,6 @@ export type GetPrincipalRolesSuccessResponseRolesInnerResourceTypeEnum = typeof
576
948
  */
577
949
  export interface GetPrincipalRolesSuccessResponseRolesInnerRoleName {
578
950
  }
579
- /**
580
- * Successful roles retrieval response
581
- * @export
582
- * @interface GetRolesSuccessResponse
583
- */
584
- export interface GetRolesSuccessResponse {
585
- /**
586
- * List of roles available and their permissions
587
- * @type {Array<RolesInner>}
588
- * @memberof GetRolesSuccessResponse
589
- */
590
- 'roles': Array<RolesInner>;
591
- }
592
951
  /**
593
952
  * Successful user permissions retrieval response
594
953
  * @export
@@ -622,10 +981,10 @@ export interface GetUserPermissionsSuccessResponseResourcesValue {
622
981
  'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
623
982
  /**
624
983
  * List of permissions that are assigned to the user for the resource
625
- * @type {Array<string>}
984
+ * @type {Array<Permissions>}
626
985
  * @memberof GetUserPermissionsSuccessResponseResourcesValue
627
986
  */
628
- 'permissions': Array<GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum>;
987
+ 'permissions': Array<Permissions>;
629
988
  }
630
989
 
631
990
  export const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = {
@@ -636,33 +995,243 @@ export const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = {
636
995
  } as const;
637
996
 
638
997
  export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum];
639
- export const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = {
640
- AnyAuditLogs: 'AnyAuditLogs',
641
- ViewApp: 'ViewApp',
642
- CreateApp: 'CreateApp',
643
- UpdateApp: 'UpdateApp',
644
- ViewAppName: 'ViewAppName',
645
- EditAppAssets: 'EditAppAssets',
646
- EditAppFeatures: 'EditAppFeatures',
647
- ViewTeammates: 'ViewTeammates',
648
- EditTeammates: 'EditTeammates',
649
- CreateTeammateOwner: 'CreateTeammateOwner',
650
- CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
651
- CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
652
- CreateTeammateStoreManager: 'CreateTeammateStoreManager',
653
- CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
654
- CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
655
- CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
656
- CreateTeammateIntegrator: 'CreateTeammateIntegrator',
657
- CreateTeammateOnboarding: 'CreateTeammateOnboarding',
658
- CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
659
- CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
660
- ViewApmConfigurations: 'ViewApmConfigurations',
661
- EditApmConfigurations: 'EditApmConfigurations',
662
- ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
663
- CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
664
- UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
665
- DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
998
+
999
+ /**
1000
+ * ID of the resource the permissions are assigned to
1001
+ * @export
1002
+ * @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
1003
+ */
1004
+ export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
1005
+ }
1006
+ /**
1007
+ *
1008
+ * @export
1009
+ * @interface IsInRoleRequest
1010
+ */
1011
+ export interface IsInRoleRequest {
1012
+ /**
1013
+ *
1014
+ * @type {AuthorizationRequestPrincipal}
1015
+ * @memberof IsInRoleRequest
1016
+ */
1017
+ 'principal': AuthorizationRequestPrincipal;
1018
+ /**
1019
+ * Array of roles to check if the principal is in
1020
+ * @type {Array<RoleNames>}
1021
+ * @memberof IsInRoleRequest
1022
+ */
1023
+ 'roles': Array<RoleNames>;
1024
+ /**
1025
+ * How to check authorisation - any or all of the actions must be allowed
1026
+ * @type {string}
1027
+ * @memberof IsInRoleRequest
1028
+ */
1029
+ 'checkMode'?: IsInRoleRequestCheckModeEnum;
1030
+ }
1031
+
1032
+ export const IsInRoleRequestCheckModeEnum = {
1033
+ Any: 'any',
1034
+ All: 'all'
1035
+ } as const;
1036
+
1037
+ export type IsInRoleRequestCheckModeEnum = typeof IsInRoleRequestCheckModeEnum[keyof typeof IsInRoleRequestCheckModeEnum];
1038
+
1039
+ /**
1040
+ * Response containing whether the principal is in any/all of the roles
1041
+ * @export
1042
+ * @interface IsInRoleResponse
1043
+ */
1044
+ export interface IsInRoleResponse {
1045
+ /**
1046
+ * result of the check - whether the principal is in any/all of the roles
1047
+ * @type {boolean}
1048
+ * @memberof IsInRoleResponse
1049
+ */
1050
+ 'authorized': boolean;
1051
+ }
1052
+ /**
1053
+ * Successful feature based roles retrieval response
1054
+ * @export
1055
+ * @interface ListFeatureBasedRolesSuccessResponse
1056
+ */
1057
+ export interface ListFeatureBasedRolesSuccessResponse {
1058
+ /**
1059
+ *
1060
+ * @type {Array<FeatureBasedRole>}
1061
+ * @memberof ListFeatureBasedRolesSuccessResponse
1062
+ */
1063
+ 'roles': Array<FeatureBasedRole>;
1064
+ }
1065
+ /**
1066
+ *
1067
+ * @export
1068
+ * @interface ListOrgRolesSuccessResponseValueValue
1069
+ */
1070
+ export interface ListOrgRolesSuccessResponseValueValue {
1071
+ /**
1072
+ * Type of resource the permissions are assigned to
1073
+ * @type {string}
1074
+ * @memberof ListOrgRolesSuccessResponseValueValue
1075
+ */
1076
+ 'resourceType': ListOrgRolesSuccessResponseValueValueResourceTypeEnum;
1077
+ /**
1078
+ *
1079
+ * @type {GetUserPermissionsSuccessResponseResourcesValueResourceId}
1080
+ * @memberof ListOrgRolesSuccessResponseValueValue
1081
+ */
1082
+ 'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId;
1083
+ /**
1084
+ * List of roles that are assigned to the user for the resource
1085
+ * @type {Array<string>}
1086
+ * @memberof ListOrgRolesSuccessResponseValueValue
1087
+ */
1088
+ 'roles': Array<ListOrgRolesSuccessResponseValueValueRolesEnum>;
1089
+ }
1090
+
1091
+ export const ListOrgRolesSuccessResponseValueValueResourceTypeEnum = {
1092
+ Property: 'Property',
1093
+ Org: 'Org',
1094
+ Brand: 'Brand',
1095
+ SalesChannel: 'SalesChannel'
1096
+ } as const;
1097
+
1098
+ export type ListOrgRolesSuccessResponseValueValueResourceTypeEnum = typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum[keyof typeof ListOrgRolesSuccessResponseValueValueResourceTypeEnum];
1099
+ export const ListOrgRolesSuccessResponseValueValueRolesEnum = {
1100
+ OrgViewer: 'OrgViewer',
1101
+ OrgManager: 'OrgManager',
1102
+ OrgAdmin: 'OrgAdmin',
1103
+ BrandViewer: 'BrandViewer',
1104
+ BrandManager: 'BrandManager',
1105
+ BrandAdmin: 'BrandAdmin',
1106
+ StoreViewer: 'StoreViewer',
1107
+ StoreEditor: 'StoreEditor',
1108
+ StoreManager: 'StoreManager',
1109
+ CustomerViewer: 'CustomerViewer',
1110
+ CustomerManager: 'CustomerManager',
1111
+ VoucherViewer: 'VoucherViewer',
1112
+ VoucherEditor: 'VoucherEditor',
1113
+ VoucherManager: 'VoucherManager',
1114
+ VoucherCampaignManager: 'VoucherCampaignManager',
1115
+ VoucherStatisticsViewer: 'VoucherStatisticsViewer',
1116
+ AnalyticsViewer: 'AnalyticsViewer',
1117
+ ReportsViewer: 'ReportsViewer',
1118
+ FinanceViewer: 'FinanceViewer',
1119
+ FinanceManager: 'FinanceManager',
1120
+ TeamViewer: 'TeamViewer',
1121
+ TeamManager: 'TeamManager',
1122
+ TeamAdmin: 'TeamAdmin',
1123
+ TechViewer: 'TechViewer',
1124
+ TechManager: 'TechManager',
1125
+ AppStoreViewer: 'AppStoreViewer',
1126
+ AppStoreManager: 'AppStoreManager',
1127
+ SalesChannelViewer: 'SalesChannelViewer',
1128
+ SalesChannelEditor: 'SalesChannelEditor',
1129
+ SalesChannelManager: 'SalesChannelManager',
1130
+ DeliveryViewer: 'DeliveryViewer',
1131
+ DeliveryManager: 'DeliveryManager',
1132
+ DriverManager: 'DriverManager',
1133
+ AuditViewer: 'AuditViewer',
1134
+ AuditManager: 'AuditManager',
1135
+ AccountsViewer: 'AccountsViewer',
1136
+ AccountsEditor: 'AccountsEditor',
1137
+ DocumentExplorerViewer: 'DocumentExplorerViewer',
1138
+ DocumentExplorerEditor: 'DocumentExplorerEditor',
1139
+ PayrollViewer: 'PayrollViewer',
1140
+ PayrollEditor: 'PayrollEditor',
1141
+ PropertyViewer: 'PropertyViewer',
1142
+ PropertyManager: 'PropertyManager',
1143
+ PropertyAdmin: 'PropertyAdmin',
1144
+ WebsiteContentEditor: 'WebsiteContentEditor',
1145
+ WebsiteContentViewer: 'WebsiteContentViewer',
1146
+ WebsiteTechViewer: 'WebsiteTechViewer',
1147
+ MenuViewer: 'MenuViewer',
1148
+ MenuEditor: 'MenuEditor',
1149
+ MenuManager: 'MenuManager',
1150
+ MenuMetaFieldManager: 'MenuMetaFieldManager',
1151
+ MenuMetaFieldEditor: 'MenuMetaFieldEditor',
1152
+ MenuMetaFieldViewer: 'MenuMetaFieldViewer',
1153
+ StoreDeliveryZoneManager: 'StoreDeliveryZoneManager',
1154
+ StoreDeliveryZoneEditor: 'StoreDeliveryZoneEditor',
1155
+ StoreDeliveryZoneViewer: 'StoreDeliveryZoneViewer',
1156
+ OrderFulfillmentManager: 'OrderFulfillmentManager',
1157
+ OrderManager: 'OrderManager',
1158
+ OrderEditor: 'OrderEditor',
1159
+ OrderViewer: 'OrderViewer',
1160
+ InventoryManager: 'InventoryManager',
1161
+ InventoryEditor: 'InventoryEditor',
1162
+ InventoryViewer: 'InventoryViewer',
1163
+ PaymentManager: 'PaymentManager',
1164
+ OnboardingManager: 'OnboardingManager',
1165
+ FeatureFlagManager: 'FeatureFlagManager',
1166
+ PropertyOwnerMisc: 'PropertyOwnerMisc',
1167
+ ManagedOwnerMisc: 'ManagedOwnerMisc',
1168
+ IntegratorMisc: 'IntegratorMisc',
1169
+ PropertyManagerMisc: 'PropertyManagerMisc',
1170
+ FinanceManagerMisc: 'FinanceManagerMisc',
1171
+ SupportMisc: 'SupportMisc'
1172
+ } as const;
1173
+
1174
+ export type ListOrgRolesSuccessResponseValueValueRolesEnum = typeof ListOrgRolesSuccessResponseValueValueRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueValueRolesEnum];
1175
+
1176
+ /**
1177
+ * Successful permissions retrieval response
1178
+ * @export
1179
+ * @interface ListPermissionsSuccessResponse
1180
+ */
1181
+ export interface ListPermissionsSuccessResponse {
1182
+ /**
1183
+ *
1184
+ * @type {Permissions & Array<Permissions>}
1185
+ * @memberof ListPermissionsSuccessResponse
1186
+ */
1187
+ 'permissions': Permissions & Array<Permissions>;
1188
+ }
1189
+ /**
1190
+ * Successful roles retrieval response
1191
+ * @export
1192
+ * @interface ListRolesSuccessResponse
1193
+ */
1194
+ export interface ListRolesSuccessResponse {
1195
+ /**
1196
+ * List of named roles
1197
+ * @type {Array<RoleNames>}
1198
+ * @memberof ListRolesSuccessResponse
1199
+ */
1200
+ 'roles': Array<RoleNames>;
1201
+ }
1202
+ /**
1203
+ * Permissions
1204
+ * @export
1205
+ * @enum {string}
1206
+ */
1207
+
1208
+ export const Permissions = {
1209
+ AnyAuditLogs: 'AnyAuditLogs',
1210
+ ViewApp: 'ViewApp',
1211
+ CreateApp: 'CreateApp',
1212
+ UpdateApp: 'UpdateApp',
1213
+ ViewAppName: 'ViewAppName',
1214
+ EditAppAssets: 'EditAppAssets',
1215
+ EditAppFeatures: 'EditAppFeatures',
1216
+ ViewTeammates: 'ViewTeammates',
1217
+ EditTeammates: 'EditTeammates',
1218
+ CreateTeammateOwner: 'CreateTeammateOwner',
1219
+ CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
1220
+ CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
1221
+ CreateTeammateStoreManager: 'CreateTeammateStoreManager',
1222
+ CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
1223
+ CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
1224
+ CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
1225
+ CreateTeammateIntegrator: 'CreateTeammateIntegrator',
1226
+ CreateTeammateOnboarding: 'CreateTeammateOnboarding',
1227
+ CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
1228
+ CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
1229
+ ViewApmConfigurations: 'ViewApmConfigurations',
1230
+ EditApmConfigurations: 'EditApmConfigurations',
1231
+ ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
1232
+ CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
1233
+ UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
1234
+ DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
666
1235
  StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
667
1236
  ViewDevelopersSettings: 'ViewDevelopersSettings',
668
1237
  EditDevelopersSettings: 'EditDevelopersSettings',
@@ -860,502 +1429,762 @@ export const GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = {
860
1429
  EditEntityFeatureFlags: 'EditEntityFeatureFlags',
861
1430
  CreateOrg: 'CreateOrg',
862
1431
  EditOrg: 'EditOrg',
863
- ViewOrg: 'ViewOrg'
1432
+ ViewOrg: 'ViewOrg',
1433
+ ViewWebhooks: 'ViewWebhooks',
1434
+ EditWebhooks: 'EditWebhooks',
1435
+ RoleAdmin: 'RoleAdmin',
1436
+ RoleFactory: 'RoleFactory'
864
1437
  } as const;
865
1438
 
866
- export type GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum = typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValuePermissionsEnum];
1439
+ export type Permissions = typeof Permissions[keyof typeof Permissions];
1440
+
867
1441
 
868
1442
  /**
869
- * ID of the resource the permissions are assigned to
1443
+ * Principals in org
870
1444
  * @export
871
- * @interface GetUserPermissionsSuccessResponseResourcesValueResourceId
1445
+ * @interface PrincipalsInOrgResponse
872
1446
  */
873
- export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
1447
+ export interface PrincipalsInOrgResponse {
1448
+ /**
1449
+ *
1450
+ * @type {string}
1451
+ * @memberof PrincipalsInOrgResponse
1452
+ */
1453
+ 'orgId': string;
1454
+ /**
1455
+ * List of principals in org
1456
+ * @type {Array<AuthorizationRequestPrincipal>}
1457
+ * @memberof PrincipalsInOrgResponse
1458
+ */
1459
+ 'principals': Array<AuthorizationRequestPrincipal>;
874
1460
  }
875
1461
  /**
876
- *
1462
+ * Details for revoking a forbidden role from a principal
877
1463
  * @export
878
- * @interface OrgPathParam
1464
+ * @interface RevokeForbiddenRoleRequestBody
879
1465
  */
880
- export interface OrgPathParam {
1466
+ export interface RevokeForbiddenRoleRequestBody {
881
1467
  /**
882
1468
  *
1469
+ * @type {AuthorizationRequestPrincipal}
1470
+ * @memberof RevokeForbiddenRoleRequestBody
1471
+ */
1472
+ 'principal': AuthorizationRequestPrincipal;
1473
+ /**
1474
+ * Compensation role to revoke the forbidden role from
883
1475
  * @type {string}
884
- * @memberof OrgPathParam
1476
+ * @memberof RevokeForbiddenRoleRequestBody
885
1477
  */
886
- 'orgId': string;
1478
+ 'compensatingRole': RevokeForbiddenRoleRequestBodyCompensatingRoleEnum;
887
1479
  }
1480
+
1481
+ export const RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = {
1482
+ OwnerCompensating: 'OwnerCompensating',
1483
+ PropertyOwnerCompensating: 'PropertyOwnerCompensating',
1484
+ ManagedOwnerCompensating: 'ManagedOwnerCompensating',
1485
+ IntegratorCompensating: 'IntegratorCompensating',
1486
+ PropertyManagerCompensating: 'PropertyManagerCompensating',
1487
+ FinanceManagerCompensating: 'FinanceManagerCompensating'
1488
+ } as const;
1489
+
1490
+ export type RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum[keyof typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum];
1491
+
888
1492
  /**
889
- *
1493
+ * Details for revoking a role from a principal
890
1494
  * @export
891
- * @interface PathParams
1495
+ * @interface RevokeRoleRequestBody
892
1496
  */
893
- export interface PathParams {
1497
+ export interface RevokeRoleRequestBody {
894
1498
  /**
895
1499
  *
896
1500
  * @type {string}
897
- * @memberof PathParams
1501
+ * @memberof RevokeRoleRequestBody
898
1502
  */
899
- 'orgId': string;
1503
+ 'role': RevokeRoleRequestBodyRoleEnum;
1504
+ /**
1505
+ *
1506
+ * @type {AuthorizationRequestResource}
1507
+ * @memberof RevokeRoleRequestBody
1508
+ */
1509
+ 'resource': AuthorizationRequestResource;
1510
+ /**
1511
+ *
1512
+ * @type {AuthorizationRequestPrincipal}
1513
+ * @memberof RevokeRoleRequestBody
1514
+ */
1515
+ 'principal': AuthorizationRequestPrincipal;
900
1516
  /**
901
1517
  *
902
1518
  * @type {string}
903
- * @memberof PathParams
1519
+ * @memberof RevokeRoleRequestBody
904
1520
  */
905
- 'userId': string;
1521
+ 'brandId': string;
906
1522
  }
907
- /**
908
- *
909
- * @export
910
- * @enum {string}
911
- */
912
1523
 
913
- export const Permissions = {
914
- AnyAuditLogs: 'AnyAuditLogs',
915
- ViewApp: 'ViewApp',
916
- CreateApp: 'CreateApp',
917
- UpdateApp: 'UpdateApp',
918
- ViewAppName: 'ViewAppName',
919
- EditAppAssets: 'EditAppAssets',
920
- EditAppFeatures: 'EditAppFeatures',
921
- ViewTeammates: 'ViewTeammates',
922
- EditTeammates: 'EditTeammates',
923
- CreateTeammateOwner: 'CreateTeammateOwner',
924
- CreateTeammateManagedOwner: 'CreateTeammateManagedOwner',
925
- CreateTeammateStoreOwner: 'CreateTeammateStoreOwner',
926
- CreateTeammateStoreManager: 'CreateTeammateStoreManager',
927
- CreateTeammateStoreStaff: 'CreateTeammateStoreStaff',
928
- CreateTeammateStoreReadAccess: 'CreateTeammateStoreReadAccess',
929
- CreateTeammateFinanceManager: 'CreateTeammateFinanceManager',
930
- CreateTeammateIntegrator: 'CreateTeammateIntegrator',
931
- CreateTeammateOnboarding: 'CreateTeammateOnboarding',
932
- CreateTeammatePropertyManager: 'CreateTeammatePropertyManager',
933
- CreateTeammatePropertyOwner: 'CreateTeammatePropertyOwner',
934
- ViewApmConfigurations: 'ViewApmConfigurations',
935
- EditApmConfigurations: 'EditApmConfigurations',
936
- ViewCampaignsConfigurations: 'ViewCampaignsConfigurations',
937
- CreateCampaignsConfigurations: 'CreateCampaignsConfigurations',
938
- UpdateCampaignsConfigurations: 'UpdateCampaignsConfigurations',
939
- DeleteCampaignsConfigurations: 'DeleteCampaignsConfigurations',
940
- StampLoyaltyCardAgainstCampaignsConfigurations: 'StampLoyaltyCardAgainstCampaignsConfigurations',
941
- ViewDevelopersSettings: 'ViewDevelopersSettings',
942
- EditDevelopersSettings: 'EditDevelopersSettings',
943
- ViewOrders: 'ViewOrders',
944
- UpdateOrdersAccept: 'UpdateOrdersAccept',
945
- UpdateOrdersReject: 'UpdateOrdersReject',
946
- UpdateOrdersRefund: 'UpdateOrdersRefund',
947
- UpdateOrdersDispatch: 'UpdateOrdersDispatch',
948
- ViewStores: 'ViewStores',
949
- CreateStores: 'CreateStores',
950
- EditStores: 'EditStores',
951
- ViewStoresOpeningHours: 'ViewStoresOpeningHours',
952
- UpdateStoresOpenForCollectionOrDelivery: 'UpdateStoresOpenForCollectionOrDelivery',
953
- UpdateStoresOpeningHours: 'UpdateStoresOpeningHours',
954
- ViewStoresOpeningHoursOverride: 'ViewStoresOpeningHoursOverride',
955
- EditStoresOpeningHoursOverride: 'EditStoresOpeningHoursOverride',
956
- EditStoresOpeningHoursOverrideTemporary: 'EditStoresOpeningHoursOverrideTemporary',
957
- UpdateStoresName: 'UpdateStoresName',
958
- EditStoreKioskSettings: 'EditStoreKioskSettings',
959
- EditStoreOrderCapacity: 'EditStoreOrderCapacity',
960
- EditStoreNotifications: 'EditStoreNotifications',
961
- ArchiveStores: 'ArchiveStores',
962
- PublishStores: 'PublishStores',
963
- UpdatePrinterTerminalsAssign: 'UpdatePrinterTerminalsAssign',
964
- UpdatePrinterTerminalsToggle: 'UpdatePrinterTerminalsToggle',
965
- ViewStoreGroups: 'ViewStoreGroups',
966
- CreateStoreGroups: 'CreateStoreGroups',
967
- UpdateStoreGroups: 'UpdateStoreGroups',
968
- DeleteStoreGroups: 'DeleteStoreGroups',
969
- ViewDeliveryZones: 'ViewDeliveryZones',
970
- CreateDeliveryZones: 'CreateDeliveryZones',
971
- UpdateDeliveryZones: 'UpdateDeliveryZones',
972
- DeleteDeliveryZones: 'DeleteDeliveryZones',
973
- ViewMenu: 'ViewMenu',
974
- CreateMenu: 'CreateMenu',
975
- UpdateMenu: 'UpdateMenu',
976
- DeleteMenu: 'DeleteMenu',
977
- UpdateMenuLock: 'UpdateMenuLock',
978
- UpdateMenuItemsHideTemporarily: 'UpdateMenuItemsHideTemporarily',
979
- EditMenuImage: 'EditMenuImage',
980
- ViewVouchers: 'ViewVouchers',
981
- EditVouchers: 'EditVouchers',
982
- ViewWebsiteContent: 'ViewWebsiteContent',
983
- EditWebsiteContent: 'EditWebsiteContent',
984
- ViewWebsiteDnsVerified: 'ViewWebsiteDnsVerified',
985
- ViewWebsiteCertificateCreated: 'ViewWebsiteCertificateCreated',
986
- ViewWebsiteCertificateRenewed: 'ViewWebsiteCertificateRenewed',
987
- ViewBankAccounts: 'ViewBankAccounts',
988
- CreateBankAccounts: 'CreateBankAccounts',
989
- UpdateBankAccounts: 'UpdateBankAccounts',
990
- UpdateBankAccountsAssign: 'UpdateBankAccountsAssign',
991
- ViewAssignedBankAccount: 'ViewAssignedBankAccount',
992
- VerifyBankAccounts: 'VerifyBankAccounts',
993
- ViewServiceChargeConfigurations: 'ViewServiceChargeConfigurations',
994
- EditServiceChargeConfigurations: 'EditServiceChargeConfigurations',
995
- EditStoreDeliveryZoneFees: 'EditStoreDeliveryZoneFees',
996
- EditStoreDeliveryFeesLimited: 'EditStoreDeliveryFeesLimited',
997
- ViewHydraConfig: 'ViewHydraConfig',
998
- UpdateHydraConfigManage: 'UpdateHydraConfigManage',
999
- InitiateBluetoothPairingMode: 'InitiateBluetoothPairingMode',
1000
- DeleteTerminal: 'DeleteTerminal',
1001
- ViewKioskTelemetry: 'ViewKioskTelemetry',
1002
- ViewCustomers: 'ViewCustomers',
1003
- EditCustomers: 'EditCustomers',
1004
- CreateCustomers: 'CreateCustomers',
1005
- CreateCatalogElements: 'CreateCatalogElements',
1006
- UpdateCatalogElements: 'UpdateCatalogElements',
1007
- ViewCatalogElements: 'ViewCatalogElements',
1008
- DeleteCatalogElements: 'DeleteCatalogElements',
1009
- ViewMetafieldDefinitions: 'ViewMetafieldDefinitions',
1010
- CreateMetafieldDefinitions: 'CreateMetafieldDefinitions',
1011
- UpdateMetafieldDefinitions: 'UpdateMetafieldDefinitions',
1012
- DeleteMetafieldDefinitions: 'DeleteMetafieldDefinitions',
1013
- UpdateMetafields: 'UpdateMetafields',
1014
- ViewCatalogMenuChanges: 'ViewCatalogMenuChanges',
1015
- PublishCatalogMenuChanges: 'PublishCatalogMenuChanges',
1016
- ViewAppStatistics: 'ViewAppStatistics',
1017
- ViewApmStatistics: 'ViewApmStatistics',
1018
- ViewCampaignsStatistics: 'ViewCampaignsStatistics',
1019
- ViewCustomerStatistics: 'ViewCustomerStatistics',
1020
- ViewLiveStatistics: 'ViewLiveStatistics',
1021
- ViewOrderStatistics: 'ViewOrderStatistics',
1022
- ViewSalesStatistics: 'ViewSalesStatistics',
1023
- ViewSalesEndOfDayStatistics: 'ViewSalesEndOfDayStatistics',
1024
- ViewVouchersStatistics: 'ViewVouchersStatistics',
1025
- DownloadCustomerCsvExport: 'DownloadCustomerCsvExport',
1026
- ViewApmAuditLogs: 'ViewApmAuditLogs',
1027
- ViewStoreAuditLogs: 'ViewStoreAuditLogs',
1028
- ViewMenuAuditLogs: 'ViewMenuAuditLogs',
1029
- ViewBankAccountAuditLogs: 'ViewBankAccountAuditLogs',
1030
- ViewFeeConfigurationsAuditLogs: 'ViewFeeConfigurationsAuditLogs',
1031
- ViewOrdersAuditLogs: 'ViewOrdersAuditLogs',
1032
- ViewVouchersAuditLogs: 'ViewVouchersAuditLogs',
1033
- ViewUserEventsAuditLogs: 'ViewUserEventsAuditLogs',
1034
- ViewCampaignsAuditLogs: 'ViewCampaignsAuditLogs',
1035
- ViewTeammatesAuditLogs: 'ViewTeammatesAuditLogs',
1036
- ViewAppAuditLogs: 'ViewAppAuditLogs',
1037
- ViewCustomerAuditLogs: 'ViewCustomerAuditLogs',
1038
- ViewPrinterAuditLogs: 'ViewPrinterAuditLogs',
1039
- ViewHydraAuditLogs: 'ViewHydraAuditLogs',
1040
- ViewPushNotificationAuditLogs: 'ViewPushNotificationAuditLogs',
1041
- ViewStripeCustomConnectedAccountAuditLogs: 'ViewStripeCustomConnectedAccountAuditLogs',
1042
- ViewKioskBluetoothDeviceAuditLogs: 'ViewKioskBluetoothDeviceAuditLogs',
1043
- ViewExternalAuditLogs: 'ViewExternalAuditLogs',
1044
- CreateExternalAuditLogEvents: 'CreateExternalAuditLogEvents',
1045
- ViewCatalogAuditLogs: 'ViewCatalogAuditLogs',
1046
- ViewOrderFulfillmentAuditLogs: 'ViewOrderFulfillmentAuditLogs',
1047
- ViewChannelAuditLogs: 'ViewChannelAuditLogs',
1048
- ViewAppStoreAuditLogs: 'ViewAppStoreAuditLogs',
1049
- SendPushNotificationToCustomer: 'SendPushNotificationToCustomer',
1050
- InviteDriverToApp: 'InviteDriverToApp',
1051
- GetDriverForApp: 'GetDriverForApp',
1052
- RemoveDriverFromApp: 'RemoveDriverFromApp',
1053
- AssignDriverToOrder: 'AssignDriverToOrder',
1054
- UnassignDriverFromOrder: 'UnassignDriverFromOrder',
1055
- UpdateOrdersDeliveryTrackingStatus: 'UpdateOrdersDeliveryTrackingStatus',
1056
- UpdateOrderFulfillmentStatus: 'UpdateOrderFulfillmentStatus',
1057
- ViewFulfillmentStatesConfiguration: 'ViewFulfillmentStatesConfiguration',
1058
- CreateFulfillmentStatesConfiguration: 'CreateFulfillmentStatesConfiguration',
1059
- UpdateFulfillmentStatesConfiguration: 'UpdateFulfillmentStatesConfiguration',
1060
- DeleteFulfillmentStatesConfiguration: 'DeleteFulfillmentStatesConfiguration',
1061
- ViewPayouts: 'ViewPayouts',
1062
- ViewChannels: 'ViewChannels',
1063
- ViewOnboarding: 'ViewOnboarding',
1064
- UpdateOnboarding: 'UpdateOnboarding',
1065
- ViewClientDevices: 'ViewClientDevices',
1066
- UpdateClientDevices: 'UpdateClientDevices',
1067
- EnrollClientDevices: 'EnrollClientDevices',
1068
- AssignClientDevices: 'AssignClientDevices',
1069
- ViewClientAuditLogs: 'ViewClientAuditLogs',
1070
- CreateAppStoreAppConfiguration: 'CreateAppStoreAppConfiguration',
1071
- ViewAppStoreAppConfiguration: 'ViewAppStoreAppConfiguration',
1072
- UpdateAppStoreAppConfiguration: 'UpdateAppStoreAppConfiguration',
1073
- DeleteAppStoreAppConfiguration: 'DeleteAppStoreAppConfiguration',
1074
- UpdateAppStoreAppConfigurationSettings: 'UpdateAppStoreAppConfigurationSettings',
1075
- CreateAppStoreSubscription: 'CreateAppStoreSubscription',
1076
- UpdateAppStoreSubscription: 'UpdateAppStoreSubscription',
1077
- DeleteAppStoreSubscription: 'DeleteAppStoreSubscription',
1078
- ViewSalesChannels: 'ViewSalesChannels',
1079
- EditSalesChannels: 'EditSalesChannels',
1080
- CreateSalesChannel: 'CreateSalesChannel',
1081
- ArchiveSalesChannel: 'ArchiveSalesChannel',
1082
- UnarchiveSalesChannel: 'UnarchiveSalesChannel',
1083
- PublishSalesChannel: 'PublishSalesChannel',
1084
- UnpublishSalesChannel: 'UnpublishSalesChannel',
1085
- CloneSalesChannel: 'CloneSalesChannel',
1086
- ViewPayGreenWhiteLabelConfiguration: 'ViewPayGreenWhiteLabelConfiguration',
1087
- CreatePayGreenWhiteLabelConfiguration: 'CreatePayGreenWhiteLabelConfiguration',
1088
- UpdatePayGreenWhiteLabelConfiguration: 'UpdatePayGreenWhiteLabelConfiguration',
1089
- UpdatePayGreenStoreConfiguration: 'UpdatePayGreenStoreConfiguration',
1090
- ViewSubscriptions: 'ViewSubscriptions',
1091
- ViewInvoices: 'ViewInvoices',
1092
- EditAccountsBills: 'EditAccountsBills',
1093
- ViewAccountsBills: 'ViewAccountsBills',
1094
- EditAccountsCategories: 'EditAccountsCategories',
1095
- ViewAccountsCategories: 'ViewAccountsCategories',
1096
- EditAccountsCreditAccounts: 'EditAccountsCreditAccounts',
1097
- ViewAccountsCreditAccounts: 'ViewAccountsCreditAccounts',
1098
- EditAccountsCreditBooks: 'EditAccountsCreditBooks',
1099
- ViewAccountsCreditBooks: 'ViewAccountsCreditBooks',
1100
- EditAccountsExpenses: 'EditAccountsExpenses',
1101
- ViewAccountsExpenses: 'ViewAccountsExpenses',
1102
- EditAccountsTransactionAccounts: 'EditAccountsTransactionAccounts',
1103
- ViewAccountsTransactionAccounts: 'ViewAccountsTransactionAccounts',
1104
- EditDocumentExplorer: 'EditDocumentExplorer',
1105
- ViewDocumentExplorer: 'ViewDocumentExplorer',
1106
- ViewInventoryReports: 'ViewInventoryReports',
1107
- EditInventoryPurchaseOrders: 'EditInventoryPurchaseOrders',
1108
- ViewInventoryPurchaseOrders: 'ViewInventoryPurchaseOrders',
1109
- EditInventoryStockItems: 'EditInventoryStockItems',
1110
- ViewInventoryStockItems: 'ViewInventoryStockItems',
1111
- EditInventorySupplier: 'EditInventorySupplier',
1112
- ViewInventorySupplier: 'ViewInventorySupplier',
1113
- EditInventoryTrackingProfiles: 'EditInventoryTrackingProfiles',
1114
- ViewInventoryTrackingProfiles: 'ViewInventoryTrackingProfiles',
1115
- ViewPayrollReports: 'ViewPayrollReports',
1116
- EditPayrollHoliday: 'EditPayrollHoliday',
1117
- ViewPayrollHoliday: 'ViewPayrollHoliday',
1118
- EditPayrollRota: 'EditPayrollRota',
1119
- ViewPayrollRota: 'ViewPayrollRota',
1120
- EditPayrollStaff: 'EditPayrollStaff',
1121
- ViewPayrollStaff: 'ViewPayrollStaff',
1122
- ViewSalesReports: 'ViewSalesReports',
1123
- ViewCostReports: 'ViewCostReports',
1124
- ViewMenuReports: 'ViewMenuReports',
1125
- ViewBrand: 'ViewBrand',
1126
- EditBrand: 'EditBrand',
1127
- CreateBrand: 'CreateBrand',
1128
- TransferBrand: 'TransferBrand',
1129
- ViewProperty: 'ViewProperty',
1130
- EditProperty: 'EditProperty',
1131
- CreateProperty: 'CreateProperty',
1132
- ArchiveProperty: 'ArchiveProperty',
1133
- ViewEntityFeatureFlags: 'ViewEntityFeatureFlags',
1134
- EditEntityFeatureFlags: 'EditEntityFeatureFlags',
1135
- CreateOrg: 'CreateOrg',
1136
- EditOrg: 'EditOrg',
1137
- ViewOrg: 'ViewOrg'
1524
+ export const RevokeRoleRequestBodyRoleEnum = {
1525
+ OrgViewer: 'OrgViewer',
1526
+ OrgManager: 'OrgManager',
1527
+ OrgAdmin: 'OrgAdmin',
1528
+ BrandViewer: 'BrandViewer',
1529
+ BrandManager: 'BrandManager',
1530
+ BrandAdmin: 'BrandAdmin',
1531
+ StoreViewer: 'StoreViewer',
1532
+ StoreEditor: 'StoreEditor',
1533
+ StoreManager: 'StoreManager',
1534
+ CustomerViewer: 'CustomerViewer',
1535
+ CustomerManager: 'CustomerManager',
1536
+ VoucherViewer: 'VoucherViewer',
1537
+ VoucherEditor: 'VoucherEditor',
1538
+ VoucherManager: 'VoucherManager',
1539
+ VoucherCampaignManager: 'VoucherCampaignManager',
1540
+ VoucherStatisticsViewer: 'VoucherStatisticsViewer',
1541
+ AnalyticsViewer: 'AnalyticsViewer',
1542
+ ReportsViewer: 'ReportsViewer',
1543
+ FinanceViewer: 'FinanceViewer',
1544
+ FinanceManager: 'FinanceManager',
1545
+ TeamViewer: 'TeamViewer',
1546
+ TeamManager: 'TeamManager',
1547
+ TeamAdmin: 'TeamAdmin',
1548
+ TechViewer: 'TechViewer',
1549
+ TechManager: 'TechManager',
1550
+ AppStoreViewer: 'AppStoreViewer',
1551
+ AppStoreManager: 'AppStoreManager',
1552
+ SalesChannelViewer: 'SalesChannelViewer',
1553
+ SalesChannelEditor: 'SalesChannelEditor',
1554
+ SalesChannelManager: 'SalesChannelManager',
1555
+ DeliveryViewer: 'DeliveryViewer',
1556
+ DeliveryManager: 'DeliveryManager',
1557
+ DriverManager: 'DriverManager',
1558
+ AuditViewer: 'AuditViewer',
1559
+ AuditManager: 'AuditManager',
1560
+ AccountsViewer: 'AccountsViewer',
1561
+ AccountsEditor: 'AccountsEditor',
1562
+ DocumentExplorerViewer: 'DocumentExplorerViewer',
1563
+ DocumentExplorerEditor: 'DocumentExplorerEditor',
1564
+ PayrollViewer: 'PayrollViewer',
1565
+ PayrollEditor: 'PayrollEditor',
1566
+ PropertyViewer: 'PropertyViewer',
1567
+ PropertyManager: 'PropertyManager',
1568
+ PropertyAdmin: 'PropertyAdmin',
1569
+ WebsiteContentEditor: 'WebsiteContentEditor',
1570
+ WebsiteContentViewer: 'WebsiteContentViewer',
1571
+ WebsiteTechViewer: 'WebsiteTechViewer',
1572
+ MenuViewer: 'MenuViewer',
1573
+ MenuEditor: 'MenuEditor',
1574
+ MenuManager: 'MenuManager',
1575
+ MenuMetaFieldManager: 'MenuMetaFieldManager',
1576
+ MenuMetaFieldEditor: 'MenuMetaFieldEditor',
1577
+ MenuMetaFieldViewer: 'MenuMetaFieldViewer',
1578
+ StoreDeliveryZoneManager: 'StoreDeliveryZoneManager',
1579
+ StoreDeliveryZoneEditor: 'StoreDeliveryZoneEditor',
1580
+ StoreDeliveryZoneViewer: 'StoreDeliveryZoneViewer',
1581
+ OrderFulfillmentManager: 'OrderFulfillmentManager',
1582
+ OrderManager: 'OrderManager',
1583
+ OrderEditor: 'OrderEditor',
1584
+ OrderViewer: 'OrderViewer',
1585
+ InventoryManager: 'InventoryManager',
1586
+ InventoryEditor: 'InventoryEditor',
1587
+ InventoryViewer: 'InventoryViewer',
1588
+ PaymentManager: 'PaymentManager',
1589
+ OnboardingManager: 'OnboardingManager',
1590
+ FeatureFlagManager: 'FeatureFlagManager',
1591
+ PropertyOwnerMisc: 'PropertyOwnerMisc',
1592
+ ManagedOwnerMisc: 'ManagedOwnerMisc',
1593
+ IntegratorMisc: 'IntegratorMisc',
1594
+ PropertyManagerMisc: 'PropertyManagerMisc',
1595
+ FinanceManagerMisc: 'FinanceManagerMisc',
1596
+ SupportMisc: 'SupportMisc'
1597
+ } as const;
1598
+
1599
+ export type RevokeRoleRequestBodyRoleEnum = typeof RevokeRoleRequestBodyRoleEnum[keyof typeof RevokeRoleRequestBodyRoleEnum];
1600
+
1601
+ /**
1602
+ * Successful role revocation response
1603
+ * @export
1604
+ * @interface RevokeRoleSuccessResponse
1605
+ */
1606
+ export interface RevokeRoleSuccessResponse {
1607
+ /**
1608
+ * Confirmation message
1609
+ * @type {string}
1610
+ * @memberof RevokeRoleSuccessResponse
1611
+ */
1612
+ 'message': string;
1613
+ }
1614
+ /**
1615
+ * Role names
1616
+ * @export
1617
+ * @enum {string}
1618
+ */
1619
+
1620
+ export const RoleNames = {
1621
+ Admin: 'Admin',
1622
+ Factory: 'Factory'
1138
1623
  } as const;
1139
1624
 
1140
- export type Permissions = typeof Permissions[keyof typeof Permissions];
1625
+ export type RoleNames = typeof RoleNames[keyof typeof RoleNames];
1626
+
1627
+
1628
+ /**
1629
+ *
1630
+ * @export
1631
+ * @interface ValidationErrorsInner
1632
+ */
1633
+ export interface ValidationErrorsInner {
1634
+ /**
1635
+ *
1636
+ * @type {Array<ValidationErrorsInnerPathInner>}
1637
+ * @memberof ValidationErrorsInner
1638
+ */
1639
+ 'path'?: Array<ValidationErrorsInnerPathInner>;
1640
+ /**
1641
+ *
1642
+ * @type {string}
1643
+ * @memberof ValidationErrorsInner
1644
+ */
1645
+ 'message': string;
1646
+ }
1647
+ /**
1648
+ *
1649
+ * @export
1650
+ * @interface ValidationErrorsInnerPathInner
1651
+ */
1652
+ export interface ValidationErrorsInnerPathInner {
1653
+ }
1654
+
1655
+ /**
1656
+ * AuthenticationApi - axios parameter creator
1657
+ * @export
1658
+ */
1659
+ export const AuthenticationApiAxiosParamCreator = function (configuration?: Configuration) {
1660
+ return {
1661
+ /**
1662
+ * Authenticate and authorize a user to perform an action
1663
+ * @summary Authenticate and authorize Request
1664
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1665
+ * @param {*} [options] Override http request option.
1666
+ * @throws {RequiredError}
1667
+ */
1668
+ authenticateAndAuthorize: async (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1669
+ // verify required parameter 'authenticateAndAuthorizeRequest' is not null or undefined
1670
+ assertParamExists('authenticateAndAuthorize', 'authenticateAndAuthorizeRequest', authenticateAndAuthorizeRequest)
1671
+ const localVarPath = `/authenticateAndAuthorize`;
1672
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1673
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1674
+ let baseOptions;
1675
+ if (configuration) {
1676
+ baseOptions = configuration.baseOptions;
1677
+ }
1678
+
1679
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1680
+ const localVarHeaderParameter = {} as any;
1681
+ const localVarQueryParameter = {} as any;
1682
+
1683
+ // authentication ApiKeyAuth required
1684
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1685
+
1686
+
1687
+
1688
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1689
+
1690
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1691
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1692
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1693
+ localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndAuthorizeRequest, localVarRequestOptions, configuration)
1694
+
1695
+ return {
1696
+ url: toPathString(localVarUrlObj),
1697
+ options: localVarRequestOptions,
1698
+ };
1699
+ },
1700
+ }
1701
+ };
1702
+
1703
+ /**
1704
+ * AuthenticationApi - functional programming interface
1705
+ * @export
1706
+ */
1707
+ export const AuthenticationApiFp = function(configuration?: Configuration) {
1708
+ const localVarAxiosParamCreator = AuthenticationApiAxiosParamCreator(configuration)
1709
+ return {
1710
+ /**
1711
+ * Authenticate and authorize a user to perform an action
1712
+ * @summary Authenticate and authorize Request
1713
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1714
+ * @param {*} [options] Override http request option.
1715
+ * @throws {RequiredError}
1716
+ */
1717
+ async authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>> {
1718
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options);
1719
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1720
+ const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.authenticateAndAuthorize']?.[localVarOperationServerIndex]?.url;
1721
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1722
+ },
1723
+ }
1724
+ };
1725
+
1726
+ /**
1727
+ * AuthenticationApi - factory interface
1728
+ * @export
1729
+ */
1730
+ export const AuthenticationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1731
+ const localVarFp = AuthenticationApiFp(configuration)
1732
+ return {
1733
+ /**
1734
+ * Authenticate and authorize a user to perform an action
1735
+ * @summary Authenticate and authorize Request
1736
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1737
+ * @param {*} [options] Override http request option.
1738
+ * @throws {RequiredError}
1739
+ */
1740
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse> {
1741
+ return localVarFp.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(axios, basePath));
1742
+ },
1743
+ };
1744
+ };
1745
+
1746
+ /**
1747
+ * AuthenticationApi - object-oriented interface
1748
+ * @export
1749
+ * @class AuthenticationApi
1750
+ * @extends {BaseAPI}
1751
+ */
1752
+ export class AuthenticationApi extends BaseAPI {
1753
+ /**
1754
+ * Authenticate and authorize a user to perform an action
1755
+ * @summary Authenticate and authorize Request
1756
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1757
+ * @param {*} [options] Override http request option.
1758
+ * @throws {RequiredError}
1759
+ * @memberof AuthenticationApi
1760
+ */
1761
+ public authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) {
1762
+ return AuthenticationApiFp(this.configuration).authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
1763
+ }
1764
+ }
1765
+
1766
+
1767
+
1768
+ /**
1769
+ * AuthorizationApi - axios parameter creator
1770
+ * @export
1771
+ */
1772
+ export const AuthorizationApiAxiosParamCreator = function (configuration?: Configuration) {
1773
+ return {
1774
+ /**
1775
+ * Authenticate and authorize a user to perform an action
1776
+ * @summary Authenticate and authorize Request
1777
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1778
+ * @param {*} [options] Override http request option.
1779
+ * @throws {RequiredError}
1780
+ */
1781
+ authenticateAndAuthorize: async (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1782
+ // verify required parameter 'authenticateAndAuthorizeRequest' is not null or undefined
1783
+ assertParamExists('authenticateAndAuthorize', 'authenticateAndAuthorizeRequest', authenticateAndAuthorizeRequest)
1784
+ const localVarPath = `/authenticateAndAuthorize`;
1785
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1786
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1787
+ let baseOptions;
1788
+ if (configuration) {
1789
+ baseOptions = configuration.baseOptions;
1790
+ }
1791
+
1792
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1793
+ const localVarHeaderParameter = {} as any;
1794
+ const localVarQueryParameter = {} as any;
1795
+
1796
+ // authentication ApiKeyAuth required
1797
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1798
+
1799
+
1800
+
1801
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1802
+
1803
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1804
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1805
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1806
+ localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndAuthorizeRequest, localVarRequestOptions, configuration)
1807
+
1808
+ return {
1809
+ url: toPathString(localVarUrlObj),
1810
+ options: localVarRequestOptions,
1811
+ };
1812
+ },
1813
+ /**
1814
+ * Authenticate and check if a user is in any/all of the roles
1815
+ * @summary Authenticate and Check Is In Role
1816
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
1817
+ * @param {*} [options] Override http request option.
1818
+ * @throws {RequiredError}
1819
+ */
1820
+ authenticateAndCheckIsInRole: async (authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1821
+ const localVarPath = `/authenticateAndCheckIsInRole`;
1822
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1823
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1824
+ let baseOptions;
1825
+ if (configuration) {
1826
+ baseOptions = configuration.baseOptions;
1827
+ }
1828
+
1829
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1830
+ const localVarHeaderParameter = {} as any;
1831
+ const localVarQueryParameter = {} as any;
1832
+
1833
+ // authentication ApiKeyAuth required
1834
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1835
+
1836
+
1837
+
1838
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1839
+
1840
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1841
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1842
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1843
+ localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndCheckIsInRoleRequest, localVarRequestOptions, configuration)
1844
+
1845
+ return {
1846
+ url: toPathString(localVarUrlObj),
1847
+ options: localVarRequestOptions,
1848
+ };
1849
+ },
1850
+ /**
1851
+ * Check if a user is authorized to perform an action
1852
+ * @summary Authorize Request
1853
+ * @param {AuthorizationRequest} [authorizationRequest]
1854
+ * @param {*} [options] Override http request option.
1855
+ * @throws {RequiredError}
1856
+ */
1857
+ authorize: async (authorizationRequest?: AuthorizationRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1858
+ const localVarPath = `/authorize`;
1859
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1860
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1861
+ let baseOptions;
1862
+ if (configuration) {
1863
+ baseOptions = configuration.baseOptions;
1864
+ }
1865
+
1866
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1867
+ const localVarHeaderParameter = {} as any;
1868
+ const localVarQueryParameter = {} as any;
1141
1869
 
1870
+ // authentication ApiKeyAuth required
1871
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1142
1872
 
1143
- /**
1144
- * Details for revoking a forbidden role from a principal
1145
- * @export
1146
- * @interface RevokeForbiddenRoleRequestBody
1147
- */
1148
- export interface RevokeForbiddenRoleRequestBody {
1149
- /**
1150
- *
1151
- * @type {AuthorizationRequestPrincipal}
1152
- * @memberof RevokeForbiddenRoleRequestBody
1153
- */
1154
- 'principal': AuthorizationRequestPrincipal;
1155
- /**
1156
- * Compensation role to revoke the forbidden role from
1157
- * @type {string}
1158
- * @memberof RevokeForbiddenRoleRequestBody
1159
- */
1160
- 'compensatingRole': RevokeForbiddenRoleRequestBodyCompensatingRoleEnum;
1161
- }
1162
1873
 
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;
1874
+
1875
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1171
1876
 
1172
- export type RevokeForbiddenRoleRequestBodyCompensatingRoleEnum = typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum[keyof typeof RevokeForbiddenRoleRequestBodyCompensatingRoleEnum];
1877
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1878
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1879
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1880
+ localVarRequestOptions.data = serializeDataIfNeeded(authorizationRequest, localVarRequestOptions, configuration)
1881
+
1882
+ return {
1883
+ url: toPathString(localVarUrlObj),
1884
+ options: localVarRequestOptions,
1885
+ };
1886
+ },
1887
+ /**
1888
+ * Check if a user is authorized to perform an action on multiple resources
1889
+ * @summary Authorize Batch Request
1890
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
1891
+ * @param {*} [options] Override http request option.
1892
+ * @throws {RequiredError}
1893
+ */
1894
+ authorizeBatch: async (authorizationBatchRequest?: AuthorizationBatchRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1895
+ const localVarPath = `/authorize/batch`;
1896
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1897
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1898
+ let baseOptions;
1899
+ if (configuration) {
1900
+ baseOptions = configuration.baseOptions;
1901
+ }
1902
+
1903
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1904
+ const localVarHeaderParameter = {} as any;
1905
+ const localVarQueryParameter = {} as any;
1906
+
1907
+ // authentication ApiKeyAuth required
1908
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1909
+
1910
+
1911
+
1912
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1913
+
1914
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1915
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1916
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1917
+ localVarRequestOptions.data = serializeDataIfNeeded(authorizationBatchRequest, localVarRequestOptions, configuration)
1918
+
1919
+ return {
1920
+ url: toPathString(localVarUrlObj),
1921
+ options: localVarRequestOptions,
1922
+ };
1923
+ },
1924
+ /**
1925
+ * Check if a user is in any/all of the roles
1926
+ * @summary Check Is In Role
1927
+ * @param {IsInRoleRequest} [isInRoleRequest]
1928
+ * @param {*} [options] Override http request option.
1929
+ * @throws {RequiredError}
1930
+ */
1931
+ checkIsInRole: async (isInRoleRequest?: IsInRoleRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1932
+ const localVarPath = `/checkIsInRole`;
1933
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1934
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1935
+ let baseOptions;
1936
+ if (configuration) {
1937
+ baseOptions = configuration.baseOptions;
1938
+ }
1939
+
1940
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1941
+ const localVarHeaderParameter = {} as any;
1942
+ const localVarQueryParameter = {} as any;
1943
+
1944
+ // authentication ApiKeyAuth required
1945
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1946
+
1947
+
1948
+
1949
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1950
+
1951
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1952
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1953
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1954
+ localVarRequestOptions.data = serializeDataIfNeeded(isInRoleRequest, localVarRequestOptions, configuration)
1955
+
1956
+ return {
1957
+ url: toPathString(localVarUrlObj),
1958
+ options: localVarRequestOptions,
1959
+ };
1960
+ },
1961
+ }
1962
+ };
1173
1963
 
1174
1964
  /**
1175
- * Details for revoking a role from a principal
1965
+ * AuthorizationApi - functional programming interface
1176
1966
  * @export
1177
- * @interface RevokeRoleRequestBody
1178
1967
  */
1179
- export interface RevokeRoleRequestBody {
1180
- /**
1181
- *
1182
- * @type {string}
1183
- * @memberof RevokeRoleRequestBody
1184
- */
1185
- 'role': RevokeRoleRequestBodyRoleEnum;
1186
- /**
1187
- *
1188
- * @type {AuthorizationRequestResource}
1189
- * @memberof RevokeRoleRequestBody
1190
- */
1191
- 'resource': AuthorizationRequestResource;
1192
- /**
1193
- *
1194
- * @type {AuthorizationRequestPrincipal}
1195
- * @memberof RevokeRoleRequestBody
1196
- */
1197
- 'principal': AuthorizationRequestPrincipal;
1198
- /**
1199
- *
1200
- * @type {string}
1201
- * @memberof RevokeRoleRequestBody
1202
- */
1203
- 'brandId': string;
1204
- }
1205
-
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'
1279
- } as const;
1280
-
1281
- export type RevokeRoleRequestBodyRoleEnum = typeof RevokeRoleRequestBodyRoleEnum[keyof typeof RevokeRoleRequestBodyRoleEnum];
1968
+ export const AuthorizationApiFp = function(configuration?: Configuration) {
1969
+ const localVarAxiosParamCreator = AuthorizationApiAxiosParamCreator(configuration)
1970
+ return {
1971
+ /**
1972
+ * Authenticate and authorize a user to perform an action
1973
+ * @summary Authenticate and authorize Request
1974
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1975
+ * @param {*} [options] Override http request option.
1976
+ * @throws {RequiredError}
1977
+ */
1978
+ async authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>> {
1979
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options);
1980
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1981
+ const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authenticateAndAuthorize']?.[localVarOperationServerIndex]?.url;
1982
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1983
+ },
1984
+ /**
1985
+ * Authenticate and check if a user is in any/all of the roles
1986
+ * @summary Authenticate and Check Is In Role
1987
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
1988
+ * @param {*} [options] Override http request option.
1989
+ * @throws {RequiredError}
1990
+ */
1991
+ async authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndCheckIsInRoleResponse>> {
1992
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest, options);
1993
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1994
+ const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authenticateAndCheckIsInRole']?.[localVarOperationServerIndex]?.url;
1995
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1996
+ },
1997
+ /**
1998
+ * Check if a user is authorized to perform an action
1999
+ * @summary Authorize Request
2000
+ * @param {AuthorizationRequest} [authorizationRequest]
2001
+ * @param {*} [options] Override http request option.
2002
+ * @throws {RequiredError}
2003
+ */
2004
+ async authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>> {
2005
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authorize(authorizationRequest, options);
2006
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2007
+ const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authorize']?.[localVarOperationServerIndex]?.url;
2008
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2009
+ },
2010
+ /**
2011
+ * Check if a user is authorized to perform an action on multiple resources
2012
+ * @summary Authorize Batch Request
2013
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
2014
+ * @param {*} [options] Override http request option.
2015
+ * @throws {RequiredError}
2016
+ */
2017
+ async authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationBatchResponse>> {
2018
+ const localVarAxiosArgs = await localVarAxiosParamCreator.authorizeBatch(authorizationBatchRequest, options);
2019
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2020
+ const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authorizeBatch']?.[localVarOperationServerIndex]?.url;
2021
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2022
+ },
2023
+ /**
2024
+ * Check if a user is in any/all of the roles
2025
+ * @summary Check Is In Role
2026
+ * @param {IsInRoleRequest} [isInRoleRequest]
2027
+ * @param {*} [options] Override http request option.
2028
+ * @throws {RequiredError}
2029
+ */
2030
+ async checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IsInRoleResponse>> {
2031
+ const localVarAxiosArgs = await localVarAxiosParamCreator.checkIsInRole(isInRoleRequest, options);
2032
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2033
+ const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.checkIsInRole']?.[localVarOperationServerIndex]?.url;
2034
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2035
+ },
2036
+ }
2037
+ };
1282
2038
 
1283
2039
  /**
1284
- * Successful role revocation response
2040
+ * AuthorizationApi - factory interface
1285
2041
  * @export
1286
- * @interface RevokeRoleSuccessResponse
1287
2042
  */
1288
- export interface RevokeRoleSuccessResponse {
1289
- /**
1290
- * Confirmation message
1291
- * @type {string}
1292
- * @memberof RevokeRoleSuccessResponse
1293
- */
1294
- 'message': string;
1295
- }
2043
+ export const AuthorizationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2044
+ const localVarFp = AuthorizationApiFp(configuration)
2045
+ return {
2046
+ /**
2047
+ * Authenticate and authorize a user to perform an action
2048
+ * @summary Authenticate and authorize Request
2049
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2050
+ * @param {*} [options] Override http request option.
2051
+ * @throws {RequiredError}
2052
+ */
2053
+ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse> {
2054
+ return localVarFp.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(axios, basePath));
2055
+ },
2056
+ /**
2057
+ * Authenticate and check if a user is in any/all of the roles
2058
+ * @summary Authenticate and Check Is In Role
2059
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
2060
+ * @param {*} [options] Override http request option.
2061
+ * @throws {RequiredError}
2062
+ */
2063
+ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndCheckIsInRoleResponse> {
2064
+ return localVarFp.authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest, options).then((request) => request(axios, basePath));
2065
+ },
2066
+ /**
2067
+ * Check if a user is authorized to perform an action
2068
+ * @summary Authorize Request
2069
+ * @param {AuthorizationRequest} [authorizationRequest]
2070
+ * @param {*} [options] Override http request option.
2071
+ * @throws {RequiredError}
2072
+ */
2073
+ authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationResponse> {
2074
+ return localVarFp.authorize(authorizationRequest, options).then((request) => request(axios, basePath));
2075
+ },
2076
+ /**
2077
+ * Check if a user is authorized to perform an action on multiple resources
2078
+ * @summary Authorize Batch Request
2079
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
2080
+ * @param {*} [options] Override http request option.
2081
+ * @throws {RequiredError}
2082
+ */
2083
+ authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationBatchResponse> {
2084
+ return localVarFp.authorizeBatch(authorizationBatchRequest, options).then((request) => request(axios, basePath));
2085
+ },
2086
+ /**
2087
+ * Check if a user is in any/all of the roles
2088
+ * @summary Check Is In Role
2089
+ * @param {IsInRoleRequest} [isInRoleRequest]
2090
+ * @param {*} [options] Override http request option.
2091
+ * @throws {RequiredError}
2092
+ */
2093
+ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise<IsInRoleResponse> {
2094
+ return localVarFp.checkIsInRole(isInRoleRequest, options).then((request) => request(axios, basePath));
2095
+ },
2096
+ };
2097
+ };
2098
+
1296
2099
  /**
1297
- *
2100
+ * AuthorizationApi - object-oriented interface
1298
2101
  * @export
1299
- * @interface RolesInner
2102
+ * @class AuthorizationApi
2103
+ * @extends {BaseAPI}
1300
2104
  */
1301
- export interface RolesInner {
2105
+ export class AuthorizationApi extends BaseAPI {
1302
2106
  /**
1303
- * Name of the role
1304
- * @type {string}
1305
- * @memberof RolesInner
2107
+ * Authenticate and authorize a user to perform an action
2108
+ * @summary Authenticate and authorize Request
2109
+ * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2110
+ * @param {*} [options] Override http request option.
2111
+ * @throws {RequiredError}
2112
+ * @memberof AuthorizationApi
1306
2113
  */
1307
- 'name': string;
2114
+ public authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) {
2115
+ return AuthorizationApiFp(this.configuration).authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
2116
+ }
2117
+
1308
2118
  /**
1309
- *
1310
- * @type {Permissions & Array<string>}
1311
- * @memberof RolesInner
2119
+ * Authenticate and check if a user is in any/all of the roles
2120
+ * @summary Authenticate and Check Is In Role
2121
+ * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest]
2122
+ * @param {*} [options] Override http request option.
2123
+ * @throws {RequiredError}
2124
+ * @memberof AuthorizationApi
1312
2125
  */
1313
- 'permissions': Permissions & Array<string>;
1314
- }
1315
- /**
1316
- *
1317
- * @export
1318
- * @interface ValidationErrorsInner
1319
- */
1320
- export interface ValidationErrorsInner {
2126
+ public authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig) {
2127
+ return AuthorizationApiFp(this.configuration).authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest, options).then((request) => request(this.axios, this.basePath));
2128
+ }
2129
+
1321
2130
  /**
1322
- *
1323
- * @type {Array<ValidationErrorsInnerPathInner>}
1324
- * @memberof ValidationErrorsInner
2131
+ * Check if a user is authorized to perform an action
2132
+ * @summary Authorize Request
2133
+ * @param {AuthorizationRequest} [authorizationRequest]
2134
+ * @param {*} [options] Override http request option.
2135
+ * @throws {RequiredError}
2136
+ * @memberof AuthorizationApi
1325
2137
  */
1326
- 'path'?: Array<ValidationErrorsInnerPathInner>;
2138
+ public authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig) {
2139
+ return AuthorizationApiFp(this.configuration).authorize(authorizationRequest, options).then((request) => request(this.axios, this.basePath));
2140
+ }
2141
+
1327
2142
  /**
1328
- *
1329
- * @type {string}
1330
- * @memberof ValidationErrorsInner
2143
+ * Check if a user is authorized to perform an action on multiple resources
2144
+ * @summary Authorize Batch Request
2145
+ * @param {AuthorizationBatchRequest} [authorizationBatchRequest]
2146
+ * @param {*} [options] Override http request option.
2147
+ * @throws {RequiredError}
2148
+ * @memberof AuthorizationApi
1331
2149
  */
1332
- 'message': string;
1333
- }
1334
- /**
1335
- *
1336
- * @export
1337
- * @interface ValidationErrorsInnerPathInner
1338
- */
1339
- export interface ValidationErrorsInnerPathInner {
2150
+ public authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig) {
2151
+ return AuthorizationApiFp(this.configuration).authorizeBatch(authorizationBatchRequest, options).then((request) => request(this.axios, this.basePath));
2152
+ }
2153
+
2154
+ /**
2155
+ * Check if a user is in any/all of the roles
2156
+ * @summary Check Is In Role
2157
+ * @param {IsInRoleRequest} [isInRoleRequest]
2158
+ * @param {*} [options] Override http request option.
2159
+ * @throws {RequiredError}
2160
+ * @memberof AuthorizationApi
2161
+ */
2162
+ public checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig) {
2163
+ return AuthorizationApiFp(this.configuration).checkIsInRole(isInRoleRequest, options).then((request) => request(this.axios, this.basePath));
2164
+ }
1340
2165
  }
1341
2166
 
2167
+
2168
+
1342
2169
  /**
1343
- * AuthenticationApi - axios parameter creator
2170
+ * AuthorizedEntitiesApi - axios parameter creator
1344
2171
  * @export
1345
2172
  */
1346
- export const AuthenticationApiAxiosParamCreator = function (configuration?: Configuration) {
2173
+ export const AuthorizedEntitiesApiAxiosParamCreator = function (configuration?: Configuration) {
1347
2174
  return {
1348
2175
  /**
1349
- * Authenticate and authorize a user to perform an action
1350
- * @summary Authenticate and authorize Request
1351
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2176
+ * Get the authorized brands for a given org
2177
+ * @summary Get Authorized Brands
2178
+ * @param {string} orgId
2179
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
1352
2180
  * @param {*} [options] Override http request option.
1353
2181
  * @throws {RequiredError}
1354
2182
  */
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`;
2183
+ getAuthorizedBrands: async (orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2184
+ // verify required parameter 'orgId' is not null or undefined
2185
+ assertParamExists('getAuthorizedBrands', 'orgId', orgId)
2186
+ const localVarPath = `/orgs/{orgId}/getAuthorizedBrands`
2187
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
1359
2188
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1360
2189
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1361
2190
  let baseOptions;
@@ -1377,7 +2206,85 @@ export const AuthenticationApiAxiosParamCreator = function (configuration?: Conf
1377
2206
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1378
2207
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1379
2208
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1380
- localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndAuthorizeRequest, localVarRequestOptions, configuration)
2209
+ localVarRequestOptions.data = serializeDataIfNeeded(getAuthorizedBrandsRequest, localVarRequestOptions, configuration)
2210
+
2211
+ return {
2212
+ url: toPathString(localVarUrlObj),
2213
+ options: localVarRequestOptions,
2214
+ };
2215
+ },
2216
+ /**
2217
+ * Get the authorized orgs for a given principal
2218
+ * @summary Get Authorized Orgs
2219
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
2220
+ * @param {*} [options] Override http request option.
2221
+ * @throws {RequiredError}
2222
+ */
2223
+ getAuthorizedOrgs: async (getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2224
+ const localVarPath = `/getAuthorizedOrgs`;
2225
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2226
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2227
+ let baseOptions;
2228
+ if (configuration) {
2229
+ baseOptions = configuration.baseOptions;
2230
+ }
2231
+
2232
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2233
+ const localVarHeaderParameter = {} as any;
2234
+ const localVarQueryParameter = {} as any;
2235
+
2236
+ // authentication ApiKeyAuth required
2237
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2238
+
2239
+
2240
+
2241
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2242
+
2243
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2244
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2245
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2246
+ localVarRequestOptions.data = serializeDataIfNeeded(getAuthorizedOrgsRequest, localVarRequestOptions, configuration)
2247
+
2248
+ return {
2249
+ url: toPathString(localVarUrlObj),
2250
+ options: localVarRequestOptions,
2251
+ };
2252
+ },
2253
+ /**
2254
+ * Get the authorized properties for a given org
2255
+ * @summary Get Authorized Properties
2256
+ * @param {string} orgId
2257
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
2258
+ * @param {*} [options] Override http request option.
2259
+ * @throws {RequiredError}
2260
+ */
2261
+ getAuthorizedProperties: async (orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2262
+ // verify required parameter 'orgId' is not null or undefined
2263
+ assertParamExists('getAuthorizedProperties', 'orgId', orgId)
2264
+ const localVarPath = `/orgs/{orgId}/getAuthorizedProperties`
2265
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
2266
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2267
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2268
+ let baseOptions;
2269
+ if (configuration) {
2270
+ baseOptions = configuration.baseOptions;
2271
+ }
2272
+
2273
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2274
+ const localVarHeaderParameter = {} as any;
2275
+ const localVarQueryParameter = {} as any;
2276
+
2277
+ // authentication ApiKeyAuth required
2278
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2279
+
2280
+
2281
+
2282
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2283
+
2284
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2285
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2286
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2287
+ localVarRequestOptions.data = serializeDataIfNeeded(getAuthorizedPropertiesRequest, localVarRequestOptions, configuration)
1381
2288
 
1382
2289
  return {
1383
2290
  url: toPathString(localVarUrlObj),
@@ -1388,87 +2295,160 @@ export const AuthenticationApiAxiosParamCreator = function (configuration?: Conf
1388
2295
  };
1389
2296
 
1390
2297
  /**
1391
- * AuthenticationApi - functional programming interface
2298
+ * AuthorizedEntitiesApi - functional programming interface
1392
2299
  * @export
1393
2300
  */
1394
- export const AuthenticationApiFp = function(configuration?: Configuration) {
1395
- const localVarAxiosParamCreator = AuthenticationApiAxiosParamCreator(configuration)
2301
+ export const AuthorizedEntitiesApiFp = function(configuration?: Configuration) {
2302
+ const localVarAxiosParamCreator = AuthorizedEntitiesApiAxiosParamCreator(configuration)
1396
2303
  return {
1397
2304
  /**
1398
- * Authenticate and authorize a user to perform an action
1399
- * @summary Authenticate and authorize Request
1400
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2305
+ * Get the authorized brands for a given org
2306
+ * @summary Get Authorized Brands
2307
+ * @param {string} orgId
2308
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
1401
2309
  * @param {*} [options] Override http request option.
1402
2310
  * @throws {RequiredError}
1403
2311
  */
1404
- async authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>> {
1405
- const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options);
2312
+ async getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedBrandsResponse>> {
2313
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthorizedBrands(orgId, getAuthorizedBrandsRequest, options);
1406
2314
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1407
- const localVarOperationServerBasePath = operationServerMap['AuthenticationApi.authenticateAndAuthorize']?.[localVarOperationServerIndex]?.url;
2315
+ const localVarOperationServerBasePath = operationServerMap['AuthorizedEntitiesApi.getAuthorizedBrands']?.[localVarOperationServerIndex]?.url;
2316
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2317
+ },
2318
+ /**
2319
+ * Get the authorized orgs for a given principal
2320
+ * @summary Get Authorized Orgs
2321
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
2322
+ * @param {*} [options] Override http request option.
2323
+ * @throws {RequiredError}
2324
+ */
2325
+ async getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedOrgsResponse>> {
2326
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthorizedOrgs(getAuthorizedOrgsRequest, options);
2327
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2328
+ const localVarOperationServerBasePath = operationServerMap['AuthorizedEntitiesApi.getAuthorizedOrgs']?.[localVarOperationServerIndex]?.url;
2329
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2330
+ },
2331
+ /**
2332
+ * Get the authorized properties for a given org
2333
+ * @summary Get Authorized Properties
2334
+ * @param {string} orgId
2335
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
2336
+ * @param {*} [options] Override http request option.
2337
+ * @throws {RequiredError}
2338
+ */
2339
+ async getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAuthorizedPropertiesResponse>> {
2340
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAuthorizedProperties(orgId, getAuthorizedPropertiesRequest, options);
2341
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2342
+ const localVarOperationServerBasePath = operationServerMap['AuthorizedEntitiesApi.getAuthorizedProperties']?.[localVarOperationServerIndex]?.url;
1408
2343
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1409
2344
  },
1410
2345
  }
1411
2346
  };
1412
2347
 
1413
2348
  /**
1414
- * AuthenticationApi - factory interface
2349
+ * AuthorizedEntitiesApi - factory interface
1415
2350
  * @export
1416
2351
  */
1417
- export const AuthenticationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1418
- const localVarFp = AuthenticationApiFp(configuration)
2352
+ export const AuthorizedEntitiesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2353
+ const localVarFp = AuthorizedEntitiesApiFp(configuration)
1419
2354
  return {
1420
2355
  /**
1421
- * Authenticate and authorize a user to perform an action
1422
- * @summary Authenticate and authorize Request
1423
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2356
+ * Get the authorized brands for a given org
2357
+ * @summary Get Authorized Brands
2358
+ * @param {string} orgId
2359
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
2360
+ * @param {*} [options] Override http request option.
2361
+ * @throws {RequiredError}
2362
+ */
2363
+ getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedBrandsResponse> {
2364
+ return localVarFp.getAuthorizedBrands(orgId, getAuthorizedBrandsRequest, options).then((request) => request(axios, basePath));
2365
+ },
2366
+ /**
2367
+ * Get the authorized orgs for a given principal
2368
+ * @summary Get Authorized Orgs
2369
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
2370
+ * @param {*} [options] Override http request option.
2371
+ * @throws {RequiredError}
2372
+ */
2373
+ getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedOrgsResponse> {
2374
+ return localVarFp.getAuthorizedOrgs(getAuthorizedOrgsRequest, options).then((request) => request(axios, basePath));
2375
+ },
2376
+ /**
2377
+ * Get the authorized properties for a given org
2378
+ * @summary Get Authorized Properties
2379
+ * @param {string} orgId
2380
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
1424
2381
  * @param {*} [options] Override http request option.
1425
2382
  * @throws {RequiredError}
1426
2383
  */
1427
- authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse> {
1428
- return localVarFp.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(axios, basePath));
2384
+ getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAuthorizedPropertiesResponse> {
2385
+ return localVarFp.getAuthorizedProperties(orgId, getAuthorizedPropertiesRequest, options).then((request) => request(axios, basePath));
1429
2386
  },
1430
2387
  };
1431
2388
  };
1432
2389
 
1433
2390
  /**
1434
- * AuthenticationApi - object-oriented interface
2391
+ * AuthorizedEntitiesApi - object-oriented interface
1435
2392
  * @export
1436
- * @class AuthenticationApi
2393
+ * @class AuthorizedEntitiesApi
1437
2394
  * @extends {BaseAPI}
1438
2395
  */
1439
- export class AuthenticationApi extends BaseAPI {
2396
+ export class AuthorizedEntitiesApi extends BaseAPI {
1440
2397
  /**
1441
- * Authenticate and authorize a user to perform an action
1442
- * @summary Authenticate and authorize Request
1443
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2398
+ * Get the authorized brands for a given org
2399
+ * @summary Get Authorized Brands
2400
+ * @param {string} orgId
2401
+ * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest]
1444
2402
  * @param {*} [options] Override http request option.
1445
2403
  * @throws {RequiredError}
1446
- * @memberof AuthenticationApi
2404
+ * @memberof AuthorizedEntitiesApi
1447
2405
  */
1448
- public authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) {
1449
- return AuthenticationApiFp(this.configuration).authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
2406
+ public getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig) {
2407
+ return AuthorizedEntitiesApiFp(this.configuration).getAuthorizedBrands(orgId, getAuthorizedBrandsRequest, options).then((request) => request(this.axios, this.basePath));
2408
+ }
2409
+
2410
+ /**
2411
+ * Get the authorized orgs for a given principal
2412
+ * @summary Get Authorized Orgs
2413
+ * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest]
2414
+ * @param {*} [options] Override http request option.
2415
+ * @throws {RequiredError}
2416
+ * @memberof AuthorizedEntitiesApi
2417
+ */
2418
+ public getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig) {
2419
+ return AuthorizedEntitiesApiFp(this.configuration).getAuthorizedOrgs(getAuthorizedOrgsRequest, options).then((request) => request(this.axios, this.basePath));
2420
+ }
2421
+
2422
+ /**
2423
+ * Get the authorized properties for a given org
2424
+ * @summary Get Authorized Properties
2425
+ * @param {string} orgId
2426
+ * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest]
2427
+ * @param {*} [options] Override http request option.
2428
+ * @throws {RequiredError}
2429
+ * @memberof AuthorizedEntitiesApi
2430
+ */
2431
+ public getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig) {
2432
+ return AuthorizedEntitiesApiFp(this.configuration).getAuthorizedProperties(orgId, getAuthorizedPropertiesRequest, options).then((request) => request(this.axios, this.basePath));
1450
2433
  }
1451
2434
  }
1452
2435
 
1453
2436
 
1454
2437
 
1455
2438
  /**
1456
- * AuthorizationApi - axios parameter creator
2439
+ * ConfigurationDataApi - axios parameter creator
1457
2440
  * @export
1458
2441
  */
1459
- export const AuthorizationApiAxiosParamCreator = function (configuration?: Configuration) {
2442
+ export const ConfigurationDataApiAxiosParamCreator = function (configuration?: Configuration) {
1460
2443
  return {
1461
2444
  /**
1462
- * Authenticate and authorize a user to perform an action
1463
- * @summary Authenticate and authorize Request
1464
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2445
+ * List the available feature based roles
2446
+ * @summary List Feature Based Roles
1465
2447
  * @param {*} [options] Override http request option.
1466
2448
  * @throws {RequiredError}
1467
2449
  */
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`;
2450
+ configListFeatureBasedRoles: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2451
+ const localVarPath = `/config/featureBasedRoles`;
1472
2452
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1473
2453
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1474
2454
  let baseOptions;
@@ -1476,7 +2456,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
1476
2456
  baseOptions = configuration.baseOptions;
1477
2457
  }
1478
2458
 
1479
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2459
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1480
2460
  const localVarHeaderParameter = {} as any;
1481
2461
  const localVarQueryParameter = {} as any;
1482
2462
 
@@ -1485,12 +2465,9 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
1485
2465
 
1486
2466
 
1487
2467
 
1488
- localVarHeaderParameter['Content-Type'] = 'application/json';
1489
-
1490
2468
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1491
2469
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1492
2470
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1493
- localVarRequestOptions.data = serializeDataIfNeeded(authenticateAndAuthorizeRequest, localVarRequestOptions, configuration)
1494
2471
 
1495
2472
  return {
1496
2473
  url: toPathString(localVarUrlObj),
@@ -1498,14 +2475,13 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
1498
2475
  };
1499
2476
  },
1500
2477
  /**
1501
- * Check if a user is authorized to perform an action
1502
- * @summary Authorize Request
1503
- * @param {AuthorizationRequest} [authorizationRequest]
2478
+ * List the available permissions
2479
+ * @summary List Permissions
1504
2480
  * @param {*} [options] Override http request option.
1505
2481
  * @throws {RequiredError}
1506
2482
  */
1507
- authorize: async (authorizationRequest?: AuthorizationRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1508
- const localVarPath = `/authorize`;
2483
+ configListPermissions: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2484
+ const localVarPath = `/config/permissions`;
1509
2485
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1510
2486
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1511
2487
  let baseOptions;
@@ -1513,7 +2489,7 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
1513
2489
  baseOptions = configuration.baseOptions;
1514
2490
  }
1515
2491
 
1516
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
2492
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
1517
2493
  const localVarHeaderParameter = {} as any;
1518
2494
  const localVarQueryParameter = {} as any;
1519
2495
 
@@ -1522,135 +2498,122 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
1522
2498
 
1523
2499
 
1524
2500
 
1525
- localVarHeaderParameter['Content-Type'] = 'application/json';
1526
-
1527
2501
  setSearchParams(localVarUrlObj, localVarQueryParameter);
1528
2502
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1529
2503
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1530
- localVarRequestOptions.data = serializeDataIfNeeded(authorizationRequest, localVarRequestOptions, configuration)
1531
2504
 
1532
2505
  return {
1533
2506
  url: toPathString(localVarUrlObj),
1534
2507
  options: localVarRequestOptions,
1535
2508
  };
1536
2509
  },
1537
- }
1538
- };
1539
-
1540
- /**
1541
- * AuthorizationApi - functional programming interface
1542
- * @export
1543
- */
1544
- export const AuthorizationApiFp = function(configuration?: Configuration) {
1545
- const localVarAxiosParamCreator = AuthorizationApiAxiosParamCreator(configuration)
1546
- return {
1547
2510
  /**
1548
- * Authenticate and authorize a user to perform an action
1549
- * @summary Authenticate and authorize Request
1550
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
2511
+ * List the available roles
2512
+ * @summary List Roles
1551
2513
  * @param {*} [options] Override http request option.
1552
2514
  * @throws {RequiredError}
1553
2515
  */
1554
- async authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticateAndAuthorizeResponse>> {
1555
- const localVarAxiosArgs = await localVarAxiosParamCreator.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options);
1556
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1557
- const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authenticateAndAuthorize']?.[localVarOperationServerIndex]?.url;
1558
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2516
+ configListRoles: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2517
+ const localVarPath = `/config/roles`;
2518
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2519
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2520
+ let baseOptions;
2521
+ if (configuration) {
2522
+ baseOptions = configuration.baseOptions;
2523
+ }
2524
+
2525
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2526
+ const localVarHeaderParameter = {} as any;
2527
+ const localVarQueryParameter = {} as any;
2528
+
2529
+ // authentication ApiKeyAuth required
2530
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2531
+
2532
+
2533
+
2534
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2535
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2536
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2537
+
2538
+ return {
2539
+ url: toPathString(localVarUrlObj),
2540
+ options: localVarRequestOptions,
2541
+ };
1559
2542
  },
1560
2543
  /**
1561
- * Check if a user is authorized to perform an action
1562
- * @summary Authorize Request
1563
- * @param {AuthorizationRequest} [authorizationRequest]
2544
+ * List the available feature based roles
2545
+ * @summary List Feature Based Roles
1564
2546
  * @param {*} [options] Override http request option.
1565
2547
  * @throws {RequiredError}
1566
2548
  */
1567
- async authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthorizationResponse>> {
1568
- const localVarAxiosArgs = await localVarAxiosParamCreator.authorize(authorizationRequest, options);
1569
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1570
- const localVarOperationServerBasePath = operationServerMap['AuthorizationApi.authorize']?.[localVarOperationServerIndex]?.url;
1571
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1572
- },
1573
- }
1574
- };
2549
+ listFeatureBasedRoles: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2550
+ const localVarPath = `/featureBasedRoles`;
2551
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2552
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2553
+ let baseOptions;
2554
+ if (configuration) {
2555
+ baseOptions = configuration.baseOptions;
2556
+ }
1575
2557
 
1576
- /**
1577
- * AuthorizationApi - factory interface
1578
- * @export
1579
- */
1580
- export const AuthorizationApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1581
- const localVarFp = AuthorizationApiFp(configuration)
1582
- return {
1583
- /**
1584
- * Authenticate and authorize a user to perform an action
1585
- * @summary Authenticate and authorize Request
1586
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1587
- * @param {*} [options] Override http request option.
1588
- * @throws {RequiredError}
1589
- */
1590
- authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthenticateAndAuthorizeResponse> {
1591
- return localVarFp.authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(axios, basePath));
2558
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2559
+ const localVarHeaderParameter = {} as any;
2560
+ const localVarQueryParameter = {} as any;
2561
+
2562
+ // authentication ApiKeyAuth required
2563
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
2564
+
2565
+
2566
+
2567
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2568
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2569
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
2570
+
2571
+ return {
2572
+ url: toPathString(localVarUrlObj),
2573
+ options: localVarRequestOptions,
2574
+ };
1592
2575
  },
1593
2576
  /**
1594
- * Check if a user is authorized to perform an action
1595
- * @summary Authorize Request
1596
- * @param {AuthorizationRequest} [authorizationRequest]
2577
+ * List the available permissions
2578
+ * @summary List Permissions
1597
2579
  * @param {*} [options] Override http request option.
1598
2580
  * @throws {RequiredError}
1599
2581
  */
1600
- authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise<AuthorizationResponse> {
1601
- return localVarFp.authorize(authorizationRequest, options).then((request) => request(axios, basePath));
1602
- },
1603
- };
1604
- };
2582
+ listPermissions: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2583
+ const localVarPath = `/permissions`;
2584
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2585
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2586
+ let baseOptions;
2587
+ if (configuration) {
2588
+ baseOptions = configuration.baseOptions;
2589
+ }
1605
2590
 
1606
- /**
1607
- * AuthorizationApi - object-oriented interface
1608
- * @export
1609
- * @class AuthorizationApi
1610
- * @extends {BaseAPI}
1611
- */
1612
- export class AuthorizationApi extends BaseAPI {
1613
- /**
1614
- * Authenticate and authorize a user to perform an action
1615
- * @summary Authenticate and authorize Request
1616
- * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest
1617
- * @param {*} [options] Override http request option.
1618
- * @throws {RequiredError}
1619
- * @memberof AuthorizationApi
1620
- */
1621
- public authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) {
1622
- return AuthorizationApiFp(this.configuration).authenticateAndAuthorize(authenticateAndAuthorizeRequest, options).then((request) => request(this.axios, this.basePath));
1623
- }
2591
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2592
+ const localVarHeaderParameter = {} as any;
2593
+ const localVarQueryParameter = {} as any;
1624
2594
 
1625
- /**
1626
- * Check if a user is authorized to perform an action
1627
- * @summary Authorize Request
1628
- * @param {AuthorizationRequest} [authorizationRequest]
1629
- * @param {*} [options] Override http request option.
1630
- * @throws {RequiredError}
1631
- * @memberof AuthorizationApi
1632
- */
1633
- public authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig) {
1634
- return AuthorizationApiFp(this.configuration).authorize(authorizationRequest, options).then((request) => request(this.axios, this.basePath));
1635
- }
1636
- }
2595
+ // authentication ApiKeyAuth required
2596
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
1637
2597
 
1638
2598
 
2599
+
2600
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2601
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2602
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
1639
2603
 
1640
- /**
1641
- * PermissionsApi - axios parameter creator
1642
- * @export
1643
- */
1644
- export const PermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
1645
- return {
2604
+ return {
2605
+ url: toPathString(localVarUrlObj),
2606
+ options: localVarRequestOptions,
2607
+ };
2608
+ },
1646
2609
  /**
1647
- * List the available permissions
1648
- * @summary List Permissions
2610
+ * List the available roles
2611
+ * @summary List Roles
1649
2612
  * @param {*} [options] Override http request option.
1650
2613
  * @throws {RequiredError}
1651
2614
  */
1652
- listPermissions: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1653
- const localVarPath = `/permissions`;
2615
+ listRoles: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2616
+ const localVarPath = `/roles`;
1654
2617
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1655
2618
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1656
2619
  let baseOptions;
@@ -1680,62 +2643,222 @@ export const PermissionsApiAxiosParamCreator = function (configuration?: Configu
1680
2643
  };
1681
2644
 
1682
2645
  /**
1683
- * PermissionsApi - functional programming interface
2646
+ * ConfigurationDataApi - functional programming interface
1684
2647
  * @export
1685
2648
  */
1686
- export const PermissionsApiFp = function(configuration?: Configuration) {
1687
- const localVarAxiosParamCreator = PermissionsApiAxiosParamCreator(configuration)
2649
+ export const ConfigurationDataApiFp = function(configuration?: Configuration) {
2650
+ const localVarAxiosParamCreator = ConfigurationDataApiAxiosParamCreator(configuration)
1688
2651
  return {
2652
+ /**
2653
+ * List the available feature based roles
2654
+ * @summary List Feature Based Roles
2655
+ * @param {*} [options] Override http request option.
2656
+ * @throws {RequiredError}
2657
+ */
2658
+ async configListFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>> {
2659
+ const localVarAxiosArgs = await localVarAxiosParamCreator.configListFeatureBasedRoles(options);
2660
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2661
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.configListFeatureBasedRoles']?.[localVarOperationServerIndex]?.url;
2662
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2663
+ },
2664
+ /**
2665
+ * List the available permissions
2666
+ * @summary List Permissions
2667
+ * @param {*} [options] Override http request option.
2668
+ * @throws {RequiredError}
2669
+ */
2670
+ async configListPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>> {
2671
+ const localVarAxiosArgs = await localVarAxiosParamCreator.configListPermissions(options);
2672
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2673
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.configListPermissions']?.[localVarOperationServerIndex]?.url;
2674
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2675
+ },
2676
+ /**
2677
+ * List the available roles
2678
+ * @summary List Roles
2679
+ * @param {*} [options] Override http request option.
2680
+ * @throws {RequiredError}
2681
+ */
2682
+ async configListRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>> {
2683
+ const localVarAxiosArgs = await localVarAxiosParamCreator.configListRoles(options);
2684
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2685
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.configListRoles']?.[localVarOperationServerIndex]?.url;
2686
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2687
+ },
2688
+ /**
2689
+ * List the available feature based roles
2690
+ * @summary List Feature Based Roles
2691
+ * @param {*} [options] Override http request option.
2692
+ * @throws {RequiredError}
2693
+ */
2694
+ async listFeatureBasedRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFeatureBasedRolesSuccessResponse>> {
2695
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listFeatureBasedRoles(options);
2696
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2697
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.listFeatureBasedRoles']?.[localVarOperationServerIndex]?.url;
2698
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2699
+ },
1689
2700
  /**
1690
2701
  * List the available permissions
1691
2702
  * @summary List Permissions
1692
2703
  * @param {*} [options] Override http request option.
1693
2704
  * @throws {RequiredError}
1694
2705
  */
1695
- async listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPermissionsSuccessResponse>> {
1696
- const localVarAxiosArgs = await localVarAxiosParamCreator.listPermissions(options);
2706
+ async listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPermissionsSuccessResponse>> {
2707
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPermissions(options);
2708
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2709
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.listPermissions']?.[localVarOperationServerIndex]?.url;
2710
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2711
+ },
2712
+ /**
2713
+ * List the available roles
2714
+ * @summary List Roles
2715
+ * @param {*} [options] Override http request option.
2716
+ * @throws {RequiredError}
2717
+ */
2718
+ async listRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRolesSuccessResponse>> {
2719
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listRoles(options);
1697
2720
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1698
- const localVarOperationServerBasePath = operationServerMap['PermissionsApi.listPermissions']?.[localVarOperationServerIndex]?.url;
2721
+ const localVarOperationServerBasePath = operationServerMap['ConfigurationDataApi.listRoles']?.[localVarOperationServerIndex]?.url;
1699
2722
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1700
2723
  },
1701
2724
  }
1702
2725
  };
1703
2726
 
1704
2727
  /**
1705
- * PermissionsApi - factory interface
2728
+ * ConfigurationDataApi - factory interface
1706
2729
  * @export
1707
2730
  */
1708
- export const PermissionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
1709
- const localVarFp = PermissionsApiFp(configuration)
2731
+ export const ConfigurationDataApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2732
+ const localVarFp = ConfigurationDataApiFp(configuration)
1710
2733
  return {
2734
+ /**
2735
+ * List the available feature based roles
2736
+ * @summary List Feature Based Roles
2737
+ * @param {*} [options] Override http request option.
2738
+ * @throws {RequiredError}
2739
+ */
2740
+ configListFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse> {
2741
+ return localVarFp.configListFeatureBasedRoles(options).then((request) => request(axios, basePath));
2742
+ },
2743
+ /**
2744
+ * List the available permissions
2745
+ * @summary List Permissions
2746
+ * @param {*} [options] Override http request option.
2747
+ * @throws {RequiredError}
2748
+ */
2749
+ configListPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse> {
2750
+ return localVarFp.configListPermissions(options).then((request) => request(axios, basePath));
2751
+ },
2752
+ /**
2753
+ * List the available roles
2754
+ * @summary List Roles
2755
+ * @param {*} [options] Override http request option.
2756
+ * @throws {RequiredError}
2757
+ */
2758
+ configListRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse> {
2759
+ return localVarFp.configListRoles(options).then((request) => request(axios, basePath));
2760
+ },
2761
+ /**
2762
+ * List the available feature based roles
2763
+ * @summary List Feature Based Roles
2764
+ * @param {*} [options] Override http request option.
2765
+ * @throws {RequiredError}
2766
+ */
2767
+ listFeatureBasedRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListFeatureBasedRolesSuccessResponse> {
2768
+ return localVarFp.listFeatureBasedRoles(options).then((request) => request(axios, basePath));
2769
+ },
1711
2770
  /**
1712
2771
  * List the available permissions
1713
2772
  * @summary List Permissions
1714
2773
  * @param {*} [options] Override http request option.
1715
2774
  * @throws {RequiredError}
1716
2775
  */
1717
- listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<GetPermissionsSuccessResponse> {
2776
+ listPermissions(options?: RawAxiosRequestConfig): AxiosPromise<ListPermissionsSuccessResponse> {
1718
2777
  return localVarFp.listPermissions(options).then((request) => request(axios, basePath));
1719
2778
  },
2779
+ /**
2780
+ * List the available roles
2781
+ * @summary List Roles
2782
+ * @param {*} [options] Override http request option.
2783
+ * @throws {RequiredError}
2784
+ */
2785
+ listRoles(options?: RawAxiosRequestConfig): AxiosPromise<ListRolesSuccessResponse> {
2786
+ return localVarFp.listRoles(options).then((request) => request(axios, basePath));
2787
+ },
1720
2788
  };
1721
2789
  };
1722
2790
 
1723
2791
  /**
1724
- * PermissionsApi - object-oriented interface
2792
+ * ConfigurationDataApi - object-oriented interface
1725
2793
  * @export
1726
- * @class PermissionsApi
2794
+ * @class ConfigurationDataApi
1727
2795
  * @extends {BaseAPI}
1728
2796
  */
1729
- export class PermissionsApi extends BaseAPI {
2797
+ export class ConfigurationDataApi extends BaseAPI {
2798
+ /**
2799
+ * List the available feature based roles
2800
+ * @summary List Feature Based Roles
2801
+ * @param {*} [options] Override http request option.
2802
+ * @throws {RequiredError}
2803
+ * @memberof ConfigurationDataApi
2804
+ */
2805
+ public configListFeatureBasedRoles(options?: RawAxiosRequestConfig) {
2806
+ return ConfigurationDataApiFp(this.configuration).configListFeatureBasedRoles(options).then((request) => request(this.axios, this.basePath));
2807
+ }
2808
+
2809
+ /**
2810
+ * List the available permissions
2811
+ * @summary List Permissions
2812
+ * @param {*} [options] Override http request option.
2813
+ * @throws {RequiredError}
2814
+ * @memberof ConfigurationDataApi
2815
+ */
2816
+ public configListPermissions(options?: RawAxiosRequestConfig) {
2817
+ return ConfigurationDataApiFp(this.configuration).configListPermissions(options).then((request) => request(this.axios, this.basePath));
2818
+ }
2819
+
2820
+ /**
2821
+ * List the available roles
2822
+ * @summary List Roles
2823
+ * @param {*} [options] Override http request option.
2824
+ * @throws {RequiredError}
2825
+ * @memberof ConfigurationDataApi
2826
+ */
2827
+ public configListRoles(options?: RawAxiosRequestConfig) {
2828
+ return ConfigurationDataApiFp(this.configuration).configListRoles(options).then((request) => request(this.axios, this.basePath));
2829
+ }
2830
+
2831
+ /**
2832
+ * List the available feature based roles
2833
+ * @summary List Feature Based Roles
2834
+ * @param {*} [options] Override http request option.
2835
+ * @throws {RequiredError}
2836
+ * @memberof ConfigurationDataApi
2837
+ */
2838
+ public listFeatureBasedRoles(options?: RawAxiosRequestConfig) {
2839
+ return ConfigurationDataApiFp(this.configuration).listFeatureBasedRoles(options).then((request) => request(this.axios, this.basePath));
2840
+ }
2841
+
1730
2842
  /**
1731
2843
  * List the available permissions
1732
2844
  * @summary List Permissions
1733
2845
  * @param {*} [options] Override http request option.
1734
2846
  * @throws {RequiredError}
1735
- * @memberof PermissionsApi
2847
+ * @memberof ConfigurationDataApi
1736
2848
  */
1737
2849
  public listPermissions(options?: RawAxiosRequestConfig) {
1738
- return PermissionsApiFp(this.configuration).listPermissions(options).then((request) => request(this.axios, this.basePath));
2850
+ return ConfigurationDataApiFp(this.configuration).listPermissions(options).then((request) => request(this.axios, this.basePath));
2851
+ }
2852
+
2853
+ /**
2854
+ * List the available roles
2855
+ * @summary List Roles
2856
+ * @param {*} [options] Override http request option.
2857
+ * @throws {RequiredError}
2858
+ * @memberof ConfigurationDataApi
2859
+ */
2860
+ public listRoles(options?: RawAxiosRequestConfig) {
2861
+ return ConfigurationDataApiFp(this.configuration).listRoles(options).then((request) => request(this.axios, this.basePath));
1739
2862
  }
1740
2863
  }
1741
2864
 
@@ -1808,7 +2931,7 @@ export const RoleAssignmentApiAxiosParamCreator = function (configuration?: Conf
1808
2931
  baseOptions = configuration.baseOptions;
1809
2932
  }
1810
2933
 
1811
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
2934
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
1812
2935
  const localVarHeaderParameter = {} as any;
1813
2936
  const localVarQueryParameter = {} as any;
1814
2937
 
@@ -2096,12 +3219,197 @@ export class RoleAssignmentApi extends BaseAPI {
2096
3219
 
2097
3220
 
2098
3221
 
3222
+ /**
3223
+ * UserManagementApi - axios parameter creator
3224
+ * @export
3225
+ */
3226
+ export const UserManagementApiAxiosParamCreator = function (configuration?: Configuration) {
3227
+ return {
3228
+ /**
3229
+ * List the users in a given org
3230
+ * @summary List Users in Org
3231
+ * @param {string} orgId
3232
+ * @param {*} [options] Override http request option.
3233
+ * @throws {RequiredError}
3234
+ */
3235
+ listUsersInOrg: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3236
+ // verify required parameter 'orgId' is not null or undefined
3237
+ assertParamExists('listUsersInOrg', 'orgId', orgId)
3238
+ const localVarPath = `/orgs/{orgId}/users`
3239
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
3240
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3241
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3242
+ let baseOptions;
3243
+ if (configuration) {
3244
+ baseOptions = configuration.baseOptions;
3245
+ }
3246
+
3247
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3248
+ const localVarHeaderParameter = {} as any;
3249
+ const localVarQueryParameter = {} as any;
3250
+
3251
+ // authentication ApiKeyAuth required
3252
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3253
+
3254
+
3255
+
3256
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3257
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3258
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3259
+
3260
+ return {
3261
+ url: toPathString(localVarUrlObj),
3262
+ options: localVarRequestOptions,
3263
+ };
3264
+ },
3265
+ }
3266
+ };
3267
+
3268
+ /**
3269
+ * UserManagementApi - functional programming interface
3270
+ * @export
3271
+ */
3272
+ export const UserManagementApiFp = function(configuration?: Configuration) {
3273
+ const localVarAxiosParamCreator = UserManagementApiAxiosParamCreator(configuration)
3274
+ return {
3275
+ /**
3276
+ * List the users in a given org
3277
+ * @summary List Users in Org
3278
+ * @param {string} orgId
3279
+ * @param {*} [options] Override http request option.
3280
+ * @throws {RequiredError}
3281
+ */
3282
+ async listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrincipalsInOrgResponse>> {
3283
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listUsersInOrg(orgId, options);
3284
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3285
+ const localVarOperationServerBasePath = operationServerMap['UserManagementApi.listUsersInOrg']?.[localVarOperationServerIndex]?.url;
3286
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3287
+ },
3288
+ }
3289
+ };
3290
+
3291
+ /**
3292
+ * UserManagementApi - factory interface
3293
+ * @export
3294
+ */
3295
+ export const UserManagementApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
3296
+ const localVarFp = UserManagementApiFp(configuration)
3297
+ return {
3298
+ /**
3299
+ * List the users in a given org
3300
+ * @summary List Users in Org
3301
+ * @param {string} orgId
3302
+ * @param {*} [options] Override http request option.
3303
+ * @throws {RequiredError}
3304
+ */
3305
+ listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrincipalsInOrgResponse> {
3306
+ return localVarFp.listUsersInOrg(orgId, options).then((request) => request(axios, basePath));
3307
+ },
3308
+ };
3309
+ };
3310
+
3311
+ /**
3312
+ * UserManagementApi - object-oriented interface
3313
+ * @export
3314
+ * @class UserManagementApi
3315
+ * @extends {BaseAPI}
3316
+ */
3317
+ export class UserManagementApi extends BaseAPI {
3318
+ /**
3319
+ * List the users in a given org
3320
+ * @summary List Users in Org
3321
+ * @param {string} orgId
3322
+ * @param {*} [options] Override http request option.
3323
+ * @throws {RequiredError}
3324
+ * @memberof UserManagementApi
3325
+ */
3326
+ public listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig) {
3327
+ return UserManagementApiFp(this.configuration).listUsersInOrg(orgId, options).then((request) => request(this.axios, this.basePath));
3328
+ }
3329
+ }
3330
+
3331
+
3332
+
2099
3333
  /**
2100
3334
  * UserPermissionsApi - axios parameter creator
2101
3335
  * @export
2102
3336
  */
2103
3337
  export const UserPermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
2104
3338
  return {
3339
+ /**
3340
+ * List the available permissions for the current user
3341
+ * @summary List Org Permissions
3342
+ * @param {string} orgId
3343
+ * @param {*} [options] Override http request option.
3344
+ * @throws {RequiredError}
3345
+ */
3346
+ listOrgPermissions: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3347
+ // verify required parameter 'orgId' is not null or undefined
3348
+ assertParamExists('listOrgPermissions', 'orgId', orgId)
3349
+ const localVarPath = `/orgs/{orgId}/permissions`
3350
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
3351
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3352
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3353
+ let baseOptions;
3354
+ if (configuration) {
3355
+ baseOptions = configuration.baseOptions;
3356
+ }
3357
+
3358
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3359
+ const localVarHeaderParameter = {} as any;
3360
+ const localVarQueryParameter = {} as any;
3361
+
3362
+ // authentication ApiKeyAuth required
3363
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3364
+
3365
+
3366
+
3367
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3368
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3369
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3370
+
3371
+ return {
3372
+ url: toPathString(localVarUrlObj),
3373
+ options: localVarRequestOptions,
3374
+ };
3375
+ },
3376
+ /**
3377
+ * List the available roles for the current user
3378
+ * @summary List Org Roles
3379
+ * @param {string} orgId
3380
+ * @param {*} [options] Override http request option.
3381
+ * @throws {RequiredError}
3382
+ */
3383
+ listOrgRoles: async (orgId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3384
+ // verify required parameter 'orgId' is not null or undefined
3385
+ assertParamExists('listOrgRoles', 'orgId', orgId)
3386
+ const localVarPath = `/orgs/{orgId}/roles`
3387
+ .replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
3388
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3389
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3390
+ let baseOptions;
3391
+ if (configuration) {
3392
+ baseOptions = configuration.baseOptions;
3393
+ }
3394
+
3395
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3396
+ const localVarHeaderParameter = {} as any;
3397
+ const localVarQueryParameter = {} as any;
3398
+
3399
+ // authentication ApiKeyAuth required
3400
+ await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3401
+
3402
+
3403
+
3404
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3405
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3406
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3407
+
3408
+ return {
3409
+ url: toPathString(localVarUrlObj),
3410
+ options: localVarRequestOptions,
3411
+ };
3412
+ },
2105
3413
  /**
2106
3414
  * List the available permissions for the current user
2107
3415
  * @summary List Own Permissions
@@ -2190,6 +3498,32 @@ export const UserPermissionsApiAxiosParamCreator = function (configuration?: Con
2190
3498
  export const UserPermissionsApiFp = function(configuration?: Configuration) {
2191
3499
  const localVarAxiosParamCreator = UserPermissionsApiAxiosParamCreator(configuration)
2192
3500
  return {
3501
+ /**
3502
+ * List the available permissions for the current user
3503
+ * @summary List Org Permissions
3504
+ * @param {string} orgId
3505
+ * @param {*} [options] Override http request option.
3506
+ * @throws {RequiredError}
3507
+ */
3508
+ async listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }; }>> {
3509
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listOrgPermissions(orgId, options);
3510
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3511
+ const localVarOperationServerBasePath = operationServerMap['UserPermissionsApi.listOrgPermissions']?.[localVarOperationServerIndex]?.url;
3512
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3513
+ },
3514
+ /**
3515
+ * List the available roles for the current user
3516
+ * @summary List Org Roles
3517
+ * @param {string} orgId
3518
+ * @param {*} [options] Override http request option.
3519
+ * @throws {RequiredError}
3520
+ */
3521
+ async listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: { [key: string]: ListOrgRolesSuccessResponseValueValue; }; }>> {
3522
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listOrgRoles(orgId, options);
3523
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3524
+ const localVarOperationServerBasePath = operationServerMap['UserPermissionsApi.listOrgRoles']?.[localVarOperationServerIndex]?.url;
3525
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3526
+ },
2193
3527
  /**
2194
3528
  * List the available permissions for the current user
2195
3529
  * @summary List Own Permissions
@@ -2227,6 +3561,26 @@ export const UserPermissionsApiFp = function(configuration?: Configuration) {
2227
3561
  export const UserPermissionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2228
3562
  const localVarFp = UserPermissionsApiFp(configuration)
2229
3563
  return {
3564
+ /**
3565
+ * List the available permissions for the current user
3566
+ * @summary List Org Permissions
3567
+ * @param {string} orgId
3568
+ * @param {*} [options] Override http request option.
3569
+ * @throws {RequiredError}
3570
+ */
3571
+ listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }; }> {
3572
+ return localVarFp.listOrgPermissions(orgId, options).then((request) => request(axios, basePath));
3573
+ },
3574
+ /**
3575
+ * List the available roles for the current user
3576
+ * @summary List Org Roles
3577
+ * @param {string} orgId
3578
+ * @param {*} [options] Override http request option.
3579
+ * @throws {RequiredError}
3580
+ */
3581
+ listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: { [key: string]: ListOrgRolesSuccessResponseValueValue; }; }> {
3582
+ return localVarFp.listOrgRoles(orgId, options).then((request) => request(axios, basePath));
3583
+ },
2230
3584
  /**
2231
3585
  * List the available permissions for the current user
2232
3586
  * @summary List Own Permissions
@@ -2258,6 +3612,30 @@ export const UserPermissionsApiFactory = function (configuration?: Configuration
2258
3612
  * @extends {BaseAPI}
2259
3613
  */
2260
3614
  export class UserPermissionsApi extends BaseAPI {
3615
+ /**
3616
+ * List the available permissions for the current user
3617
+ * @summary List Org Permissions
3618
+ * @param {string} orgId
3619
+ * @param {*} [options] Override http request option.
3620
+ * @throws {RequiredError}
3621
+ * @memberof UserPermissionsApi
3622
+ */
3623
+ public listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig) {
3624
+ return UserPermissionsApiFp(this.configuration).listOrgPermissions(orgId, options).then((request) => request(this.axios, this.basePath));
3625
+ }
3626
+
3627
+ /**
3628
+ * List the available roles for the current user
3629
+ * @summary List Org Roles
3630
+ * @param {string} orgId
3631
+ * @param {*} [options] Override http request option.
3632
+ * @throws {RequiredError}
3633
+ * @memberof UserPermissionsApi
3634
+ */
3635
+ public listOrgRoles(orgId: string, options?: RawAxiosRequestConfig) {
3636
+ return UserPermissionsApiFp(this.configuration).listOrgRoles(orgId, options).then((request) => request(this.axios, this.basePath));
3637
+ }
3638
+
2261
3639
  /**
2262
3640
  * List the available permissions for the current user
2263
3641
  * @summary List Own Permissions