@flipdish/authorization 0.2.43-rc.1785501197 → 0.2.45-rc.1786458545
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 +885 -0
- package/configuration.ts +1 -1
- package/dist/api.d.ts +601 -0
- package/dist/api.js +681 -1
- package/dist/configuration.js +1 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -23,6 +23,114 @@ import type { RequestArgs } from './base';
|
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
|
|
25
25
|
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
* @interface AccessRequestResponse
|
|
30
|
+
*/
|
|
31
|
+
export interface AccessRequestResponse {
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {string}
|
|
35
|
+
* @memberof AccessRequestResponse
|
|
36
|
+
*/
|
|
37
|
+
'requestId': string;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof AccessRequestResponse
|
|
42
|
+
*/
|
|
43
|
+
'state': AccessRequestResponseStateEnum;
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
* @type {string}
|
|
47
|
+
* @memberof AccessRequestResponse
|
|
48
|
+
*/
|
|
49
|
+
'requesterUserId': string;
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof AccessRequestResponse
|
|
54
|
+
*/
|
|
55
|
+
'requesterEmail': string;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof AccessRequestResponse
|
|
60
|
+
*/
|
|
61
|
+
'orgId': string;
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof AccessRequestResponse
|
|
66
|
+
*/
|
|
67
|
+
'orgName': string;
|
|
68
|
+
/**
|
|
69
|
+
*
|
|
70
|
+
* @type {Array<string>}
|
|
71
|
+
* @memberof AccessRequestResponse
|
|
72
|
+
*/
|
|
73
|
+
'propertyIds': Array<string>;
|
|
74
|
+
/**
|
|
75
|
+
*
|
|
76
|
+
* @type {Array<string>}
|
|
77
|
+
* @memberof AccessRequestResponse
|
|
78
|
+
*/
|
|
79
|
+
'brandIds': Array<string>;
|
|
80
|
+
/**
|
|
81
|
+
*
|
|
82
|
+
* @type {Array<string>}
|
|
83
|
+
* @memberof AccessRequestResponse
|
|
84
|
+
*/
|
|
85
|
+
'salesChannelIds': Array<string>;
|
|
86
|
+
/**
|
|
87
|
+
*
|
|
88
|
+
* @type {string}
|
|
89
|
+
* @memberof AccessRequestResponse
|
|
90
|
+
*/
|
|
91
|
+
'roleName': AccessRequestResponseRoleNameEnum;
|
|
92
|
+
/**
|
|
93
|
+
*
|
|
94
|
+
* @type {string}
|
|
95
|
+
* @memberof AccessRequestResponse
|
|
96
|
+
*/
|
|
97
|
+
'createdAt': string;
|
|
98
|
+
/**
|
|
99
|
+
*
|
|
100
|
+
* @type {string}
|
|
101
|
+
* @memberof AccessRequestResponse
|
|
102
|
+
*/
|
|
103
|
+
'decidedAt'?: string;
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @type {string}
|
|
107
|
+
* @memberof AccessRequestResponse
|
|
108
|
+
*/
|
|
109
|
+
'decidedByUserId'?: string;
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
export const AccessRequestResponseStateEnum = {
|
|
113
|
+
Pending: 'Pending',
|
|
114
|
+
Approved: 'Approved',
|
|
115
|
+
Rejected: 'Rejected',
|
|
116
|
+
Expired: 'Expired'
|
|
117
|
+
} as const;
|
|
118
|
+
|
|
119
|
+
export type AccessRequestResponseStateEnum = typeof AccessRequestResponseStateEnum[keyof typeof AccessRequestResponseStateEnum];
|
|
120
|
+
export const AccessRequestResponseRoleNameEnum = {
|
|
121
|
+
Owner: 'Owner',
|
|
122
|
+
PropertyOwner: 'PropertyOwner',
|
|
123
|
+
ManagedOwner: 'ManagedOwner',
|
|
124
|
+
Integrator: 'Integrator',
|
|
125
|
+
PropertyManager: 'PropertyManager',
|
|
126
|
+
FinanceManager: 'FinanceManager',
|
|
127
|
+
StaffMember: 'StaffMember',
|
|
128
|
+
Kiosk: 'Kiosk',
|
|
129
|
+
Terminal: 'Terminal'
|
|
130
|
+
} as const;
|
|
131
|
+
|
|
132
|
+
export type AccessRequestResponseRoleNameEnum = typeof AccessRequestResponseRoleNameEnum[keyof typeof AccessRequestResponseRoleNameEnum];
|
|
133
|
+
|
|
26
134
|
/**
|
|
27
135
|
* 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.
|
|
28
136
|
* @export
|
|
@@ -476,6 +584,44 @@ export interface AuthorizationResponse {
|
|
|
476
584
|
*/
|
|
477
585
|
'policyIds': Array<string>;
|
|
478
586
|
}
|
|
587
|
+
/**
|
|
588
|
+
*
|
|
589
|
+
* @export
|
|
590
|
+
* @interface CreateInviteTokenRequest
|
|
591
|
+
*/
|
|
592
|
+
export interface CreateInviteTokenRequest {
|
|
593
|
+
/**
|
|
594
|
+
*
|
|
595
|
+
* @type {string}
|
|
596
|
+
* @memberof CreateInviteTokenRequest
|
|
597
|
+
*/
|
|
598
|
+
'storefrontId': string;
|
|
599
|
+
/**
|
|
600
|
+
*
|
|
601
|
+
* @type {string}
|
|
602
|
+
* @memberof CreateInviteTokenRequest
|
|
603
|
+
*/
|
|
604
|
+
'propertyId': string;
|
|
605
|
+
/**
|
|
606
|
+
*
|
|
607
|
+
* @type {string}
|
|
608
|
+
* @memberof CreateInviteTokenRequest
|
|
609
|
+
*/
|
|
610
|
+
'orgName': string;
|
|
611
|
+
}
|
|
612
|
+
/**
|
|
613
|
+
*
|
|
614
|
+
* @export
|
|
615
|
+
* @interface CreateJoinRequest
|
|
616
|
+
*/
|
|
617
|
+
export interface CreateJoinRequest {
|
|
618
|
+
/**
|
|
619
|
+
*
|
|
620
|
+
* @type {string}
|
|
621
|
+
* @memberof CreateJoinRequest
|
|
622
|
+
*/
|
|
623
|
+
'token': string;
|
|
624
|
+
}
|
|
479
625
|
/**
|
|
480
626
|
*
|
|
481
627
|
* @export
|
|
@@ -674,6 +820,114 @@ export interface GetAuthorizedPropertiesResponse {
|
|
|
674
820
|
*/
|
|
675
821
|
'deniedResources': Array<AuthorizationBatchResponseAllowedResourcesInner>;
|
|
676
822
|
}
|
|
823
|
+
/**
|
|
824
|
+
*
|
|
825
|
+
* @export
|
|
826
|
+
* @interface GetJoinAccessRequest200Response
|
|
827
|
+
*/
|
|
828
|
+
export interface GetJoinAccessRequest200Response {
|
|
829
|
+
/**
|
|
830
|
+
*
|
|
831
|
+
* @type {string}
|
|
832
|
+
* @memberof GetJoinAccessRequest200Response
|
|
833
|
+
*/
|
|
834
|
+
'requestId': string;
|
|
835
|
+
/**
|
|
836
|
+
*
|
|
837
|
+
* @type {string}
|
|
838
|
+
* @memberof GetJoinAccessRequest200Response
|
|
839
|
+
*/
|
|
840
|
+
'state': GetJoinAccessRequest200ResponseStateEnum;
|
|
841
|
+
/**
|
|
842
|
+
*
|
|
843
|
+
* @type {string}
|
|
844
|
+
* @memberof GetJoinAccessRequest200Response
|
|
845
|
+
*/
|
|
846
|
+
'requesterUserId': string;
|
|
847
|
+
/**
|
|
848
|
+
*
|
|
849
|
+
* @type {string}
|
|
850
|
+
* @memberof GetJoinAccessRequest200Response
|
|
851
|
+
*/
|
|
852
|
+
'requesterEmail': string;
|
|
853
|
+
/**
|
|
854
|
+
*
|
|
855
|
+
* @type {string}
|
|
856
|
+
* @memberof GetJoinAccessRequest200Response
|
|
857
|
+
*/
|
|
858
|
+
'orgId': string;
|
|
859
|
+
/**
|
|
860
|
+
*
|
|
861
|
+
* @type {string}
|
|
862
|
+
* @memberof GetJoinAccessRequest200Response
|
|
863
|
+
*/
|
|
864
|
+
'orgName': string;
|
|
865
|
+
/**
|
|
866
|
+
*
|
|
867
|
+
* @type {Array<string>}
|
|
868
|
+
* @memberof GetJoinAccessRequest200Response
|
|
869
|
+
*/
|
|
870
|
+
'propertyIds': Array<string>;
|
|
871
|
+
/**
|
|
872
|
+
*
|
|
873
|
+
* @type {Array<string>}
|
|
874
|
+
* @memberof GetJoinAccessRequest200Response
|
|
875
|
+
*/
|
|
876
|
+
'brandIds': Array<string>;
|
|
877
|
+
/**
|
|
878
|
+
*
|
|
879
|
+
* @type {Array<string>}
|
|
880
|
+
* @memberof GetJoinAccessRequest200Response
|
|
881
|
+
*/
|
|
882
|
+
'salesChannelIds': Array<string>;
|
|
883
|
+
/**
|
|
884
|
+
*
|
|
885
|
+
* @type {string}
|
|
886
|
+
* @memberof GetJoinAccessRequest200Response
|
|
887
|
+
*/
|
|
888
|
+
'roleName': GetJoinAccessRequest200ResponseRoleNameEnum;
|
|
889
|
+
/**
|
|
890
|
+
*
|
|
891
|
+
* @type {string}
|
|
892
|
+
* @memberof GetJoinAccessRequest200Response
|
|
893
|
+
*/
|
|
894
|
+
'createdAt': string;
|
|
895
|
+
/**
|
|
896
|
+
*
|
|
897
|
+
* @type {string}
|
|
898
|
+
* @memberof GetJoinAccessRequest200Response
|
|
899
|
+
*/
|
|
900
|
+
'decidedAt'?: string;
|
|
901
|
+
/**
|
|
902
|
+
*
|
|
903
|
+
* @type {string}
|
|
904
|
+
* @memberof GetJoinAccessRequest200Response
|
|
905
|
+
*/
|
|
906
|
+
'decidedByUserId'?: string;
|
|
907
|
+
}
|
|
908
|
+
|
|
909
|
+
export const GetJoinAccessRequest200ResponseStateEnum = {
|
|
910
|
+
Pending: 'Pending',
|
|
911
|
+
Approved: 'Approved',
|
|
912
|
+
Rejected: 'Rejected',
|
|
913
|
+
Expired: 'Expired'
|
|
914
|
+
} as const;
|
|
915
|
+
|
|
916
|
+
export type GetJoinAccessRequest200ResponseStateEnum = typeof GetJoinAccessRequest200ResponseStateEnum[keyof typeof GetJoinAccessRequest200ResponseStateEnum];
|
|
917
|
+
export const GetJoinAccessRequest200ResponseRoleNameEnum = {
|
|
918
|
+
Owner: 'Owner',
|
|
919
|
+
PropertyOwner: 'PropertyOwner',
|
|
920
|
+
ManagedOwner: 'ManagedOwner',
|
|
921
|
+
Integrator: 'Integrator',
|
|
922
|
+
PropertyManager: 'PropertyManager',
|
|
923
|
+
FinanceManager: 'FinanceManager',
|
|
924
|
+
StaffMember: 'StaffMember',
|
|
925
|
+
Kiosk: 'Kiosk',
|
|
926
|
+
Terminal: 'Terminal'
|
|
927
|
+
} as const;
|
|
928
|
+
|
|
929
|
+
export type GetJoinAccessRequest200ResponseRoleNameEnum = typeof GetJoinAccessRequest200ResponseRoleNameEnum[keyof typeof GetJoinAccessRequest200ResponseRoleNameEnum];
|
|
930
|
+
|
|
677
931
|
/**
|
|
678
932
|
* Successful user permissions retrieval response
|
|
679
933
|
* @export
|
|
@@ -729,6 +983,76 @@ export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = ty
|
|
|
729
983
|
*/
|
|
730
984
|
export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
|
|
731
985
|
}
|
|
986
|
+
/**
|
|
987
|
+
*
|
|
988
|
+
* @export
|
|
989
|
+
* @interface InviteTokenResponse
|
|
990
|
+
*/
|
|
991
|
+
export interface InviteTokenResponse {
|
|
992
|
+
/**
|
|
993
|
+
*
|
|
994
|
+
* @type {string}
|
|
995
|
+
* @memberof InviteTokenResponse
|
|
996
|
+
*/
|
|
997
|
+
'tokenId': string;
|
|
998
|
+
/**
|
|
999
|
+
*
|
|
1000
|
+
* @type {string}
|
|
1001
|
+
* @memberof InviteTokenResponse
|
|
1002
|
+
*/
|
|
1003
|
+
'joinUrl': string;
|
|
1004
|
+
/**
|
|
1005
|
+
*
|
|
1006
|
+
* @type {string}
|
|
1007
|
+
* @memberof InviteTokenResponse
|
|
1008
|
+
*/
|
|
1009
|
+
'expiresAt': string;
|
|
1010
|
+
/**
|
|
1011
|
+
*
|
|
1012
|
+
* @type {string}
|
|
1013
|
+
* @memberof InviteTokenResponse
|
|
1014
|
+
*/
|
|
1015
|
+
'orgId': string;
|
|
1016
|
+
/**
|
|
1017
|
+
*
|
|
1018
|
+
* @type {Array<string>}
|
|
1019
|
+
* @memberof InviteTokenResponse
|
|
1020
|
+
*/
|
|
1021
|
+
'brandIds': Array<string>;
|
|
1022
|
+
/**
|
|
1023
|
+
*
|
|
1024
|
+
* @type {Array<string>}
|
|
1025
|
+
* @memberof InviteTokenResponse
|
|
1026
|
+
*/
|
|
1027
|
+
'propertyIds': Array<string>;
|
|
1028
|
+
/**
|
|
1029
|
+
*
|
|
1030
|
+
* @type {Array<string>}
|
|
1031
|
+
* @memberof InviteTokenResponse
|
|
1032
|
+
*/
|
|
1033
|
+
'salesChannelIds': Array<string>;
|
|
1034
|
+
/**
|
|
1035
|
+
*
|
|
1036
|
+
* @type {string}
|
|
1037
|
+
* @memberof InviteTokenResponse
|
|
1038
|
+
*/
|
|
1039
|
+
'roleName': InviteTokenResponseRoleNameEnum;
|
|
1040
|
+
}
|
|
1041
|
+
|
|
1042
|
+
export const InviteTokenResponseRoleNameEnum = {
|
|
1043
|
+
Owner: 'Owner',
|
|
1044
|
+
PropertyOwner: 'PropertyOwner',
|
|
1045
|
+
ManagedOwner: 'ManagedOwner',
|
|
1046
|
+
Integrator: 'Integrator',
|
|
1047
|
+
PropertyManager: 'PropertyManager',
|
|
1048
|
+
FinanceManager: 'FinanceManager',
|
|
1049
|
+
StaffMember: 'StaffMember',
|
|
1050
|
+
Kiosk: 'Kiosk',
|
|
1051
|
+
Terminal: 'Terminal'
|
|
1052
|
+
} as const;
|
|
1053
|
+
|
|
1054
|
+
export type InviteTokenResponseRoleNameEnum = typeof InviteTokenResponseRoleNameEnum[keyof typeof InviteTokenResponseRoleNameEnum];
|
|
1055
|
+
|
|
732
1056
|
/**
|
|
733
1057
|
*
|
|
734
1058
|
* @export
|
|
@@ -775,6 +1099,45 @@ export interface IsInRoleResponse {
|
|
|
775
1099
|
*/
|
|
776
1100
|
'authorized': boolean;
|
|
777
1101
|
}
|
|
1102
|
+
/**
|
|
1103
|
+
*
|
|
1104
|
+
* @export
|
|
1105
|
+
* @interface JoinAccessErrorResponse
|
|
1106
|
+
*/
|
|
1107
|
+
export interface JoinAccessErrorResponse {
|
|
1108
|
+
/**
|
|
1109
|
+
*
|
|
1110
|
+
* @type {string}
|
|
1111
|
+
* @memberof JoinAccessErrorResponse
|
|
1112
|
+
*/
|
|
1113
|
+
'code': JoinAccessErrorResponseCodeEnum;
|
|
1114
|
+
/**
|
|
1115
|
+
*
|
|
1116
|
+
* @type {string}
|
|
1117
|
+
* @memberof JoinAccessErrorResponse
|
|
1118
|
+
*/
|
|
1119
|
+
'message': string;
|
|
1120
|
+
}
|
|
1121
|
+
|
|
1122
|
+
export const JoinAccessErrorResponseCodeEnum = {
|
|
1123
|
+
AlreadyMember: 'ALREADY_MEMBER'
|
|
1124
|
+
} as const;
|
|
1125
|
+
|
|
1126
|
+
export type JoinAccessErrorResponseCodeEnum = typeof JoinAccessErrorResponseCodeEnum[keyof typeof JoinAccessErrorResponseCodeEnum];
|
|
1127
|
+
|
|
1128
|
+
/**
|
|
1129
|
+
*
|
|
1130
|
+
* @export
|
|
1131
|
+
* @interface ListJoinRequestsResponse
|
|
1132
|
+
*/
|
|
1133
|
+
export interface ListJoinRequestsResponse {
|
|
1134
|
+
/**
|
|
1135
|
+
*
|
|
1136
|
+
* @type {Array<GetJoinAccessRequest200Response>}
|
|
1137
|
+
* @memberof ListJoinRequestsResponse
|
|
1138
|
+
*/
|
|
1139
|
+
'items': Array<GetJoinAccessRequest200Response>;
|
|
1140
|
+
}
|
|
778
1141
|
/**
|
|
779
1142
|
*
|
|
780
1143
|
* @export
|
|
@@ -2594,6 +2957,528 @@ export class ConfigurationDataApi extends BaseAPI {
|
|
|
2594
2957
|
|
|
2595
2958
|
|
|
2596
2959
|
|
|
2960
|
+
/**
|
|
2961
|
+
* JoinAccessApi - axios parameter creator
|
|
2962
|
+
* @export
|
|
2963
|
+
*/
|
|
2964
|
+
export const JoinAccessApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
2965
|
+
return {
|
|
2966
|
+
/**
|
|
2967
|
+
* Grants the role stored on the access request (copied from the invite token at create time) via AuthZ V2 role assignment (source join).
|
|
2968
|
+
* @summary Accept a pending join access request
|
|
2969
|
+
* @param {string} orgId
|
|
2970
|
+
* @param {string} requestId
|
|
2971
|
+
* @param {*} [options] Override http request option.
|
|
2972
|
+
* @throws {RequiredError}
|
|
2973
|
+
*/
|
|
2974
|
+
acceptJoinAccessRequest: async (orgId: string, requestId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2975
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
2976
|
+
assertParamExists('acceptJoinAccessRequest', 'orgId', orgId)
|
|
2977
|
+
// verify required parameter 'requestId' is not null or undefined
|
|
2978
|
+
assertParamExists('acceptJoinAccessRequest', 'requestId', requestId)
|
|
2979
|
+
const localVarPath = `/orgs/{orgId}/joinRequests/{requestId}/accept`
|
|
2980
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
|
|
2981
|
+
.replace(`{${"requestId"}}`, encodeURIComponent(String(requestId)));
|
|
2982
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2983
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2984
|
+
let baseOptions;
|
|
2985
|
+
if (configuration) {
|
|
2986
|
+
baseOptions = configuration.baseOptions;
|
|
2987
|
+
}
|
|
2988
|
+
|
|
2989
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
2990
|
+
const localVarHeaderParameter = {} as any;
|
|
2991
|
+
const localVarQueryParameter = {} as any;
|
|
2992
|
+
|
|
2993
|
+
// authentication ApiKeyAuth required
|
|
2994
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2995
|
+
|
|
2996
|
+
|
|
2997
|
+
|
|
2998
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2999
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3000
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3001
|
+
|
|
3002
|
+
return {
|
|
3003
|
+
url: toPathString(localVarUrlObj),
|
|
3004
|
+
options: localVarRequestOptions,
|
|
3005
|
+
};
|
|
3006
|
+
},
|
|
3007
|
+
/**
|
|
3008
|
+
* Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one.
|
|
3009
|
+
* @summary Create an invite token
|
|
3010
|
+
* @param {string} orgId
|
|
3011
|
+
* @param {CreateInviteTokenRequest} [createInviteTokenRequest]
|
|
3012
|
+
* @param {*} [options] Override http request option.
|
|
3013
|
+
* @throws {RequiredError}
|
|
3014
|
+
*/
|
|
3015
|
+
createInviteToken: async (orgId: string, createInviteTokenRequest?: CreateInviteTokenRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3016
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
3017
|
+
assertParamExists('createInviteToken', 'orgId', orgId)
|
|
3018
|
+
const localVarPath = `/orgs/{orgId}/inviteTokens`
|
|
3019
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
3020
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3021
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3022
|
+
let baseOptions;
|
|
3023
|
+
if (configuration) {
|
|
3024
|
+
baseOptions = configuration.baseOptions;
|
|
3025
|
+
}
|
|
3026
|
+
|
|
3027
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3028
|
+
const localVarHeaderParameter = {} as any;
|
|
3029
|
+
const localVarQueryParameter = {} as any;
|
|
3030
|
+
|
|
3031
|
+
// authentication ApiKeyAuth required
|
|
3032
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3033
|
+
|
|
3034
|
+
|
|
3035
|
+
|
|
3036
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3037
|
+
|
|
3038
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3039
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3040
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3041
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createInviteTokenRequest, localVarRequestOptions, configuration)
|
|
3042
|
+
|
|
3043
|
+
return {
|
|
3044
|
+
url: toPathString(localVarUrlObj),
|
|
3045
|
+
options: localVarRequestOptions,
|
|
3046
|
+
};
|
|
3047
|
+
},
|
|
3048
|
+
/**
|
|
3049
|
+
* Validates the opaque invite token and creates (or returns) a pending AccessRequest for the property/role encoded on the token.
|
|
3050
|
+
* @summary Submit a join access request from an invite token
|
|
3051
|
+
* @param {string} orgId
|
|
3052
|
+
* @param {CreateJoinRequest} [createJoinRequest]
|
|
3053
|
+
* @param {*} [options] Override http request option.
|
|
3054
|
+
* @throws {RequiredError}
|
|
3055
|
+
*/
|
|
3056
|
+
createJoinAccessRequest: async (orgId: string, createJoinRequest?: CreateJoinRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3057
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
3058
|
+
assertParamExists('createJoinAccessRequest', 'orgId', orgId)
|
|
3059
|
+
const localVarPath = `/orgs/{orgId}/joinRequests`
|
|
3060
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
3061
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3062
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3063
|
+
let baseOptions;
|
|
3064
|
+
if (configuration) {
|
|
3065
|
+
baseOptions = configuration.baseOptions;
|
|
3066
|
+
}
|
|
3067
|
+
|
|
3068
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3069
|
+
const localVarHeaderParameter = {} as any;
|
|
3070
|
+
const localVarQueryParameter = {} as any;
|
|
3071
|
+
|
|
3072
|
+
// authentication ApiKeyAuth required
|
|
3073
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3074
|
+
|
|
3075
|
+
|
|
3076
|
+
|
|
3077
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3078
|
+
|
|
3079
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3080
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3081
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3082
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createJoinRequest, localVarRequestOptions, configuration)
|
|
3083
|
+
|
|
3084
|
+
return {
|
|
3085
|
+
url: toPathString(localVarUrlObj),
|
|
3086
|
+
options: localVarRequestOptions,
|
|
3087
|
+
};
|
|
3088
|
+
},
|
|
3089
|
+
/**
|
|
3090
|
+
* Returns request status for the authenticated requester only. Owners should use the list endpoint.
|
|
3091
|
+
* @summary Get a join access request by id
|
|
3092
|
+
* @param {string} orgId
|
|
3093
|
+
* @param {string} requestId
|
|
3094
|
+
* @param {*} [options] Override http request option.
|
|
3095
|
+
* @throws {RequiredError}
|
|
3096
|
+
*/
|
|
3097
|
+
getJoinAccessRequest: async (orgId: string, requestId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3098
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
3099
|
+
assertParamExists('getJoinAccessRequest', 'orgId', orgId)
|
|
3100
|
+
// verify required parameter 'requestId' is not null or undefined
|
|
3101
|
+
assertParamExists('getJoinAccessRequest', 'requestId', requestId)
|
|
3102
|
+
const localVarPath = `/orgs/{orgId}/joinRequests/{requestId}`
|
|
3103
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
|
|
3104
|
+
.replace(`{${"requestId"}}`, encodeURIComponent(String(requestId)));
|
|
3105
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3106
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3107
|
+
let baseOptions;
|
|
3108
|
+
if (configuration) {
|
|
3109
|
+
baseOptions = configuration.baseOptions;
|
|
3110
|
+
}
|
|
3111
|
+
|
|
3112
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3113
|
+
const localVarHeaderParameter = {} as any;
|
|
3114
|
+
const localVarQueryParameter = {} as any;
|
|
3115
|
+
|
|
3116
|
+
// authentication ApiKeyAuth required
|
|
3117
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3118
|
+
|
|
3119
|
+
|
|
3120
|
+
|
|
3121
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3122
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3123
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3124
|
+
|
|
3125
|
+
return {
|
|
3126
|
+
url: toPathString(localVarUrlObj),
|
|
3127
|
+
options: localVarRequestOptions,
|
|
3128
|
+
};
|
|
3129
|
+
},
|
|
3130
|
+
/**
|
|
3131
|
+
* Returns pending AccessRequests for an org. Optional propertyId/brandId filters. Requires ViewTeammates on orgId.
|
|
3132
|
+
* @summary List pending join requests for an organization
|
|
3133
|
+
* @param {string} orgId
|
|
3134
|
+
* @param {string} [propertyId]
|
|
3135
|
+
* @param {string} [brandId]
|
|
3136
|
+
* @param {*} [options] Override http request option.
|
|
3137
|
+
* @throws {RequiredError}
|
|
3138
|
+
*/
|
|
3139
|
+
listJoinAccessRequests: async (orgId: string, propertyId?: string, brandId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3140
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
3141
|
+
assertParamExists('listJoinAccessRequests', 'orgId', orgId)
|
|
3142
|
+
const localVarPath = `/orgs/{orgId}/joinRequests`
|
|
3143
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)));
|
|
3144
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3145
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3146
|
+
let baseOptions;
|
|
3147
|
+
if (configuration) {
|
|
3148
|
+
baseOptions = configuration.baseOptions;
|
|
3149
|
+
}
|
|
3150
|
+
|
|
3151
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3152
|
+
const localVarHeaderParameter = {} as any;
|
|
3153
|
+
const localVarQueryParameter = {} as any;
|
|
3154
|
+
|
|
3155
|
+
// authentication ApiKeyAuth required
|
|
3156
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3157
|
+
|
|
3158
|
+
if (propertyId !== undefined) {
|
|
3159
|
+
localVarQueryParameter['propertyId'] = propertyId;
|
|
3160
|
+
}
|
|
3161
|
+
|
|
3162
|
+
if (brandId !== undefined) {
|
|
3163
|
+
localVarQueryParameter['brandId'] = brandId;
|
|
3164
|
+
}
|
|
3165
|
+
|
|
3166
|
+
|
|
3167
|
+
|
|
3168
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3169
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3170
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3171
|
+
|
|
3172
|
+
return {
|
|
3173
|
+
url: toPathString(localVarUrlObj),
|
|
3174
|
+
options: localVarRequestOptions,
|
|
3175
|
+
};
|
|
3176
|
+
},
|
|
3177
|
+
/**
|
|
3178
|
+
* Rejects a pending AccessRequest without granting access.
|
|
3179
|
+
* @summary Reject a pending join access request
|
|
3180
|
+
* @param {string} orgId
|
|
3181
|
+
* @param {string} requestId
|
|
3182
|
+
* @param {*} [options] Override http request option.
|
|
3183
|
+
* @throws {RequiredError}
|
|
3184
|
+
*/
|
|
3185
|
+
rejectJoinAccessRequest: async (orgId: string, requestId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3186
|
+
// verify required parameter 'orgId' is not null or undefined
|
|
3187
|
+
assertParamExists('rejectJoinAccessRequest', 'orgId', orgId)
|
|
3188
|
+
// verify required parameter 'requestId' is not null or undefined
|
|
3189
|
+
assertParamExists('rejectJoinAccessRequest', 'requestId', requestId)
|
|
3190
|
+
const localVarPath = `/orgs/{orgId}/joinRequests/{requestId}/reject`
|
|
3191
|
+
.replace(`{${"orgId"}}`, encodeURIComponent(String(orgId)))
|
|
3192
|
+
.replace(`{${"requestId"}}`, encodeURIComponent(String(requestId)));
|
|
3193
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3194
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3195
|
+
let baseOptions;
|
|
3196
|
+
if (configuration) {
|
|
3197
|
+
baseOptions = configuration.baseOptions;
|
|
3198
|
+
}
|
|
3199
|
+
|
|
3200
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3201
|
+
const localVarHeaderParameter = {} as any;
|
|
3202
|
+
const localVarQueryParameter = {} as any;
|
|
3203
|
+
|
|
3204
|
+
// authentication ApiKeyAuth required
|
|
3205
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3206
|
+
|
|
3207
|
+
|
|
3208
|
+
|
|
3209
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3210
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3211
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3212
|
+
|
|
3213
|
+
return {
|
|
3214
|
+
url: toPathString(localVarUrlObj),
|
|
3215
|
+
options: localVarRequestOptions,
|
|
3216
|
+
};
|
|
3217
|
+
},
|
|
3218
|
+
}
|
|
3219
|
+
};
|
|
3220
|
+
|
|
3221
|
+
/**
|
|
3222
|
+
* JoinAccessApi - functional programming interface
|
|
3223
|
+
* @export
|
|
3224
|
+
*/
|
|
3225
|
+
export const JoinAccessApiFp = function(configuration?: Configuration) {
|
|
3226
|
+
const localVarAxiosParamCreator = JoinAccessApiAxiosParamCreator(configuration)
|
|
3227
|
+
return {
|
|
3228
|
+
/**
|
|
3229
|
+
* Grants the role stored on the access request (copied from the invite token at create time) via AuthZ V2 role assignment (source join).
|
|
3230
|
+
* @summary Accept a pending join access request
|
|
3231
|
+
* @param {string} orgId
|
|
3232
|
+
* @param {string} requestId
|
|
3233
|
+
* @param {*} [options] Override http request option.
|
|
3234
|
+
* @throws {RequiredError}
|
|
3235
|
+
*/
|
|
3236
|
+
async acceptJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJoinAccessRequest200Response>> {
|
|
3237
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.acceptJoinAccessRequest(orgId, requestId, options);
|
|
3238
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3239
|
+
const localVarOperationServerBasePath = operationServerMap['JoinAccessApi.acceptJoinAccessRequest']?.[localVarOperationServerIndex]?.url;
|
|
3240
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3241
|
+
},
|
|
3242
|
+
/**
|
|
3243
|
+
* Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one.
|
|
3244
|
+
* @summary Create an invite token
|
|
3245
|
+
* @param {string} orgId
|
|
3246
|
+
* @param {CreateInviteTokenRequest} [createInviteTokenRequest]
|
|
3247
|
+
* @param {*} [options] Override http request option.
|
|
3248
|
+
* @throws {RequiredError}
|
|
3249
|
+
*/
|
|
3250
|
+
async createInviteToken(orgId: string, createInviteTokenRequest?: CreateInviteTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteTokenResponse>> {
|
|
3251
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createInviteToken(orgId, createInviteTokenRequest, options);
|
|
3252
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3253
|
+
const localVarOperationServerBasePath = operationServerMap['JoinAccessApi.createInviteToken']?.[localVarOperationServerIndex]?.url;
|
|
3254
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3255
|
+
},
|
|
3256
|
+
/**
|
|
3257
|
+
* Validates the opaque invite token and creates (or returns) a pending AccessRequest for the property/role encoded on the token.
|
|
3258
|
+
* @summary Submit a join access request from an invite token
|
|
3259
|
+
* @param {string} orgId
|
|
3260
|
+
* @param {CreateJoinRequest} [createJoinRequest]
|
|
3261
|
+
* @param {*} [options] Override http request option.
|
|
3262
|
+
* @throws {RequiredError}
|
|
3263
|
+
*/
|
|
3264
|
+
async createJoinAccessRequest(orgId: string, createJoinRequest?: CreateJoinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessRequestResponse>> {
|
|
3265
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createJoinAccessRequest(orgId, createJoinRequest, options);
|
|
3266
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3267
|
+
const localVarOperationServerBasePath = operationServerMap['JoinAccessApi.createJoinAccessRequest']?.[localVarOperationServerIndex]?.url;
|
|
3268
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3269
|
+
},
|
|
3270
|
+
/**
|
|
3271
|
+
* Returns request status for the authenticated requester only. Owners should use the list endpoint.
|
|
3272
|
+
* @summary Get a join access request by id
|
|
3273
|
+
* @param {string} orgId
|
|
3274
|
+
* @param {string} requestId
|
|
3275
|
+
* @param {*} [options] Override http request option.
|
|
3276
|
+
* @throws {RequiredError}
|
|
3277
|
+
*/
|
|
3278
|
+
async getJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJoinAccessRequest200Response>> {
|
|
3279
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getJoinAccessRequest(orgId, requestId, options);
|
|
3280
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3281
|
+
const localVarOperationServerBasePath = operationServerMap['JoinAccessApi.getJoinAccessRequest']?.[localVarOperationServerIndex]?.url;
|
|
3282
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3283
|
+
},
|
|
3284
|
+
/**
|
|
3285
|
+
* Returns pending AccessRequests for an org. Optional propertyId/brandId filters. Requires ViewTeammates on orgId.
|
|
3286
|
+
* @summary List pending join requests for an organization
|
|
3287
|
+
* @param {string} orgId
|
|
3288
|
+
* @param {string} [propertyId]
|
|
3289
|
+
* @param {string} [brandId]
|
|
3290
|
+
* @param {*} [options] Override http request option.
|
|
3291
|
+
* @throws {RequiredError}
|
|
3292
|
+
*/
|
|
3293
|
+
async listJoinAccessRequests(orgId: string, propertyId?: string, brandId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListJoinRequestsResponse>> {
|
|
3294
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listJoinAccessRequests(orgId, propertyId, brandId, options);
|
|
3295
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3296
|
+
const localVarOperationServerBasePath = operationServerMap['JoinAccessApi.listJoinAccessRequests']?.[localVarOperationServerIndex]?.url;
|
|
3297
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3298
|
+
},
|
|
3299
|
+
/**
|
|
3300
|
+
* Rejects a pending AccessRequest without granting access.
|
|
3301
|
+
* @summary Reject a pending join access request
|
|
3302
|
+
* @param {string} orgId
|
|
3303
|
+
* @param {string} requestId
|
|
3304
|
+
* @param {*} [options] Override http request option.
|
|
3305
|
+
* @throws {RequiredError}
|
|
3306
|
+
*/
|
|
3307
|
+
async rejectJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetJoinAccessRequest200Response>> {
|
|
3308
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.rejectJoinAccessRequest(orgId, requestId, options);
|
|
3309
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3310
|
+
const localVarOperationServerBasePath = operationServerMap['JoinAccessApi.rejectJoinAccessRequest']?.[localVarOperationServerIndex]?.url;
|
|
3311
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3312
|
+
},
|
|
3313
|
+
}
|
|
3314
|
+
};
|
|
3315
|
+
|
|
3316
|
+
/**
|
|
3317
|
+
* JoinAccessApi - factory interface
|
|
3318
|
+
* @export
|
|
3319
|
+
*/
|
|
3320
|
+
export const JoinAccessApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3321
|
+
const localVarFp = JoinAccessApiFp(configuration)
|
|
3322
|
+
return {
|
|
3323
|
+
/**
|
|
3324
|
+
* Grants the role stored on the access request (copied from the invite token at create time) via AuthZ V2 role assignment (source join).
|
|
3325
|
+
* @summary Accept a pending join access request
|
|
3326
|
+
* @param {string} orgId
|
|
3327
|
+
* @param {string} requestId
|
|
3328
|
+
* @param {*} [options] Override http request option.
|
|
3329
|
+
* @throws {RequiredError}
|
|
3330
|
+
*/
|
|
3331
|
+
acceptJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetJoinAccessRequest200Response> {
|
|
3332
|
+
return localVarFp.acceptJoinAccessRequest(orgId, requestId, options).then((request) => request(axios, basePath));
|
|
3333
|
+
},
|
|
3334
|
+
/**
|
|
3335
|
+
* Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one.
|
|
3336
|
+
* @summary Create an invite token
|
|
3337
|
+
* @param {string} orgId
|
|
3338
|
+
* @param {CreateInviteTokenRequest} [createInviteTokenRequest]
|
|
3339
|
+
* @param {*} [options] Override http request option.
|
|
3340
|
+
* @throws {RequiredError}
|
|
3341
|
+
*/
|
|
3342
|
+
createInviteToken(orgId: string, createInviteTokenRequest?: CreateInviteTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<InviteTokenResponse> {
|
|
3343
|
+
return localVarFp.createInviteToken(orgId, createInviteTokenRequest, options).then((request) => request(axios, basePath));
|
|
3344
|
+
},
|
|
3345
|
+
/**
|
|
3346
|
+
* Validates the opaque invite token and creates (or returns) a pending AccessRequest for the property/role encoded on the token.
|
|
3347
|
+
* @summary Submit a join access request from an invite token
|
|
3348
|
+
* @param {string} orgId
|
|
3349
|
+
* @param {CreateJoinRequest} [createJoinRequest]
|
|
3350
|
+
* @param {*} [options] Override http request option.
|
|
3351
|
+
* @throws {RequiredError}
|
|
3352
|
+
*/
|
|
3353
|
+
createJoinAccessRequest(orgId: string, createJoinRequest?: CreateJoinRequest, options?: RawAxiosRequestConfig): AxiosPromise<AccessRequestResponse> {
|
|
3354
|
+
return localVarFp.createJoinAccessRequest(orgId, createJoinRequest, options).then((request) => request(axios, basePath));
|
|
3355
|
+
},
|
|
3356
|
+
/**
|
|
3357
|
+
* Returns request status for the authenticated requester only. Owners should use the list endpoint.
|
|
3358
|
+
* @summary Get a join access request by id
|
|
3359
|
+
* @param {string} orgId
|
|
3360
|
+
* @param {string} requestId
|
|
3361
|
+
* @param {*} [options] Override http request option.
|
|
3362
|
+
* @throws {RequiredError}
|
|
3363
|
+
*/
|
|
3364
|
+
getJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetJoinAccessRequest200Response> {
|
|
3365
|
+
return localVarFp.getJoinAccessRequest(orgId, requestId, options).then((request) => request(axios, basePath));
|
|
3366
|
+
},
|
|
3367
|
+
/**
|
|
3368
|
+
* Returns pending AccessRequests for an org. Optional propertyId/brandId filters. Requires ViewTeammates on orgId.
|
|
3369
|
+
* @summary List pending join requests for an organization
|
|
3370
|
+
* @param {string} orgId
|
|
3371
|
+
* @param {string} [propertyId]
|
|
3372
|
+
* @param {string} [brandId]
|
|
3373
|
+
* @param {*} [options] Override http request option.
|
|
3374
|
+
* @throws {RequiredError}
|
|
3375
|
+
*/
|
|
3376
|
+
listJoinAccessRequests(orgId: string, propertyId?: string, brandId?: string, options?: RawAxiosRequestConfig): AxiosPromise<ListJoinRequestsResponse> {
|
|
3377
|
+
return localVarFp.listJoinAccessRequests(orgId, propertyId, brandId, options).then((request) => request(axios, basePath));
|
|
3378
|
+
},
|
|
3379
|
+
/**
|
|
3380
|
+
* Rejects a pending AccessRequest without granting access.
|
|
3381
|
+
* @summary Reject a pending join access request
|
|
3382
|
+
* @param {string} orgId
|
|
3383
|
+
* @param {string} requestId
|
|
3384
|
+
* @param {*} [options] Override http request option.
|
|
3385
|
+
* @throws {RequiredError}
|
|
3386
|
+
*/
|
|
3387
|
+
rejectJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise<GetJoinAccessRequest200Response> {
|
|
3388
|
+
return localVarFp.rejectJoinAccessRequest(orgId, requestId, options).then((request) => request(axios, basePath));
|
|
3389
|
+
},
|
|
3390
|
+
};
|
|
3391
|
+
};
|
|
3392
|
+
|
|
3393
|
+
/**
|
|
3394
|
+
* JoinAccessApi - object-oriented interface
|
|
3395
|
+
* @export
|
|
3396
|
+
* @class JoinAccessApi
|
|
3397
|
+
* @extends {BaseAPI}
|
|
3398
|
+
*/
|
|
3399
|
+
export class JoinAccessApi extends BaseAPI {
|
|
3400
|
+
/**
|
|
3401
|
+
* Grants the role stored on the access request (copied from the invite token at create time) via AuthZ V2 role assignment (source join).
|
|
3402
|
+
* @summary Accept a pending join access request
|
|
3403
|
+
* @param {string} orgId
|
|
3404
|
+
* @param {string} requestId
|
|
3405
|
+
* @param {*} [options] Override http request option.
|
|
3406
|
+
* @throws {RequiredError}
|
|
3407
|
+
* @memberof JoinAccessApi
|
|
3408
|
+
*/
|
|
3409
|
+
public acceptJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig) {
|
|
3410
|
+
return JoinAccessApiFp(this.configuration).acceptJoinAccessRequest(orgId, requestId, options).then((request) => request(this.axios, this.basePath));
|
|
3411
|
+
}
|
|
3412
|
+
|
|
3413
|
+
/**
|
|
3414
|
+
* Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one.
|
|
3415
|
+
* @summary Create an invite token
|
|
3416
|
+
* @param {string} orgId
|
|
3417
|
+
* @param {CreateInviteTokenRequest} [createInviteTokenRequest]
|
|
3418
|
+
* @param {*} [options] Override http request option.
|
|
3419
|
+
* @throws {RequiredError}
|
|
3420
|
+
* @memberof JoinAccessApi
|
|
3421
|
+
*/
|
|
3422
|
+
public createInviteToken(orgId: string, createInviteTokenRequest?: CreateInviteTokenRequest, options?: RawAxiosRequestConfig) {
|
|
3423
|
+
return JoinAccessApiFp(this.configuration).createInviteToken(orgId, createInviteTokenRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3424
|
+
}
|
|
3425
|
+
|
|
3426
|
+
/**
|
|
3427
|
+
* Validates the opaque invite token and creates (or returns) a pending AccessRequest for the property/role encoded on the token.
|
|
3428
|
+
* @summary Submit a join access request from an invite token
|
|
3429
|
+
* @param {string} orgId
|
|
3430
|
+
* @param {CreateJoinRequest} [createJoinRequest]
|
|
3431
|
+
* @param {*} [options] Override http request option.
|
|
3432
|
+
* @throws {RequiredError}
|
|
3433
|
+
* @memberof JoinAccessApi
|
|
3434
|
+
*/
|
|
3435
|
+
public createJoinAccessRequest(orgId: string, createJoinRequest?: CreateJoinRequest, options?: RawAxiosRequestConfig) {
|
|
3436
|
+
return JoinAccessApiFp(this.configuration).createJoinAccessRequest(orgId, createJoinRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3437
|
+
}
|
|
3438
|
+
|
|
3439
|
+
/**
|
|
3440
|
+
* Returns request status for the authenticated requester only. Owners should use the list endpoint.
|
|
3441
|
+
* @summary Get a join access request by id
|
|
3442
|
+
* @param {string} orgId
|
|
3443
|
+
* @param {string} requestId
|
|
3444
|
+
* @param {*} [options] Override http request option.
|
|
3445
|
+
* @throws {RequiredError}
|
|
3446
|
+
* @memberof JoinAccessApi
|
|
3447
|
+
*/
|
|
3448
|
+
public getJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig) {
|
|
3449
|
+
return JoinAccessApiFp(this.configuration).getJoinAccessRequest(orgId, requestId, options).then((request) => request(this.axios, this.basePath));
|
|
3450
|
+
}
|
|
3451
|
+
|
|
3452
|
+
/**
|
|
3453
|
+
* Returns pending AccessRequests for an org. Optional propertyId/brandId filters. Requires ViewTeammates on orgId.
|
|
3454
|
+
* @summary List pending join requests for an organization
|
|
3455
|
+
* @param {string} orgId
|
|
3456
|
+
* @param {string} [propertyId]
|
|
3457
|
+
* @param {string} [brandId]
|
|
3458
|
+
* @param {*} [options] Override http request option.
|
|
3459
|
+
* @throws {RequiredError}
|
|
3460
|
+
* @memberof JoinAccessApi
|
|
3461
|
+
*/
|
|
3462
|
+
public listJoinAccessRequests(orgId: string, propertyId?: string, brandId?: string, options?: RawAxiosRequestConfig) {
|
|
3463
|
+
return JoinAccessApiFp(this.configuration).listJoinAccessRequests(orgId, propertyId, brandId, options).then((request) => request(this.axios, this.basePath));
|
|
3464
|
+
}
|
|
3465
|
+
|
|
3466
|
+
/**
|
|
3467
|
+
* Rejects a pending AccessRequest without granting access.
|
|
3468
|
+
* @summary Reject a pending join access request
|
|
3469
|
+
* @param {string} orgId
|
|
3470
|
+
* @param {string} requestId
|
|
3471
|
+
* @param {*} [options] Override http request option.
|
|
3472
|
+
* @throws {RequiredError}
|
|
3473
|
+
* @memberof JoinAccessApi
|
|
3474
|
+
*/
|
|
3475
|
+
public rejectJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig) {
|
|
3476
|
+
return JoinAccessApiFp(this.configuration).rejectJoinAccessRequest(orgId, requestId, options).then((request) => request(this.axios, this.basePath));
|
|
3477
|
+
}
|
|
3478
|
+
}
|
|
3479
|
+
|
|
3480
|
+
|
|
3481
|
+
|
|
2597
3482
|
/**
|
|
2598
3483
|
* RoleAssignmentApi - axios parameter creator
|
|
2599
3484
|
* @export
|