@flipdish/authorization 0.2.42 → 0.2.44-rc.1786457217
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/.openapi-generator/FILES +1 -0
- package/api.ts +986 -28
- package/common.ts +2 -2
- package/configuration.ts +1 -1
- package/dist/api.d.ts +692 -21
- package/dist/api.js +715 -9
- package/dist/common.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -13,6 +13,110 @@ import type { Configuration } from './configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AccessRequestResponse
|
|
20
|
+
*/
|
|
21
|
+
export interface AccessRequestResponse {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof AccessRequestResponse
|
|
26
|
+
*/
|
|
27
|
+
'requestId': string;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AccessRequestResponse
|
|
32
|
+
*/
|
|
33
|
+
'state': AccessRequestResponseStateEnum;
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof AccessRequestResponse
|
|
38
|
+
*/
|
|
39
|
+
'requesterUserId': string;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof AccessRequestResponse
|
|
44
|
+
*/
|
|
45
|
+
'requesterEmail': string;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof AccessRequestResponse
|
|
50
|
+
*/
|
|
51
|
+
'orgId': string;
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof AccessRequestResponse
|
|
56
|
+
*/
|
|
57
|
+
'orgName': string;
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @type {Array<string>}
|
|
61
|
+
* @memberof AccessRequestResponse
|
|
62
|
+
*/
|
|
63
|
+
'propertyIds': Array<string>;
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @type {Array<string>}
|
|
67
|
+
* @memberof AccessRequestResponse
|
|
68
|
+
*/
|
|
69
|
+
'brandIds': Array<string>;
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @type {Array<string>}
|
|
73
|
+
* @memberof AccessRequestResponse
|
|
74
|
+
*/
|
|
75
|
+
'salesChannelIds': Array<string>;
|
|
76
|
+
/**
|
|
77
|
+
*
|
|
78
|
+
* @type {string}
|
|
79
|
+
* @memberof AccessRequestResponse
|
|
80
|
+
*/
|
|
81
|
+
'roleName': AccessRequestResponseRoleNameEnum;
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @type {string}
|
|
85
|
+
* @memberof AccessRequestResponse
|
|
86
|
+
*/
|
|
87
|
+
'createdAt': string;
|
|
88
|
+
/**
|
|
89
|
+
*
|
|
90
|
+
* @type {string}
|
|
91
|
+
* @memberof AccessRequestResponse
|
|
92
|
+
*/
|
|
93
|
+
'decidedAt'?: string;
|
|
94
|
+
/**
|
|
95
|
+
*
|
|
96
|
+
* @type {string}
|
|
97
|
+
* @memberof AccessRequestResponse
|
|
98
|
+
*/
|
|
99
|
+
'decidedByUserId'?: string;
|
|
100
|
+
}
|
|
101
|
+
export declare const AccessRequestResponseStateEnum: {
|
|
102
|
+
readonly Pending: "Pending";
|
|
103
|
+
readonly Approved: "Approved";
|
|
104
|
+
readonly Rejected: "Rejected";
|
|
105
|
+
readonly Expired: "Expired";
|
|
106
|
+
};
|
|
107
|
+
export type AccessRequestResponseStateEnum = typeof AccessRequestResponseStateEnum[keyof typeof AccessRequestResponseStateEnum];
|
|
108
|
+
export declare const AccessRequestResponseRoleNameEnum: {
|
|
109
|
+
readonly Owner: "Owner";
|
|
110
|
+
readonly PropertyOwner: "PropertyOwner";
|
|
111
|
+
readonly ManagedOwner: "ManagedOwner";
|
|
112
|
+
readonly Integrator: "Integrator";
|
|
113
|
+
readonly PropertyManager: "PropertyManager";
|
|
114
|
+
readonly FinanceManager: "FinanceManager";
|
|
115
|
+
readonly StaffMember: "StaffMember";
|
|
116
|
+
readonly Kiosk: "Kiosk";
|
|
117
|
+
readonly Terminal: "Terminal";
|
|
118
|
+
};
|
|
119
|
+
export type AccessRequestResponseRoleNameEnum = typeof AccessRequestResponseRoleNameEnum[keyof typeof AccessRequestResponseRoleNameEnum];
|
|
16
120
|
/**
|
|
17
121
|
* 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.
|
|
18
122
|
* @export
|
|
@@ -316,6 +420,8 @@ export interface AuthorizationRequestPrincipal {
|
|
|
316
420
|
export declare const AuthorizationRequestPrincipalTypeEnum: {
|
|
317
421
|
readonly User: "User";
|
|
318
422
|
readonly Automation: "Automation";
|
|
423
|
+
readonly Kiosk: "Kiosk";
|
|
424
|
+
readonly Terminal: "Terminal";
|
|
319
425
|
};
|
|
320
426
|
export type AuthorizationRequestPrincipalTypeEnum = typeof AuthorizationRequestPrincipalTypeEnum[keyof typeof AuthorizationRequestPrincipalTypeEnum];
|
|
321
427
|
/**
|
|
@@ -440,6 +546,44 @@ export interface AuthorizationResponse {
|
|
|
440
546
|
*/
|
|
441
547
|
'policyIds': Array<string>;
|
|
442
548
|
}
|
|
549
|
+
/**
|
|
550
|
+
*
|
|
551
|
+
* @export
|
|
552
|
+
* @interface CreateInviteTokenRequest
|
|
553
|
+
*/
|
|
554
|
+
export interface CreateInviteTokenRequest {
|
|
555
|
+
/**
|
|
556
|
+
*
|
|
557
|
+
* @type {string}
|
|
558
|
+
* @memberof CreateInviteTokenRequest
|
|
559
|
+
*/
|
|
560
|
+
'storefrontId': string;
|
|
561
|
+
/**
|
|
562
|
+
*
|
|
563
|
+
* @type {string}
|
|
564
|
+
* @memberof CreateInviteTokenRequest
|
|
565
|
+
*/
|
|
566
|
+
'propertyId': string;
|
|
567
|
+
/**
|
|
568
|
+
*
|
|
569
|
+
* @type {string}
|
|
570
|
+
* @memberof CreateInviteTokenRequest
|
|
571
|
+
*/
|
|
572
|
+
'orgName': string;
|
|
573
|
+
}
|
|
574
|
+
/**
|
|
575
|
+
*
|
|
576
|
+
* @export
|
|
577
|
+
* @interface CreateJoinRequest
|
|
578
|
+
*/
|
|
579
|
+
export interface CreateJoinRequest {
|
|
580
|
+
/**
|
|
581
|
+
*
|
|
582
|
+
* @type {string}
|
|
583
|
+
* @memberof CreateJoinRequest
|
|
584
|
+
*/
|
|
585
|
+
'token': string;
|
|
586
|
+
}
|
|
443
587
|
/**
|
|
444
588
|
*
|
|
445
589
|
* @export
|
|
@@ -566,6 +710,8 @@ export interface GetAuthorizedOrgsRequestPrincipal {
|
|
|
566
710
|
export declare const GetAuthorizedOrgsRequestPrincipalTypeEnum: {
|
|
567
711
|
readonly User: "User";
|
|
568
712
|
readonly Automation: "Automation";
|
|
713
|
+
readonly Kiosk: "Kiosk";
|
|
714
|
+
readonly Terminal: "Terminal";
|
|
569
715
|
};
|
|
570
716
|
export type GetAuthorizedOrgsRequestPrincipalTypeEnum = typeof GetAuthorizedOrgsRequestPrincipalTypeEnum[keyof typeof GetAuthorizedOrgsRequestPrincipalTypeEnum];
|
|
571
717
|
/**
|
|
@@ -633,6 +779,110 @@ export interface GetAuthorizedPropertiesResponse {
|
|
|
633
779
|
*/
|
|
634
780
|
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
635
781
|
}
|
|
782
|
+
/**
|
|
783
|
+
*
|
|
784
|
+
* @export
|
|
785
|
+
* @interface GetJoinAccessRequest200Response
|
|
786
|
+
*/
|
|
787
|
+
export interface GetJoinAccessRequest200Response {
|
|
788
|
+
/**
|
|
789
|
+
*
|
|
790
|
+
* @type {string}
|
|
791
|
+
* @memberof GetJoinAccessRequest200Response
|
|
792
|
+
*/
|
|
793
|
+
'requestId': string;
|
|
794
|
+
/**
|
|
795
|
+
*
|
|
796
|
+
* @type {string}
|
|
797
|
+
* @memberof GetJoinAccessRequest200Response
|
|
798
|
+
*/
|
|
799
|
+
'state': GetJoinAccessRequest200ResponseStateEnum;
|
|
800
|
+
/**
|
|
801
|
+
*
|
|
802
|
+
* @type {string}
|
|
803
|
+
* @memberof GetJoinAccessRequest200Response
|
|
804
|
+
*/
|
|
805
|
+
'requesterUserId': string;
|
|
806
|
+
/**
|
|
807
|
+
*
|
|
808
|
+
* @type {string}
|
|
809
|
+
* @memberof GetJoinAccessRequest200Response
|
|
810
|
+
*/
|
|
811
|
+
'requesterEmail': string;
|
|
812
|
+
/**
|
|
813
|
+
*
|
|
814
|
+
* @type {string}
|
|
815
|
+
* @memberof GetJoinAccessRequest200Response
|
|
816
|
+
*/
|
|
817
|
+
'orgId': string;
|
|
818
|
+
/**
|
|
819
|
+
*
|
|
820
|
+
* @type {string}
|
|
821
|
+
* @memberof GetJoinAccessRequest200Response
|
|
822
|
+
*/
|
|
823
|
+
'orgName': string;
|
|
824
|
+
/**
|
|
825
|
+
*
|
|
826
|
+
* @type {Array<string>}
|
|
827
|
+
* @memberof GetJoinAccessRequest200Response
|
|
828
|
+
*/
|
|
829
|
+
'propertyIds': Array<string>;
|
|
830
|
+
/**
|
|
831
|
+
*
|
|
832
|
+
* @type {Array<string>}
|
|
833
|
+
* @memberof GetJoinAccessRequest200Response
|
|
834
|
+
*/
|
|
835
|
+
'brandIds': Array<string>;
|
|
836
|
+
/**
|
|
837
|
+
*
|
|
838
|
+
* @type {Array<string>}
|
|
839
|
+
* @memberof GetJoinAccessRequest200Response
|
|
840
|
+
*/
|
|
841
|
+
'salesChannelIds': Array<string>;
|
|
842
|
+
/**
|
|
843
|
+
*
|
|
844
|
+
* @type {string}
|
|
845
|
+
* @memberof GetJoinAccessRequest200Response
|
|
846
|
+
*/
|
|
847
|
+
'roleName': GetJoinAccessRequest200ResponseRoleNameEnum;
|
|
848
|
+
/**
|
|
849
|
+
*
|
|
850
|
+
* @type {string}
|
|
851
|
+
* @memberof GetJoinAccessRequest200Response
|
|
852
|
+
*/
|
|
853
|
+
'createdAt': string;
|
|
854
|
+
/**
|
|
855
|
+
*
|
|
856
|
+
* @type {string}
|
|
857
|
+
* @memberof GetJoinAccessRequest200Response
|
|
858
|
+
*/
|
|
859
|
+
'decidedAt'?: string;
|
|
860
|
+
/**
|
|
861
|
+
*
|
|
862
|
+
* @type {string}
|
|
863
|
+
* @memberof GetJoinAccessRequest200Response
|
|
864
|
+
*/
|
|
865
|
+
'decidedByUserId'?: string;
|
|
866
|
+
}
|
|
867
|
+
export declare const GetJoinAccessRequest200ResponseStateEnum: {
|
|
868
|
+
readonly Pending: "Pending";
|
|
869
|
+
readonly Approved: "Approved";
|
|
870
|
+
readonly Rejected: "Rejected";
|
|
871
|
+
readonly Expired: "Expired";
|
|
872
|
+
};
|
|
873
|
+
export type GetJoinAccessRequest200ResponseStateEnum = typeof GetJoinAccessRequest200ResponseStateEnum[keyof typeof GetJoinAccessRequest200ResponseStateEnum];
|
|
874
|
+
export declare const GetJoinAccessRequest200ResponseRoleNameEnum: {
|
|
875
|
+
readonly Owner: "Owner";
|
|
876
|
+
readonly PropertyOwner: "PropertyOwner";
|
|
877
|
+
readonly ManagedOwner: "ManagedOwner";
|
|
878
|
+
readonly Integrator: "Integrator";
|
|
879
|
+
readonly PropertyManager: "PropertyManager";
|
|
880
|
+
readonly FinanceManager: "FinanceManager";
|
|
881
|
+
readonly StaffMember: "StaffMember";
|
|
882
|
+
readonly Kiosk: "Kiosk";
|
|
883
|
+
readonly Terminal: "Terminal";
|
|
884
|
+
};
|
|
885
|
+
export type GetJoinAccessRequest200ResponseRoleNameEnum = typeof GetJoinAccessRequest200ResponseRoleNameEnum[keyof typeof GetJoinAccessRequest200ResponseRoleNameEnum];
|
|
636
886
|
/**
|
|
637
887
|
* Successful user permissions retrieval response
|
|
638
888
|
* @export
|
|
@@ -687,6 +937,73 @@ export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = ty
|
|
|
687
937
|
*/
|
|
688
938
|
export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
|
|
689
939
|
}
|
|
940
|
+
/**
|
|
941
|
+
*
|
|
942
|
+
* @export
|
|
943
|
+
* @interface InviteTokenResponse
|
|
944
|
+
*/
|
|
945
|
+
export interface InviteTokenResponse {
|
|
946
|
+
/**
|
|
947
|
+
*
|
|
948
|
+
* @type {string}
|
|
949
|
+
* @memberof InviteTokenResponse
|
|
950
|
+
*/
|
|
951
|
+
'tokenId': string;
|
|
952
|
+
/**
|
|
953
|
+
*
|
|
954
|
+
* @type {string}
|
|
955
|
+
* @memberof InviteTokenResponse
|
|
956
|
+
*/
|
|
957
|
+
'joinUrl': string;
|
|
958
|
+
/**
|
|
959
|
+
*
|
|
960
|
+
* @type {string}
|
|
961
|
+
* @memberof InviteTokenResponse
|
|
962
|
+
*/
|
|
963
|
+
'expiresAt': string;
|
|
964
|
+
/**
|
|
965
|
+
*
|
|
966
|
+
* @type {string}
|
|
967
|
+
* @memberof InviteTokenResponse
|
|
968
|
+
*/
|
|
969
|
+
'orgId': string;
|
|
970
|
+
/**
|
|
971
|
+
*
|
|
972
|
+
* @type {Array<string>}
|
|
973
|
+
* @memberof InviteTokenResponse
|
|
974
|
+
*/
|
|
975
|
+
'brandIds': Array<string>;
|
|
976
|
+
/**
|
|
977
|
+
*
|
|
978
|
+
* @type {Array<string>}
|
|
979
|
+
* @memberof InviteTokenResponse
|
|
980
|
+
*/
|
|
981
|
+
'propertyIds': Array<string>;
|
|
982
|
+
/**
|
|
983
|
+
*
|
|
984
|
+
* @type {Array<string>}
|
|
985
|
+
* @memberof InviteTokenResponse
|
|
986
|
+
*/
|
|
987
|
+
'salesChannelIds': Array<string>;
|
|
988
|
+
/**
|
|
989
|
+
*
|
|
990
|
+
* @type {string}
|
|
991
|
+
* @memberof InviteTokenResponse
|
|
992
|
+
*/
|
|
993
|
+
'roleName': InviteTokenResponseRoleNameEnum;
|
|
994
|
+
}
|
|
995
|
+
export declare const InviteTokenResponseRoleNameEnum: {
|
|
996
|
+
readonly Owner: "Owner";
|
|
997
|
+
readonly PropertyOwner: "PropertyOwner";
|
|
998
|
+
readonly ManagedOwner: "ManagedOwner";
|
|
999
|
+
readonly Integrator: "Integrator";
|
|
1000
|
+
readonly PropertyManager: "PropertyManager";
|
|
1001
|
+
readonly FinanceManager: "FinanceManager";
|
|
1002
|
+
readonly StaffMember: "StaffMember";
|
|
1003
|
+
readonly Kiosk: "Kiosk";
|
|
1004
|
+
readonly Terminal: "Terminal";
|
|
1005
|
+
};
|
|
1006
|
+
export type InviteTokenResponseRoleNameEnum = typeof InviteTokenResponseRoleNameEnum[keyof typeof InviteTokenResponseRoleNameEnum];
|
|
690
1007
|
/**
|
|
691
1008
|
*
|
|
692
1009
|
* @export
|
|
@@ -730,6 +1047,42 @@ export interface IsInRoleResponse {
|
|
|
730
1047
|
*/
|
|
731
1048
|
'authorized': boolean;
|
|
732
1049
|
}
|
|
1050
|
+
/**
|
|
1051
|
+
*
|
|
1052
|
+
* @export
|
|
1053
|
+
* @interface JoinAccessErrorResponse
|
|
1054
|
+
*/
|
|
1055
|
+
export interface JoinAccessErrorResponse {
|
|
1056
|
+
/**
|
|
1057
|
+
*
|
|
1058
|
+
* @type {string}
|
|
1059
|
+
* @memberof JoinAccessErrorResponse
|
|
1060
|
+
*/
|
|
1061
|
+
'code': JoinAccessErrorResponseCodeEnum;
|
|
1062
|
+
/**
|
|
1063
|
+
*
|
|
1064
|
+
* @type {string}
|
|
1065
|
+
* @memberof JoinAccessErrorResponse
|
|
1066
|
+
*/
|
|
1067
|
+
'message': string;
|
|
1068
|
+
}
|
|
1069
|
+
export declare const JoinAccessErrorResponseCodeEnum: {
|
|
1070
|
+
readonly AlreadyMember: "ALREADY_MEMBER";
|
|
1071
|
+
};
|
|
1072
|
+
export type JoinAccessErrorResponseCodeEnum = typeof JoinAccessErrorResponseCodeEnum[keyof typeof JoinAccessErrorResponseCodeEnum];
|
|
1073
|
+
/**
|
|
1074
|
+
*
|
|
1075
|
+
* @export
|
|
1076
|
+
* @interface ListJoinRequestsResponse
|
|
1077
|
+
*/
|
|
1078
|
+
export interface ListJoinRequestsResponse {
|
|
1079
|
+
/**
|
|
1080
|
+
*
|
|
1081
|
+
* @type {Array<GetJoinAccessRequest200Response>}
|
|
1082
|
+
* @memberof ListJoinRequestsResponse
|
|
1083
|
+
*/
|
|
1084
|
+
'items': Array<GetJoinAccessRequest200Response>;
|
|
1085
|
+
}
|
|
733
1086
|
/**
|
|
734
1087
|
*
|
|
735
1088
|
* @export
|
|
@@ -780,6 +1133,9 @@ export declare const ListOrgRolesSuccessResponseValueRolesEnum: {
|
|
|
780
1133
|
readonly Integrator: "Integrator";
|
|
781
1134
|
readonly PropertyManager: "PropertyManager";
|
|
782
1135
|
readonly FinanceManager: "FinanceManager";
|
|
1136
|
+
readonly StaffMember: "StaffMember";
|
|
1137
|
+
readonly Kiosk: "Kiosk";
|
|
1138
|
+
readonly Terminal: "Terminal";
|
|
783
1139
|
};
|
|
784
1140
|
export type ListOrgRolesSuccessResponseValueRolesEnum = typeof ListOrgRolesSuccessResponseValueRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueRolesEnum];
|
|
785
1141
|
/**
|
|
@@ -862,6 +1218,7 @@ export declare const Permissions: {
|
|
|
862
1218
|
readonly CreateTeammateOnboarding: "CreateTeammateOnboarding";
|
|
863
1219
|
readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager";
|
|
864
1220
|
readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner";
|
|
1221
|
+
readonly CreateTeammateStaffMember: "CreateTeammateStaffMember";
|
|
865
1222
|
readonly ViewApmConfigurations: "ViewApmConfigurations";
|
|
866
1223
|
readonly EditApmConfigurations: "EditApmConfigurations";
|
|
867
1224
|
readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations";
|
|
@@ -930,6 +1287,7 @@ export declare const Permissions: {
|
|
|
930
1287
|
readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode";
|
|
931
1288
|
readonly DeleteTerminal: "DeleteTerminal";
|
|
932
1289
|
readonly ViewKioskTelemetry: "ViewKioskTelemetry";
|
|
1290
|
+
readonly HydraOnly: "HydraOnly";
|
|
933
1291
|
readonly ViewCustomers: "ViewCustomers";
|
|
934
1292
|
readonly EditCustomers: "EditCustomers";
|
|
935
1293
|
readonly CreateCustomers: "CreateCustomers";
|
|
@@ -1074,6 +1432,56 @@ export declare const Permissions: {
|
|
|
1074
1432
|
readonly RoleAuthDeveloper: "RoleAuthDeveloper";
|
|
1075
1433
|
};
|
|
1076
1434
|
export type Permissions = typeof Permissions[keyof typeof Permissions];
|
|
1435
|
+
/**
|
|
1436
|
+
* Principal in an org, optionally including last active timestamp
|
|
1437
|
+
* @export
|
|
1438
|
+
* @interface PrincipalInOrg
|
|
1439
|
+
*/
|
|
1440
|
+
export interface PrincipalInOrg {
|
|
1441
|
+
/**
|
|
1442
|
+
*
|
|
1443
|
+
* @type {string}
|
|
1444
|
+
* @memberof PrincipalInOrg
|
|
1445
|
+
*/
|
|
1446
|
+
'type': PrincipalInOrgTypeEnum;
|
|
1447
|
+
/**
|
|
1448
|
+
*
|
|
1449
|
+
* @type {string}
|
|
1450
|
+
* @memberof PrincipalInOrg
|
|
1451
|
+
*/
|
|
1452
|
+
'id': string;
|
|
1453
|
+
/**
|
|
1454
|
+
*
|
|
1455
|
+
* @type {string}
|
|
1456
|
+
* @memberof PrincipalInOrg
|
|
1457
|
+
*/
|
|
1458
|
+
'name'?: string;
|
|
1459
|
+
/**
|
|
1460
|
+
*
|
|
1461
|
+
* @type {string}
|
|
1462
|
+
* @memberof PrincipalInOrg
|
|
1463
|
+
*/
|
|
1464
|
+
'email'?: string;
|
|
1465
|
+
/**
|
|
1466
|
+
*
|
|
1467
|
+
* @type {string}
|
|
1468
|
+
* @memberof PrincipalInOrg
|
|
1469
|
+
*/
|
|
1470
|
+
'phone'?: string;
|
|
1471
|
+
/**
|
|
1472
|
+
* ISO-8601 UTC timestamp of last authorization activity in this org
|
|
1473
|
+
* @type {string}
|
|
1474
|
+
* @memberof PrincipalInOrg
|
|
1475
|
+
*/
|
|
1476
|
+
'lastActiveAt'?: string;
|
|
1477
|
+
}
|
|
1478
|
+
export declare const PrincipalInOrgTypeEnum: {
|
|
1479
|
+
readonly User: "User";
|
|
1480
|
+
readonly Automation: "Automation";
|
|
1481
|
+
readonly Kiosk: "Kiosk";
|
|
1482
|
+
readonly Terminal: "Terminal";
|
|
1483
|
+
};
|
|
1484
|
+
export type PrincipalInOrgTypeEnum = typeof PrincipalInOrgTypeEnum[keyof typeof PrincipalInOrgTypeEnum];
|
|
1077
1485
|
/**
|
|
1078
1486
|
* Principals in org
|
|
1079
1487
|
* @export
|
|
@@ -1088,10 +1496,10 @@ export interface PrincipalsInOrgResponse {
|
|
|
1088
1496
|
'orgId': string;
|
|
1089
1497
|
/**
|
|
1090
1498
|
* List of principals in org
|
|
1091
|
-
* @type {Array<
|
|
1499
|
+
* @type {Array<PrincipalInOrg>}
|
|
1092
1500
|
* @memberof PrincipalsInOrgResponse
|
|
1093
1501
|
*/
|
|
1094
|
-
'principals': Array<
|
|
1502
|
+
'principals': Array<PrincipalInOrg>;
|
|
1095
1503
|
}
|
|
1096
1504
|
/**
|
|
1097
1505
|
* Role assignment key to rematerialize
|
|
@@ -1252,6 +1660,8 @@ export interface RemoveTeammateRequestBodyActor {
|
|
|
1252
1660
|
export declare const RemoveTeammateRequestBodyActorTypeEnum: {
|
|
1253
1661
|
readonly User: "User";
|
|
1254
1662
|
readonly Automation: "Automation";
|
|
1663
|
+
readonly Kiosk: "Kiosk";
|
|
1664
|
+
readonly Terminal: "Terminal";
|
|
1255
1665
|
};
|
|
1256
1666
|
export type RemoveTeammateRequestBodyActorTypeEnum = typeof RemoveTeammateRequestBodyActorTypeEnum[keyof typeof RemoveTeammateRequestBodyActorTypeEnum];
|
|
1257
1667
|
/**
|
|
@@ -1294,6 +1704,8 @@ export interface RemoveTeammateRequestBodyPrincipal {
|
|
|
1294
1704
|
export declare const RemoveTeammateRequestBodyPrincipalTypeEnum: {
|
|
1295
1705
|
readonly User: "User";
|
|
1296
1706
|
readonly Automation: "Automation";
|
|
1707
|
+
readonly Kiosk: "Kiosk";
|
|
1708
|
+
readonly Terminal: "Terminal";
|
|
1297
1709
|
};
|
|
1298
1710
|
export type RemoveTeammateRequestBodyPrincipalTypeEnum = typeof RemoveTeammateRequestBodyPrincipalTypeEnum[keyof typeof RemoveTeammateRequestBodyPrincipalTypeEnum];
|
|
1299
1711
|
/**
|
|
@@ -1365,6 +1777,9 @@ export declare const RoleAssignmentRequestBodyRoleNameEnum: {
|
|
|
1365
1777
|
readonly Integrator: "Integrator";
|
|
1366
1778
|
readonly PropertyManager: "PropertyManager";
|
|
1367
1779
|
readonly FinanceManager: "FinanceManager";
|
|
1780
|
+
readonly StaffMember: "StaffMember";
|
|
1781
|
+
readonly Kiosk: "Kiosk";
|
|
1782
|
+
readonly Terminal: "Terminal";
|
|
1368
1783
|
};
|
|
1369
1784
|
export type RoleAssignmentRequestBodyRoleNameEnum = typeof RoleAssignmentRequestBodyRoleNameEnum[keyof typeof RoleAssignmentRequestBodyRoleNameEnum];
|
|
1370
1785
|
/**
|
|
@@ -1407,6 +1822,8 @@ export interface RoleAssignmentRequestBodyActor {
|
|
|
1407
1822
|
export declare const RoleAssignmentRequestBodyActorTypeEnum: {
|
|
1408
1823
|
readonly User: "User";
|
|
1409
1824
|
readonly Automation: "Automation";
|
|
1825
|
+
readonly Kiosk: "Kiosk";
|
|
1826
|
+
readonly Terminal: "Terminal";
|
|
1410
1827
|
};
|
|
1411
1828
|
export type RoleAssignmentRequestBodyActorTypeEnum = typeof RoleAssignmentRequestBodyActorTypeEnum[keyof typeof RoleAssignmentRequestBodyActorTypeEnum];
|
|
1412
1829
|
/**
|
|
@@ -1449,6 +1866,8 @@ export interface RoleAssignmentRequestBodyPrincipal {
|
|
|
1449
1866
|
export declare const RoleAssignmentRequestBodyPrincipalTypeEnum: {
|
|
1450
1867
|
readonly User: "User";
|
|
1451
1868
|
readonly Automation: "Automation";
|
|
1869
|
+
readonly Kiosk: "Kiosk";
|
|
1870
|
+
readonly Terminal: "Terminal";
|
|
1452
1871
|
};
|
|
1453
1872
|
export type RoleAssignmentRequestBodyPrincipalTypeEnum = typeof RoleAssignmentRequestBodyPrincipalTypeEnum[keyof typeof RoleAssignmentRequestBodyPrincipalTypeEnum];
|
|
1454
1873
|
/**
|
|
@@ -1558,7 +1977,7 @@ export declare class AuthenticationApi extends BaseAPI {
|
|
|
1558
1977
|
* @throws {RequiredError}
|
|
1559
1978
|
* @memberof AuthenticationApi
|
|
1560
1979
|
*/
|
|
1561
|
-
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}>>;
|
|
1980
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}, any>>;
|
|
1562
1981
|
}
|
|
1563
1982
|
/**
|
|
1564
1983
|
* AuthorizationApi - axios parameter creator
|
|
@@ -1713,7 +2132,7 @@ export declare class AuthorizationApi extends BaseAPI {
|
|
|
1713
2132
|
* @throws {RequiredError}
|
|
1714
2133
|
* @memberof AuthorizationApi
|
|
1715
2134
|
*/
|
|
1716
|
-
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}>>;
|
|
2135
|
+
authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndAuthorizeResponse, any, {}, any>>;
|
|
1717
2136
|
/**
|
|
1718
2137
|
* Authenticate and check if a user is in any/all of the roles
|
|
1719
2138
|
* @summary Authenticate and Check Is In Role
|
|
@@ -1722,7 +2141,7 @@ export declare class AuthorizationApi extends BaseAPI {
|
|
|
1722
2141
|
* @throws {RequiredError}
|
|
1723
2142
|
* @memberof AuthorizationApi
|
|
1724
2143
|
*/
|
|
1725
|
-
authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndCheckIsInRoleResponse, any, {}>>;
|
|
2144
|
+
authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthenticateAndCheckIsInRoleResponse, any, {}, any>>;
|
|
1726
2145
|
/**
|
|
1727
2146
|
* Check if a user is authorized to perform an action
|
|
1728
2147
|
* @summary Authorize Request
|
|
@@ -1731,7 +2150,7 @@ export declare class AuthorizationApi extends BaseAPI {
|
|
|
1731
2150
|
* @throws {RequiredError}
|
|
1732
2151
|
* @memberof AuthorizationApi
|
|
1733
2152
|
*/
|
|
1734
|
-
authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationResponse, any, {}>>;
|
|
2153
|
+
authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationResponse, any, {}, any>>;
|
|
1735
2154
|
/**
|
|
1736
2155
|
* Check if a user is authorized to perform an action on multiple resources
|
|
1737
2156
|
* @summary Authorize Batch Request
|
|
@@ -1740,7 +2159,7 @@ export declare class AuthorizationApi extends BaseAPI {
|
|
|
1740
2159
|
* @throws {RequiredError}
|
|
1741
2160
|
* @memberof AuthorizationApi
|
|
1742
2161
|
*/
|
|
1743
|
-
authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationBatchResponse, any, {}>>;
|
|
2162
|
+
authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthorizationBatchResponse, any, {}, any>>;
|
|
1744
2163
|
/**
|
|
1745
2164
|
* Check if a user is in any/all of the roles
|
|
1746
2165
|
* @summary Check Is In Role
|
|
@@ -1749,7 +2168,7 @@ export declare class AuthorizationApi extends BaseAPI {
|
|
|
1749
2168
|
* @throws {RequiredError}
|
|
1750
2169
|
* @memberof AuthorizationApi
|
|
1751
2170
|
*/
|
|
1752
|
-
checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IsInRoleResponse, any, {}>>;
|
|
2171
|
+
checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IsInRoleResponse, any, {}, any>>;
|
|
1753
2172
|
}
|
|
1754
2173
|
/**
|
|
1755
2174
|
* AuthorizedEntitiesApi - axios parameter creator
|
|
@@ -1863,7 +2282,7 @@ export declare class AuthorizedEntitiesApi extends BaseAPI {
|
|
|
1863
2282
|
* @throws {RequiredError}
|
|
1864
2283
|
* @memberof AuthorizedEntitiesApi
|
|
1865
2284
|
*/
|
|
1866
|
-
getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedBrandsResponse, any, {}>>;
|
|
2285
|
+
getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedBrandsResponse, any, {}, any>>;
|
|
1867
2286
|
/**
|
|
1868
2287
|
* Get the authorized orgs for a given principal
|
|
1869
2288
|
* @summary Get Authorized Orgs
|
|
@@ -1872,7 +2291,7 @@ export declare class AuthorizedEntitiesApi extends BaseAPI {
|
|
|
1872
2291
|
* @throws {RequiredError}
|
|
1873
2292
|
* @memberof AuthorizedEntitiesApi
|
|
1874
2293
|
*/
|
|
1875
|
-
getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedOrgsResponse, any, {}>>;
|
|
2294
|
+
getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedOrgsResponse, any, {}, any>>;
|
|
1876
2295
|
/**
|
|
1877
2296
|
* Get the authorized properties for a given org
|
|
1878
2297
|
* @summary Get Authorized Properties
|
|
@@ -1882,7 +2301,7 @@ export declare class AuthorizedEntitiesApi extends BaseAPI {
|
|
|
1882
2301
|
* @throws {RequiredError}
|
|
1883
2302
|
* @memberof AuthorizedEntitiesApi
|
|
1884
2303
|
*/
|
|
1885
|
-
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedPropertiesResponse, any, {}>>;
|
|
2304
|
+
getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAuthorizedPropertiesResponse, any, {}, any>>;
|
|
1886
2305
|
}
|
|
1887
2306
|
/**
|
|
1888
2307
|
* ConfigurationDataApi - axios parameter creator
|
|
@@ -1958,7 +2377,7 @@ export declare class ConfigurationDataApi extends BaseAPI {
|
|
|
1958
2377
|
* @throws {RequiredError}
|
|
1959
2378
|
* @memberof ConfigurationDataApi
|
|
1960
2379
|
*/
|
|
1961
|
-
listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}>>;
|
|
2380
|
+
listPermissions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPermissionsSuccessResponse, any, {}, any>>;
|
|
1962
2381
|
/**
|
|
1963
2382
|
* List the available roles
|
|
1964
2383
|
* @summary List Roles
|
|
@@ -1966,7 +2385,259 @@ export declare class ConfigurationDataApi extends BaseAPI {
|
|
|
1966
2385
|
* @throws {RequiredError}
|
|
1967
2386
|
* @memberof ConfigurationDataApi
|
|
1968
2387
|
*/
|
|
1969
|
-
listRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}>>;
|
|
2388
|
+
listRoles(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRolesSuccessResponse, any, {}, any>>;
|
|
2389
|
+
}
|
|
2390
|
+
/**
|
|
2391
|
+
* JoinAccessApi - axios parameter creator
|
|
2392
|
+
* @export
|
|
2393
|
+
*/
|
|
2394
|
+
export declare const JoinAccessApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2395
|
+
/**
|
|
2396
|
+
* Grants the role stored on the access request (copied from the invite token at create time) via AuthZ V2 role assignment (source join).
|
|
2397
|
+
* @summary Accept a pending join access request
|
|
2398
|
+
* @param {string} orgId
|
|
2399
|
+
* @param {string} requestId
|
|
2400
|
+
* @param {*} [options] Override http request option.
|
|
2401
|
+
* @throws {RequiredError}
|
|
2402
|
+
*/
|
|
2403
|
+
acceptJoinAccessRequest: (orgId: string, requestId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2404
|
+
/**
|
|
2405
|
+
* Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one.
|
|
2406
|
+
* @summary Create an invite token
|
|
2407
|
+
* @param {string} orgId
|
|
2408
|
+
* @param {CreateInviteTokenRequest} [createInviteTokenRequest]
|
|
2409
|
+
* @param {*} [options] Override http request option.
|
|
2410
|
+
* @throws {RequiredError}
|
|
2411
|
+
*/
|
|
2412
|
+
createInviteToken: (orgId: string, createInviteTokenRequest?: CreateInviteTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2413
|
+
/**
|
|
2414
|
+
* Validates the opaque invite token and creates (or returns) a pending AccessRequest for the property/role encoded on the token.
|
|
2415
|
+
* @summary Submit a join access request from an invite token
|
|
2416
|
+
* @param {string} orgId
|
|
2417
|
+
* @param {CreateJoinRequest} [createJoinRequest]
|
|
2418
|
+
* @param {*} [options] Override http request option.
|
|
2419
|
+
* @throws {RequiredError}
|
|
2420
|
+
*/
|
|
2421
|
+
createJoinAccessRequest: (orgId: string, createJoinRequest?: CreateJoinRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2422
|
+
/**
|
|
2423
|
+
* Returns request status for the authenticated requester only. Owners should use the list endpoint.
|
|
2424
|
+
* @summary Get a join access request by id
|
|
2425
|
+
* @param {string} orgId
|
|
2426
|
+
* @param {string} requestId
|
|
2427
|
+
* @param {*} [options] Override http request option.
|
|
2428
|
+
* @throws {RequiredError}
|
|
2429
|
+
*/
|
|
2430
|
+
getJoinAccessRequest: (orgId: string, requestId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2431
|
+
/**
|
|
2432
|
+
* Returns pending AccessRequests for an org. Optional propertyId/brandId filters. Requires ViewTeammates on orgId.
|
|
2433
|
+
* @summary List pending join requests for an organization
|
|
2434
|
+
* @param {string} orgId
|
|
2435
|
+
* @param {string} [propertyId]
|
|
2436
|
+
* @param {string} [brandId]
|
|
2437
|
+
* @param {*} [options] Override http request option.
|
|
2438
|
+
* @throws {RequiredError}
|
|
2439
|
+
*/
|
|
2440
|
+
listJoinAccessRequests: (orgId: string, propertyId?: string, brandId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2441
|
+
/**
|
|
2442
|
+
* Rejects a pending AccessRequest without granting access.
|
|
2443
|
+
* @summary Reject a pending join access request
|
|
2444
|
+
* @param {string} orgId
|
|
2445
|
+
* @param {string} requestId
|
|
2446
|
+
* @param {*} [options] Override http request option.
|
|
2447
|
+
* @throws {RequiredError}
|
|
2448
|
+
*/
|
|
2449
|
+
rejectJoinAccessRequest: (orgId: string, requestId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2450
|
+
};
|
|
2451
|
+
/**
|
|
2452
|
+
* JoinAccessApi - functional programming interface
|
|
2453
|
+
* @export
|
|
2454
|
+
*/
|
|
2455
|
+
export declare const JoinAccessApiFp: (configuration?: Configuration) => {
|
|
2456
|
+
/**
|
|
2457
|
+
* Grants the role stored on the access request (copied from the invite token at create time) via AuthZ V2 role assignment (source join).
|
|
2458
|
+
* @summary Accept a pending join access request
|
|
2459
|
+
* @param {string} orgId
|
|
2460
|
+
* @param {string} requestId
|
|
2461
|
+
* @param {*} [options] Override http request option.
|
|
2462
|
+
* @throws {RequiredError}
|
|
2463
|
+
*/
|
|
2464
|
+
acceptJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJoinAccessRequest200Response>>;
|
|
2465
|
+
/**
|
|
2466
|
+
* Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one.
|
|
2467
|
+
* @summary Create an invite token
|
|
2468
|
+
* @param {string} orgId
|
|
2469
|
+
* @param {CreateInviteTokenRequest} [createInviteTokenRequest]
|
|
2470
|
+
* @param {*} [options] Override http request option.
|
|
2471
|
+
* @throws {RequiredError}
|
|
2472
|
+
*/
|
|
2473
|
+
createInviteToken(orgId: string, createInviteTokenRequest?: CreateInviteTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteTokenResponse>>;
|
|
2474
|
+
/**
|
|
2475
|
+
* Validates the opaque invite token and creates (or returns) a pending AccessRequest for the property/role encoded on the token.
|
|
2476
|
+
* @summary Submit a join access request from an invite token
|
|
2477
|
+
* @param {string} orgId
|
|
2478
|
+
* @param {CreateJoinRequest} [createJoinRequest]
|
|
2479
|
+
* @param {*} [options] Override http request option.
|
|
2480
|
+
* @throws {RequiredError}
|
|
2481
|
+
*/
|
|
2482
|
+
createJoinAccessRequest(orgId: string, createJoinRequest?: CreateJoinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestResponse>>;
|
|
2483
|
+
/**
|
|
2484
|
+
* Returns request status for the authenticated requester only. Owners should use the list endpoint.
|
|
2485
|
+
* @summary Get a join access request by id
|
|
2486
|
+
* @param {string} orgId
|
|
2487
|
+
* @param {string} requestId
|
|
2488
|
+
* @param {*} [options] Override http request option.
|
|
2489
|
+
* @throws {RequiredError}
|
|
2490
|
+
*/
|
|
2491
|
+
getJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJoinAccessRequest200Response>>;
|
|
2492
|
+
/**
|
|
2493
|
+
* Returns pending AccessRequests for an org. Optional propertyId/brandId filters. Requires ViewTeammates on orgId.
|
|
2494
|
+
* @summary List pending join requests for an organization
|
|
2495
|
+
* @param {string} orgId
|
|
2496
|
+
* @param {string} [propertyId]
|
|
2497
|
+
* @param {string} [brandId]
|
|
2498
|
+
* @param {*} [options] Override http request option.
|
|
2499
|
+
* @throws {RequiredError}
|
|
2500
|
+
*/
|
|
2501
|
+
listJoinAccessRequests(orgId: string, propertyId?: string, brandId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListJoinRequestsResponse>>;
|
|
2502
|
+
/**
|
|
2503
|
+
* Rejects a pending AccessRequest without granting access.
|
|
2504
|
+
* @summary Reject a pending join access request
|
|
2505
|
+
* @param {string} orgId
|
|
2506
|
+
* @param {string} requestId
|
|
2507
|
+
* @param {*} [options] Override http request option.
|
|
2508
|
+
* @throws {RequiredError}
|
|
2509
|
+
*/
|
|
2510
|
+
rejectJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJoinAccessRequest200Response>>;
|
|
2511
|
+
};
|
|
2512
|
+
/**
|
|
2513
|
+
* JoinAccessApi - factory interface
|
|
2514
|
+
* @export
|
|
2515
|
+
*/
|
|
2516
|
+
export declare const JoinAccessApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2517
|
+
/**
|
|
2518
|
+
* Grants the role stored on the access request (copied from the invite token at create time) via AuthZ V2 role assignment (source join).
|
|
2519
|
+
* @summary Accept a pending join access request
|
|
2520
|
+
* @param {string} orgId
|
|
2521
|
+
* @param {string} requestId
|
|
2522
|
+
* @param {*} [options] Override http request option.
|
|
2523
|
+
* @throws {RequiredError}
|
|
2524
|
+
*/
|
|
2525
|
+
acceptJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetJoinAccessRequest200Response>;
|
|
2526
|
+
/**
|
|
2527
|
+
* Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one.
|
|
2528
|
+
* @summary Create an invite token
|
|
2529
|
+
* @param {string} orgId
|
|
2530
|
+
* @param {CreateInviteTokenRequest} [createInviteTokenRequest]
|
|
2531
|
+
* @param {*} [options] Override http request option.
|
|
2532
|
+
* @throws {RequiredError}
|
|
2533
|
+
*/
|
|
2534
|
+
createInviteToken(orgId: string, createInviteTokenRequest?: CreateInviteTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<InviteTokenResponse>;
|
|
2535
|
+
/**
|
|
2536
|
+
* Validates the opaque invite token and creates (or returns) a pending AccessRequest for the property/role encoded on the token.
|
|
2537
|
+
* @summary Submit a join access request from an invite token
|
|
2538
|
+
* @param {string} orgId
|
|
2539
|
+
* @param {CreateJoinRequest} [createJoinRequest]
|
|
2540
|
+
* @param {*} [options] Override http request option.
|
|
2541
|
+
* @throws {RequiredError}
|
|
2542
|
+
*/
|
|
2543
|
+
createJoinAccessRequest(orgId: string, createJoinRequest?: CreateJoinRequest, options?: RawAxiosRequestConfig): AxiosPromise<AccessRequestResponse>;
|
|
2544
|
+
/**
|
|
2545
|
+
* Returns request status for the authenticated requester only. Owners should use the list endpoint.
|
|
2546
|
+
* @summary Get a join access request by id
|
|
2547
|
+
* @param {string} orgId
|
|
2548
|
+
* @param {string} requestId
|
|
2549
|
+
* @param {*} [options] Override http request option.
|
|
2550
|
+
* @throws {RequiredError}
|
|
2551
|
+
*/
|
|
2552
|
+
getJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetJoinAccessRequest200Response>;
|
|
2553
|
+
/**
|
|
2554
|
+
* Returns pending AccessRequests for an org. Optional propertyId/brandId filters. Requires ViewTeammates on orgId.
|
|
2555
|
+
* @summary List pending join requests for an organization
|
|
2556
|
+
* @param {string} orgId
|
|
2557
|
+
* @param {string} [propertyId]
|
|
2558
|
+
* @param {string} [brandId]
|
|
2559
|
+
* @param {*} [options] Override http request option.
|
|
2560
|
+
* @throws {RequiredError}
|
|
2561
|
+
*/
|
|
2562
|
+
listJoinAccessRequests(orgId: string, propertyId?: string, brandId?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListJoinRequestsResponse>;
|
|
2563
|
+
/**
|
|
2564
|
+
* Rejects a pending AccessRequest without granting access.
|
|
2565
|
+
* @summary Reject a pending join access request
|
|
2566
|
+
* @param {string} orgId
|
|
2567
|
+
* @param {string} requestId
|
|
2568
|
+
* @param {*} [options] Override http request option.
|
|
2569
|
+
* @throws {RequiredError}
|
|
2570
|
+
*/
|
|
2571
|
+
rejectJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetJoinAccessRequest200Response>;
|
|
2572
|
+
};
|
|
2573
|
+
/**
|
|
2574
|
+
* JoinAccessApi - object-oriented interface
|
|
2575
|
+
* @export
|
|
2576
|
+
* @class JoinAccessApi
|
|
2577
|
+
* @extends {BaseAPI}
|
|
2578
|
+
*/
|
|
2579
|
+
export declare class JoinAccessApi extends BaseAPI {
|
|
2580
|
+
/**
|
|
2581
|
+
* Grants the role stored on the access request (copied from the invite token at create time) via AuthZ V2 role assignment (source join).
|
|
2582
|
+
* @summary Accept a pending join access request
|
|
2583
|
+
* @param {string} orgId
|
|
2584
|
+
* @param {string} requestId
|
|
2585
|
+
* @param {*} [options] Override http request option.
|
|
2586
|
+
* @throws {RequiredError}
|
|
2587
|
+
* @memberof JoinAccessApi
|
|
2588
|
+
*/
|
|
2589
|
+
acceptJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetJoinAccessRequest200Response, any, {}, any>>;
|
|
2590
|
+
/**
|
|
2591
|
+
* Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one.
|
|
2592
|
+
* @summary Create an invite token
|
|
2593
|
+
* @param {string} orgId
|
|
2594
|
+
* @param {CreateInviteTokenRequest} [createInviteTokenRequest]
|
|
2595
|
+
* @param {*} [options] Override http request option.
|
|
2596
|
+
* @throws {RequiredError}
|
|
2597
|
+
* @memberof JoinAccessApi
|
|
2598
|
+
*/
|
|
2599
|
+
createInviteToken(orgId: string, createInviteTokenRequest?: CreateInviteTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InviteTokenResponse, any, {}, any>>;
|
|
2600
|
+
/**
|
|
2601
|
+
* Validates the opaque invite token and creates (or returns) a pending AccessRequest for the property/role encoded on the token.
|
|
2602
|
+
* @summary Submit a join access request from an invite token
|
|
2603
|
+
* @param {string} orgId
|
|
2604
|
+
* @param {CreateJoinRequest} [createJoinRequest]
|
|
2605
|
+
* @param {*} [options] Override http request option.
|
|
2606
|
+
* @throws {RequiredError}
|
|
2607
|
+
* @memberof JoinAccessApi
|
|
2608
|
+
*/
|
|
2609
|
+
createJoinAccessRequest(orgId: string, createJoinRequest?: CreateJoinRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessRequestResponse, any, {}, any>>;
|
|
2610
|
+
/**
|
|
2611
|
+
* Returns request status for the authenticated requester only. Owners should use the list endpoint.
|
|
2612
|
+
* @summary Get a join access request by id
|
|
2613
|
+
* @param {string} orgId
|
|
2614
|
+
* @param {string} requestId
|
|
2615
|
+
* @param {*} [options] Override http request option.
|
|
2616
|
+
* @throws {RequiredError}
|
|
2617
|
+
* @memberof JoinAccessApi
|
|
2618
|
+
*/
|
|
2619
|
+
getJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetJoinAccessRequest200Response, any, {}, any>>;
|
|
2620
|
+
/**
|
|
2621
|
+
* Returns pending AccessRequests for an org. Optional propertyId/brandId filters. Requires ViewTeammates on orgId.
|
|
2622
|
+
* @summary List pending join requests for an organization
|
|
2623
|
+
* @param {string} orgId
|
|
2624
|
+
* @param {string} [propertyId]
|
|
2625
|
+
* @param {string} [brandId]
|
|
2626
|
+
* @param {*} [options] Override http request option.
|
|
2627
|
+
* @throws {RequiredError}
|
|
2628
|
+
* @memberof JoinAccessApi
|
|
2629
|
+
*/
|
|
2630
|
+
listJoinAccessRequests(orgId: string, propertyId?: string, brandId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListJoinRequestsResponse, any, {}, any>>;
|
|
2631
|
+
/**
|
|
2632
|
+
* Rejects a pending AccessRequest without granting access.
|
|
2633
|
+
* @summary Reject a pending join access request
|
|
2634
|
+
* @param {string} orgId
|
|
2635
|
+
* @param {string} requestId
|
|
2636
|
+
* @param {*} [options] Override http request option.
|
|
2637
|
+
* @throws {RequiredError}
|
|
2638
|
+
* @memberof JoinAccessApi
|
|
2639
|
+
*/
|
|
2640
|
+
rejectJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetJoinAccessRequest200Response, any, {}, any>>;
|
|
1970
2641
|
}
|
|
1971
2642
|
/**
|
|
1972
2643
|
* RoleAssignmentApi - axios parameter creator
|
|
@@ -2083,7 +2754,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
2083
2754
|
* @throws {RequiredError}
|
|
2084
2755
|
* @memberof RoleAssignmentApi
|
|
2085
2756
|
*/
|
|
2086
|
-
applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleAssignmentSuccessResponse, any, {}>>;
|
|
2757
|
+
applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RoleAssignmentSuccessResponse, any, {}, any>>;
|
|
2087
2758
|
/**
|
|
2088
2759
|
* Rematerializes a role assignment and applies the resulting policy assignments
|
|
2089
2760
|
* @summary Rematerialize Role Assignment
|
|
@@ -2093,7 +2764,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
2093
2764
|
* @throws {RequiredError}
|
|
2094
2765
|
* @memberof RoleAssignmentApi
|
|
2095
2766
|
*/
|
|
2096
|
-
rematerializeRoleAssignmentV2(orgId: string, rematerializeRoleAssignmentRequestBody?: RematerializeRoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RematerializeRoleAssignmentSuccessResponse, any, {}>>;
|
|
2767
|
+
rematerializeRoleAssignmentV2(orgId: string, rematerializeRoleAssignmentRequestBody?: RematerializeRoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RematerializeRoleAssignmentSuccessResponse, any, {}, any>>;
|
|
2097
2768
|
/**
|
|
2098
2769
|
* Revokes all V2 role assignments for the teammate in this org, reconciles away their policies, and removes them from the org user list. Does not delete the teammate account in Zeus.
|
|
2099
2770
|
* @summary Remove teammate
|
|
@@ -2103,7 +2774,7 @@ export declare class RoleAssignmentApi extends BaseAPI {
|
|
|
2103
2774
|
* @throws {RequiredError}
|
|
2104
2775
|
* @memberof RoleAssignmentApi
|
|
2105
2776
|
*/
|
|
2106
|
-
removeTeammate(orgId: string, removeTeammateRequestBody?: RemoveTeammateRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RemoveTeammateSuccessResponse, any, {}>>;
|
|
2777
|
+
removeTeammate(orgId: string, removeTeammateRequestBody?: RemoveTeammateRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RemoveTeammateSuccessResponse, any, {}, any>>;
|
|
2107
2778
|
}
|
|
2108
2779
|
/**
|
|
2109
2780
|
* UserManagementApi - axios parameter creator
|
|
@@ -2162,7 +2833,7 @@ export declare class UserManagementApi extends BaseAPI {
|
|
|
2162
2833
|
* @throws {RequiredError}
|
|
2163
2834
|
* @memberof UserManagementApi
|
|
2164
2835
|
*/
|
|
2165
|
-
listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrincipalsInOrgResponse, any, {}>>;
|
|
2836
|
+
listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrincipalsInOrgResponse, any, {}, any>>;
|
|
2166
2837
|
}
|
|
2167
2838
|
/**
|
|
2168
2839
|
* UserPermissionsApi - axios parameter creator
|
|
@@ -2312,7 +2983,7 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
2312
2983
|
[key: string]: {
|
|
2313
2984
|
[key: string]: GetUserPermissionsSuccessResponseResourcesValue;
|
|
2314
2985
|
};
|
|
2315
|
-
}, any, {}>>;
|
|
2986
|
+
}, any, {}, any>>;
|
|
2316
2987
|
/**
|
|
2317
2988
|
* List the current roles assignments in the org
|
|
2318
2989
|
* @summary List Org Roles
|
|
@@ -2323,7 +2994,7 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
2323
2994
|
*/
|
|
2324
2995
|
listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
2325
2996
|
[key: string]: ListOrgRolesSuccessResponseValue;
|
|
2326
|
-
}, any, {}>>;
|
|
2997
|
+
}, any, {}, any>>;
|
|
2327
2998
|
/**
|
|
2328
2999
|
* List the available permissions for the current user
|
|
2329
3000
|
* @summary List Own Permissions
|
|
@@ -2332,7 +3003,7 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
2332
3003
|
* @throws {RequiredError}
|
|
2333
3004
|
* @memberof UserPermissionsApi
|
|
2334
3005
|
*/
|
|
2335
|
-
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
|
|
3006
|
+
listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}, any>>;
|
|
2336
3007
|
/**
|
|
2337
3008
|
* List the available permissions for a given user
|
|
2338
3009
|
* @summary List User Permissions
|
|
@@ -2342,5 +3013,5 @@ export declare class UserPermissionsApi extends BaseAPI {
|
|
|
2342
3013
|
* @throws {RequiredError}
|
|
2343
3014
|
* @memberof UserPermissionsApi
|
|
2344
3015
|
*/
|
|
2345
|
-
listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}>>;
|
|
3016
|
+
listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetUserPermissionsSuccessResponse, any, {}, any>>;
|
|
2346
3017
|
}
|