/** * Authorization API * Authorization API * * The version of the OpenAPI document: 0.0.1 * Contact: support@flipdish.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface AcceptJoinRequest */ export interface AcceptJoinRequest { /** * * @type {string} * @memberof AcceptJoinRequest */ 'roleName'?: AcceptJoinRequestRoleNameEnum; /** * * @type {Array} * @memberof AcceptJoinRequest */ 'propertyIds'?: Array; } export declare const AcceptJoinRequestRoleNameEnum: { readonly Owner: "Owner"; readonly PropertyOwner: "PropertyOwner"; readonly ManagedOwner: "ManagedOwner"; readonly Integrator: "Integrator"; readonly PropertyManager: "PropertyManager"; readonly FinanceManager: "FinanceManager"; readonly StaffMember: "StaffMember"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type AcceptJoinRequestRoleNameEnum = typeof AcceptJoinRequestRoleNameEnum[keyof typeof AcceptJoinRequestRoleNameEnum]; /** * * @export * @interface AccessBlockStateResponse */ export interface AccessBlockStateResponse { /** * * @type {AccessBlockStateResponseBlockedPrincipal} * @memberof AccessBlockStateResponse */ 'principal': AccessBlockStateResponseBlockedPrincipal; /** * * @type {string} * @memberof AccessBlockStateResponse */ 'reason'?: string; /** * * @type {string} * @memberof AccessBlockStateResponse */ 'blockedAt': string; /** * * @type {AccessBlockStateResponseBlockedBlockedBy} * @memberof AccessBlockStateResponse */ 'blockedBy': AccessBlockStateResponseBlockedBlockedBy; } /** * * @export * @interface AccessBlockStateResponseBlocked */ export interface AccessBlockStateResponseBlocked { /** * * @type {AccessBlockStateResponseBlockedPrincipal} * @memberof AccessBlockStateResponseBlocked */ 'principal': AccessBlockStateResponseBlockedPrincipal; /** * * @type {string} * @memberof AccessBlockStateResponseBlocked */ 'reason'?: string; /** * * @type {string} * @memberof AccessBlockStateResponseBlocked */ 'blockedAt': string; /** * * @type {AccessBlockStateResponseBlockedBlockedBy} * @memberof AccessBlockStateResponseBlocked */ 'blockedBy': AccessBlockStateResponseBlockedBlockedBy; } /** * * @export * @interface AccessBlockStateResponseBlockedBlockedBy */ export interface AccessBlockStateResponseBlockedBlockedBy { /** * * @type {string} * @memberof AccessBlockStateResponseBlockedBlockedBy */ 'principalId': string; /** * * @type {string} * @memberof AccessBlockStateResponseBlockedBlockedBy */ 'email': string; } /** * * @export * @interface AccessBlockStateResponseBlockedPrincipal */ export interface AccessBlockStateResponseBlockedPrincipal { /** * * @type {string} * @memberof AccessBlockStateResponseBlockedPrincipal */ 'type': AccessBlockStateResponseBlockedPrincipalTypeEnum; /** * * @type {string} * @memberof AccessBlockStateResponseBlockedPrincipal */ 'id': string; } export declare const AccessBlockStateResponseBlockedPrincipalTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type AccessBlockStateResponseBlockedPrincipalTypeEnum = typeof AccessBlockStateResponseBlockedPrincipalTypeEnum[keyof typeof AccessBlockStateResponseBlockedPrincipalTypeEnum]; /** * * @export * @interface AccessRequestResponse */ export interface AccessRequestResponse { /** * * @type {string} * @memberof AccessRequestResponse */ 'requestId': string; /** * * @type {string} * @memberof AccessRequestResponse */ 'state': AccessRequestResponseStateEnum; /** * * @type {string} * @memberof AccessRequestResponse */ 'requesterUserId': string; /** * * @type {string} * @memberof AccessRequestResponse */ 'requesterEmail': string; /** * * @type {string} * @memberof AccessRequestResponse */ 'requesterName'?: string; /** * * @type {string} * @memberof AccessRequestResponse */ 'orgId': string; /** * * @type {string} * @memberof AccessRequestResponse */ 'orgName': string; /** * * @type {Array} * @memberof AccessRequestResponse */ 'propertyIds': Array; /** * * @type {Array} * @memberof AccessRequestResponse */ 'brandIds': Array; /** * * @type {Array} * @memberof AccessRequestResponse */ 'salesChannelIds': Array; /** * * @type {string} * @memberof AccessRequestResponse */ 'roleName': AccessRequestResponseRoleNameEnum; /** * * @type {string} * @memberof AccessRequestResponse */ 'createdAt': string; /** * * @type {string} * @memberof AccessRequestResponse */ 'decidedAt'?: string; /** * * @type {string} * @memberof AccessRequestResponse */ 'decidedByUserId'?: string; } export declare const AccessRequestResponseStateEnum: { readonly Pending: "Pending"; readonly Approved: "Approved"; readonly Rejected: "Rejected"; readonly Expired: "Expired"; }; export type AccessRequestResponseStateEnum = typeof AccessRequestResponseStateEnum[keyof typeof AccessRequestResponseStateEnum]; export declare const AccessRequestResponseRoleNameEnum: { readonly Owner: "Owner"; readonly PropertyOwner: "PropertyOwner"; readonly ManagedOwner: "ManagedOwner"; readonly Integrator: "Integrator"; readonly PropertyManager: "PropertyManager"; readonly FinanceManager: "FinanceManager"; readonly StaffMember: "StaffMember"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type AccessRequestResponseRoleNameEnum = typeof AccessRequestResponseRoleNameEnum[keyof typeof AccessRequestResponseRoleNameEnum]; /** * * @export * @interface ApplyNamedRoleRequestBody */ export interface ApplyNamedRoleRequestBody { /** * The user receiving the role * @type {string} * @memberof ApplyNamedRoleRequestBody */ 'userId': string; /** * * @type {RoleNames} * @memberof ApplyNamedRoleRequestBody */ 'roleName': RoleNames; } /** * 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. * @export * @interface AuthenticateAndAuthorizeRequest */ export interface AuthenticateAndAuthorizeRequest { /** * Incoming request headers to be used for authentication * @type {{ [key: string]: string; }} * @memberof AuthenticateAndAuthorizeRequest */ 'headers': { [key: string]: string; }; /** * * @type {AuthorizationRequestAction} * @memberof AuthenticateAndAuthorizeRequest */ 'action': AuthorizationRequestAction; /** * * @type {AuthorizationRequestResource} * @memberof AuthenticateAndAuthorizeRequest */ 'resource'?: AuthorizationRequestResource; /** * How to check authorisation - any or all of the actions must be allowed * @type {string} * @memberof AuthenticateAndAuthorizeRequest */ 'checkMode'?: AuthenticateAndAuthorizeRequestCheckModeEnum; } export declare const AuthenticateAndAuthorizeRequestCheckModeEnum: { readonly Any: "any"; readonly All: "all"; }; export type AuthenticateAndAuthorizeRequestCheckModeEnum = typeof AuthenticateAndAuthorizeRequestCheckModeEnum[keyof typeof AuthenticateAndAuthorizeRequestCheckModeEnum]; /** * Response containing the authentication and authorization decision * @export * @interface AuthenticateAndAuthorizeResponse */ export interface AuthenticateAndAuthorizeResponse { /** * * @type {AuthenticateAndCheckIsInRoleResponseAuthentication} * @memberof AuthenticateAndAuthorizeResponse */ 'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication; /** * Opaque credential to forward to downstream services. Callers should propagate this value without inspecting it. * @type {string} * @memberof AuthenticateAndAuthorizeResponse */ 'forwardableCredential'?: string; /** * * @type {AuthorizationResponse} * @memberof AuthenticateAndAuthorizeResponse */ 'authorization'?: AuthorizationResponse; } /** * * @export * @interface AuthenticateAndCheckIsInRoleRequest */ export interface AuthenticateAndCheckIsInRoleRequest { /** * Incoming request headers to be used for authentication * @type {{ [key: string]: string; }} * @memberof AuthenticateAndCheckIsInRoleRequest */ 'headers': { [key: string]: string; }; /** * Array of roles to check if the principal is in * @type {Array} * @memberof AuthenticateAndCheckIsInRoleRequest */ 'roles': Array; /** * * @type {string} * @memberof AuthenticateAndCheckIsInRoleRequest */ 'checkMode'?: AuthenticateAndCheckIsInRoleRequestCheckModeEnum; } export declare const AuthenticateAndCheckIsInRoleRequestCheckModeEnum: { readonly Any: "any"; readonly All: "all"; }; export type AuthenticateAndCheckIsInRoleRequestCheckModeEnum = typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum[keyof typeof AuthenticateAndCheckIsInRoleRequestCheckModeEnum]; /** * Response containing whether the principal is in any/all of the roles * @export * @interface AuthenticateAndCheckIsInRoleResponse */ export interface AuthenticateAndCheckIsInRoleResponse { /** * * @type {AuthenticateAndCheckIsInRoleResponseAuthentication} * @memberof AuthenticateAndCheckIsInRoleResponse */ 'authentication': AuthenticateAndCheckIsInRoleResponseAuthentication; /** * result of the check - whether the principal is in any/all of the roles * @type {boolean} * @memberof AuthenticateAndCheckIsInRoleResponse */ 'authorized': boolean; } /** * * @export * @interface AuthenticateAndCheckIsInRoleResponseAuthentication */ export interface AuthenticateAndCheckIsInRoleResponseAuthentication { /** * * @type {AuthorizationRequestPrincipal} * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication */ 'principal': AuthorizationRequestPrincipal; /** * Whether the user is authenticated * @type {boolean} * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication */ 'authenticated': boolean; /** * The reason for the authentication failure * @type {string} * @memberof AuthenticateAndCheckIsInRoleResponseAuthentication */ 'reason'?: string; } /** * * @export * @interface AuthenticateApiKey200Response */ export interface AuthenticateApiKey200Response { /** * * @type {boolean} * @memberof AuthenticateApiKey200Response */ 'ok': AuthenticateApiKey200ResponseOkEnum; } export declare const AuthenticateApiKey200ResponseOkEnum: { readonly True: true; }; export type AuthenticateApiKey200ResponseOkEnum = typeof AuthenticateApiKey200ResponseOkEnum[keyof typeof AuthenticateApiKey200ResponseOkEnum]; /** * * @export * @interface AuthorizationBatchRequest */ export interface AuthorizationBatchRequest { /** * * @type {AuthorizationRequestPrincipal} * @memberof AuthorizationBatchRequest */ 'principal': AuthorizationRequestPrincipal; /** * * @type {Permissions} * @memberof AuthorizationBatchRequest */ 'action': Permissions; /** * Array of resources to check authorisation for * @type {Array} * @memberof AuthorizationBatchRequest */ 'resources': Array; } /** * * @export * @interface AuthorizationBatchResponse */ export interface AuthorizationBatchResponse { /** * Array of allowed resources * @type {Array} * @memberof AuthorizationBatchResponse */ 'allowedResources': Array; /** * Array of denied resources * @type {Array} * @memberof AuthorizationBatchResponse */ 'deniedResources': Array; } /** * * @export * @interface AuthorizationBatchResponseAllowedResourcesInner */ export interface AuthorizationBatchResponseAllowedResourcesInner { /** * The authorization decision * @type {string} * @memberof AuthorizationBatchResponseAllowedResourcesInner */ 'decision': string; /** * Whether the action is allowed * @type {boolean} * @memberof AuthorizationBatchResponseAllowedResourcesInner */ 'allowed': boolean; /** * The policy IDs that were used to make the decision * @type {Array} * @memberof AuthorizationBatchResponseAllowedResourcesInner */ 'policyIds': Array; /** * * @type {AuthorizationBatchResponseAllowedResourcesInnerPrincipal} * @memberof AuthorizationBatchResponseAllowedResourcesInner */ 'principal': AuthorizationBatchResponseAllowedResourcesInnerPrincipal; /** * * @type {AuthorizationBatchResponseAllowedResourcesInnerResource} * @memberof AuthorizationBatchResponseAllowedResourcesInner */ 'resource': AuthorizationBatchResponseAllowedResourcesInnerResource; /** * * @type {Permissions} * @memberof AuthorizationBatchResponseAllowedResourcesInner */ 'action': Permissions; } /** * Principal that the action was checked for * @export * @interface AuthorizationBatchResponseAllowedResourcesInnerPrincipal */ export interface AuthorizationBatchResponseAllowedResourcesInnerPrincipal { /** * * @type {string} * @memberof AuthorizationBatchResponseAllowedResourcesInnerPrincipal */ 'type': AuthorizationBatchResponseAllowedResourcesInnerPrincipalTypeEnum; /** * * @type {string} * @memberof AuthorizationBatchResponseAllowedResourcesInnerPrincipal */ 'id': string; /** * * @type {string} * @memberof AuthorizationBatchResponseAllowedResourcesInnerPrincipal */ 'name'?: string; /** * * @type {string} * @memberof AuthorizationBatchResponseAllowedResourcesInnerPrincipal */ 'email'?: string; /** * * @type {string} * @memberof AuthorizationBatchResponseAllowedResourcesInnerPrincipal */ 'phone'?: string; } export declare const AuthorizationBatchResponseAllowedResourcesInnerPrincipalTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type AuthorizationBatchResponseAllowedResourcesInnerPrincipalTypeEnum = typeof AuthorizationBatchResponseAllowedResourcesInnerPrincipalTypeEnum[keyof typeof AuthorizationBatchResponseAllowedResourcesInnerPrincipalTypeEnum]; /** * @type AuthorizationBatchResponseAllowedResourcesInnerResource * Resource that the action was checked for * @export */ export type AuthorizationBatchResponseAllowedResourcesInnerResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3; /** * * @export * @interface AuthorizationChecksBatchRequest */ export interface AuthorizationChecksBatchRequest { /** * Principal/resource/action tuples to check authorisation for. Checks that share a principal or a resource are evaluated most efficiently; batches spanning too many distinct combinations are rejected with a 400. * @type {Array} * @memberof AuthorizationChecksBatchRequest */ 'checks': Array; } /** * * @export * @interface AuthorizationChecksBatchRequestChecksInner */ export interface AuthorizationChecksBatchRequestChecksInner { /** * * @type {AuthorizationRequestPrincipal} * @memberof AuthorizationChecksBatchRequestChecksInner */ 'principal': AuthorizationRequestPrincipal; /** * * @type {AuthorizationRequestResource} * @memberof AuthorizationChecksBatchRequestChecksInner */ 'resource': AuthorizationRequestResource; /** * * @type {Permissions} * @memberof AuthorizationChecksBatchRequestChecksInner */ 'action': Permissions; } /** * * @export * @interface AuthorizationChecksBatchResponse */ export interface AuthorizationChecksBatchResponse { /** * Allowed principal/resource checks * @type {Array} * @memberof AuthorizationChecksBatchResponse */ 'allowedResources': Array; /** * Denied principal/resource checks * @type {Array} * @memberof AuthorizationChecksBatchResponse */ 'deniedResources': Array; } /** * Request to check if a user is authorized to perform an action(s). If you pass in an array of permissions, you will receive a single allow / deny response (based on the checkMode - any or all of the permissions must be allowed). * @export * @interface AuthorizationRequest */ export interface AuthorizationRequest { /** * * @type {AuthorizationRequestPrincipal} * @memberof AuthorizationRequest */ 'principal': AuthorizationRequestPrincipal; /** * * @type {AuthorizationRequestAction} * @memberof AuthorizationRequest */ 'action': AuthorizationRequestAction; /** * * @type {AuthorizationRequestResource} * @memberof AuthorizationRequest */ 'resource'?: AuthorizationRequestResource; /** * How to check authorisation - any or all of the actions must be allowed * @type {string} * @memberof AuthorizationRequest */ 'checkMode'?: AuthorizationRequestCheckModeEnum; } export declare const AuthorizationRequestCheckModeEnum: { readonly Any: "any"; readonly All: "all"; }; export type AuthorizationRequestCheckModeEnum = typeof AuthorizationRequestCheckModeEnum[keyof typeof AuthorizationRequestCheckModeEnum]; /** * Permission or array of permissions - note that you still only receive a single allow / deny response (calculated based on the checkMode) * @export * @interface AuthorizationRequestAction */ export interface AuthorizationRequestAction { } /** * * @export * @interface AuthorizationRequestPrincipal */ export interface AuthorizationRequestPrincipal { /** * * @type {string} * @memberof AuthorizationRequestPrincipal */ 'type': AuthorizationRequestPrincipalTypeEnum; /** * * @type {string} * @memberof AuthorizationRequestPrincipal */ 'id': string; /** * * @type {string} * @memberof AuthorizationRequestPrincipal */ 'name'?: string; /** * * @type {string} * @memberof AuthorizationRequestPrincipal */ 'email'?: string; /** * * @type {string} * @memberof AuthorizationRequestPrincipal */ 'phone'?: string; } export declare const AuthorizationRequestPrincipalTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type AuthorizationRequestPrincipalTypeEnum = typeof AuthorizationRequestPrincipalTypeEnum[keyof typeof AuthorizationRequestPrincipalTypeEnum]; /** * @type AuthorizationRequestResource * @export */ export type AuthorizationRequestResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3; /** * * @export * @interface AuthorizationRequestResourceOneOf */ export interface AuthorizationRequestResourceOneOf { /** * * @type {string} * @memberof AuthorizationRequestResourceOneOf */ 'type': AuthorizationRequestResourceOneOfTypeEnum; /** * * @type {string} * @memberof AuthorizationRequestResourceOneOf */ 'id': string; } export declare const AuthorizationRequestResourceOneOfTypeEnum: { readonly Property: "Property"; }; export type AuthorizationRequestResourceOneOfTypeEnum = typeof AuthorizationRequestResourceOneOfTypeEnum[keyof typeof AuthorizationRequestResourceOneOfTypeEnum]; /** * * @export * @interface AuthorizationRequestResourceOneOf1 */ export interface AuthorizationRequestResourceOneOf1 { /** * * @type {string} * @memberof AuthorizationRequestResourceOneOf1 */ 'type': AuthorizationRequestResourceOneOf1TypeEnum; /** * * @type {string} * @memberof AuthorizationRequestResourceOneOf1 */ 'id': string; } export declare const AuthorizationRequestResourceOneOf1TypeEnum: { readonly Org: "Org"; }; export type AuthorizationRequestResourceOneOf1TypeEnum = typeof AuthorizationRequestResourceOneOf1TypeEnum[keyof typeof AuthorizationRequestResourceOneOf1TypeEnum]; /** * * @export * @interface AuthorizationRequestResourceOneOf2 */ export interface AuthorizationRequestResourceOneOf2 { /** * * @type {string} * @memberof AuthorizationRequestResourceOneOf2 */ 'type': AuthorizationRequestResourceOneOf2TypeEnum; /** * * @type {string} * @memberof AuthorizationRequestResourceOneOf2 */ 'id': string; } export declare const AuthorizationRequestResourceOneOf2TypeEnum: { readonly Brand: "Brand"; }; export type AuthorizationRequestResourceOneOf2TypeEnum = typeof AuthorizationRequestResourceOneOf2TypeEnum[keyof typeof AuthorizationRequestResourceOneOf2TypeEnum]; /** * * @export * @interface AuthorizationRequestResourceOneOf3 */ export interface AuthorizationRequestResourceOneOf3 { /** * * @type {string} * @memberof AuthorizationRequestResourceOneOf3 */ 'type': AuthorizationRequestResourceOneOf3TypeEnum; /** * * @type {string} * @memberof AuthorizationRequestResourceOneOf3 */ 'id': string; } export declare const AuthorizationRequestResourceOneOf3TypeEnum: { readonly SalesChannel: "SalesChannel"; }; export type AuthorizationRequestResourceOneOf3TypeEnum = typeof AuthorizationRequestResourceOneOf3TypeEnum[keyof typeof AuthorizationRequestResourceOneOf3TypeEnum]; /** * Response containing the authorization decision * @export * @interface AuthorizationResponse */ export interface AuthorizationResponse { /** * Whether the action is allowed * @type {boolean} * @memberof AuthorizationResponse */ 'allowed': boolean; /** * The authorization decision * @type {string} * @memberof AuthorizationResponse */ 'decision': string; /** * The policy IDs that were used to make the decision * @type {Array} * @memberof AuthorizationResponse */ 'policyIds': Array; } /** * * @export * @interface AuthorizeBatchChecks400Response */ export interface AuthorizeBatchChecks400Response { /** * * @type {string} * @memberof AuthorizeBatchChecks400Response */ 'message': string; } /** * * @export * @interface AuthorizeBatchChecks400ResponseAnyOf */ export interface AuthorizeBatchChecks400ResponseAnyOf { /** * * @type {string} * @memberof AuthorizeBatchChecks400ResponseAnyOf */ 'message': string; } /** * * @export * @interface AuthorizeBatchChecks400ResponseAnyOfInner */ export interface AuthorizeBatchChecks400ResponseAnyOfInner { /** * * @type {Array} * @memberof AuthorizeBatchChecks400ResponseAnyOfInner */ 'path'?: Array; /** * * @type {string} * @memberof AuthorizeBatchChecks400ResponseAnyOfInner */ 'message': string; } /** * * @export * @interface AuthorizeBatchChecks400ResponseAnyOfInnerPathInner */ export interface AuthorizeBatchChecks400ResponseAnyOfInnerPathInner { } /** * * @export * @interface BlockPrincipalAccessRequest */ export interface BlockPrincipalAccessRequest { /** * * @type {AccessBlockStateResponseBlockedPrincipal} * @memberof BlockPrincipalAccessRequest */ 'principal': AccessBlockStateResponseBlockedPrincipal; /** * * @type {string} * @memberof BlockPrincipalAccessRequest */ 'reason'?: string; } /** * * @export * @interface CreateGlobalApiKeyRequest */ export interface CreateGlobalApiKeyRequest { /** * * @type {string} * @memberof CreateGlobalApiKeyRequest */ 'name': string; /** * * @type {Array} * @memberof CreateGlobalApiKeyRequest */ 'permissions': Array; /** * * @type {CreateGlobalApiKeyRequestResource} * @memberof CreateGlobalApiKeyRequest */ 'resource'?: CreateGlobalApiKeyRequestResource; /** * * @type {boolean} * @memberof CreateGlobalApiKeyRequest */ 'global'?: boolean; /** * * @type {string} * @memberof CreateGlobalApiKeyRequest */ 'expiresAt'?: string; /** * * @type {string} * @memberof CreateGlobalApiKeyRequest */ 'orgId'?: string; } /** * @type CreateGlobalApiKeyRequestResource * Single resource the key is scoped to (required when global is false) * @export */ export type CreateGlobalApiKeyRequestResource = AuthorizationRequestResourceOneOf | AuthorizationRequestResourceOneOf1 | AuthorizationRequestResourceOneOf2 | AuthorizationRequestResourceOneOf3; /** * * @export * @interface CreateGlobalApiKeyResponse */ export interface CreateGlobalApiKeyResponse { /** * Raw API key secret — returned only once at creation * @type {string} * @memberof CreateGlobalApiKeyResponse */ 'apiKey': string; /** * * @type {GlobalApiKeyStateResponse} * @memberof CreateGlobalApiKeyResponse */ 'state': GlobalApiKeyStateResponse; } /** * * @export * @interface CreateInviteTokenRequest */ export interface CreateInviteTokenRequest { /** * * @type {string} * @memberof CreateInviteTokenRequest */ 'storefrontId': string; /** * * @type {string} * @memberof CreateInviteTokenRequest */ 'propertyId': string; /** * * @type {string} * @memberof CreateInviteTokenRequest */ 'orgName': string; } /** * * @export * @interface CreateJoinRequest */ export interface CreateJoinRequest { /** * * @type {string} * @memberof CreateJoinRequest */ 'token': string; } /** * * @export * @interface ErrorResponse */ export interface ErrorResponse { /** * * @type {string} * @memberof ErrorResponse */ 'message': string; } /** * Request to get authorized brands for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used. * @export * @interface GetAuthorizedBrandsRequest */ export interface GetAuthorizedBrandsRequest { /** * * @type {GetAuthorizedOrgsRequestPrincipal} * @memberof GetAuthorizedBrandsRequest */ 'principal'?: GetAuthorizedOrgsRequestPrincipal; /** * Incoming request headers to be used for authentication * @type {{ [key: string]: string; }} * @memberof GetAuthorizedBrandsRequest */ 'headers'?: { [key: string]: string; }; /** * * @type {Permissions} * @memberof GetAuthorizedBrandsRequest */ 'action': Permissions; } /** * Response containing the authorized brands * @export * @interface GetAuthorizedBrandsResponse */ export interface GetAuthorizedBrandsResponse { /** * Array of allowed resources * @type {Array} * @memberof GetAuthorizedBrandsResponse */ 'allowedResources': Array; /** * Array of denied resources * @type {Array} * @memberof GetAuthorizedBrandsResponse */ 'deniedResources': Array; } /** * Request to get authorized orgs for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used. * @export * @interface GetAuthorizedOrgsRequest */ export interface GetAuthorizedOrgsRequest { /** * * @type {GetAuthorizedOrgsRequestPrincipal} * @memberof GetAuthorizedOrgsRequest */ 'principal'?: GetAuthorizedOrgsRequestPrincipal; /** * Incoming request headers to be used for authentication * @type {{ [key: string]: string; }} * @memberof GetAuthorizedOrgsRequest */ 'headers'?: { [key: string]: string; }; /** * * @type {Permissions} * @memberof GetAuthorizedOrgsRequest */ 'action': Permissions; } /** * The principal to get authorized entities for * @export * @interface GetAuthorizedOrgsRequestPrincipal */ export interface GetAuthorizedOrgsRequestPrincipal { /** * * @type {string} * @memberof GetAuthorizedOrgsRequestPrincipal */ 'type': GetAuthorizedOrgsRequestPrincipalTypeEnum; /** * * @type {string} * @memberof GetAuthorizedOrgsRequestPrincipal */ 'id': string; /** * * @type {string} * @memberof GetAuthorizedOrgsRequestPrincipal */ 'name'?: string; /** * * @type {string} * @memberof GetAuthorizedOrgsRequestPrincipal */ 'email'?: string; /** * * @type {string} * @memberof GetAuthorizedOrgsRequestPrincipal */ 'phone'?: string; } export declare const GetAuthorizedOrgsRequestPrincipalTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type GetAuthorizedOrgsRequestPrincipalTypeEnum = typeof GetAuthorizedOrgsRequestPrincipalTypeEnum[keyof typeof GetAuthorizedOrgsRequestPrincipalTypeEnum]; /** * Response containing the authorized orgs * @export * @interface GetAuthorizedOrgsResponse */ export interface GetAuthorizedOrgsResponse { /** * Array of allowed resources * @type {Array} * @memberof GetAuthorizedOrgsResponse */ 'allowedResources': Array; /** * Array of denied resources * @type {Array} * @memberof GetAuthorizedOrgsResponse */ 'deniedResources': Array; } /** * Request to get authorized properties for a principal or the authenticated user based on the headers. Either principal or headers must be provided, but not both. If both are provided, the principal will be used. * @export * @interface GetAuthorizedPropertiesRequest */ export interface GetAuthorizedPropertiesRequest { /** * * @type {GetAuthorizedOrgsRequestPrincipal} * @memberof GetAuthorizedPropertiesRequest */ 'principal'?: GetAuthorizedOrgsRequestPrincipal; /** * Incoming request headers to be used for authentication * @type {{ [key: string]: string; }} * @memberof GetAuthorizedPropertiesRequest */ 'headers'?: { [key: string]: string; }; /** * * @type {Permissions} * @memberof GetAuthorizedPropertiesRequest */ 'action': Permissions; } /** * Response containing the authorized properties * @export * @interface GetAuthorizedPropertiesResponse */ export interface GetAuthorizedPropertiesResponse { /** * Array of allowed resources * @type {Array} * @memberof GetAuthorizedPropertiesResponse */ 'allowedResources': Array; /** * Array of denied resources * @type {Array} * @memberof GetAuthorizedPropertiesResponse */ 'deniedResources': Array; } /** * * @export * @interface GetJoinAccessRequest200Response */ export interface GetJoinAccessRequest200Response { /** * * @type {string} * @memberof GetJoinAccessRequest200Response */ 'requestId': string; /** * * @type {string} * @memberof GetJoinAccessRequest200Response */ 'state': GetJoinAccessRequest200ResponseStateEnum; /** * * @type {string} * @memberof GetJoinAccessRequest200Response */ 'requesterUserId': string; /** * * @type {string} * @memberof GetJoinAccessRequest200Response */ 'requesterEmail': string; /** * * @type {string} * @memberof GetJoinAccessRequest200Response */ 'requesterName'?: string; /** * * @type {string} * @memberof GetJoinAccessRequest200Response */ 'orgId': string; /** * * @type {string} * @memberof GetJoinAccessRequest200Response */ 'orgName': string; /** * * @type {Array} * @memberof GetJoinAccessRequest200Response */ 'propertyIds': Array; /** * * @type {Array} * @memberof GetJoinAccessRequest200Response */ 'brandIds': Array; /** * * @type {Array} * @memberof GetJoinAccessRequest200Response */ 'salesChannelIds': Array; /** * * @type {string} * @memberof GetJoinAccessRequest200Response */ 'roleName': GetJoinAccessRequest200ResponseRoleNameEnum; /** * * @type {string} * @memberof GetJoinAccessRequest200Response */ 'createdAt': string; /** * * @type {string} * @memberof GetJoinAccessRequest200Response */ 'decidedAt'?: string; /** * * @type {string} * @memberof GetJoinAccessRequest200Response */ 'decidedByUserId'?: string; } export declare const GetJoinAccessRequest200ResponseStateEnum: { readonly Pending: "Pending"; readonly Approved: "Approved"; readonly Rejected: "Rejected"; readonly Expired: "Expired"; }; export type GetJoinAccessRequest200ResponseStateEnum = typeof GetJoinAccessRequest200ResponseStateEnum[keyof typeof GetJoinAccessRequest200ResponseStateEnum]; export declare const GetJoinAccessRequest200ResponseRoleNameEnum: { readonly Owner: "Owner"; readonly PropertyOwner: "PropertyOwner"; readonly ManagedOwner: "ManagedOwner"; readonly Integrator: "Integrator"; readonly PropertyManager: "PropertyManager"; readonly FinanceManager: "FinanceManager"; readonly StaffMember: "StaffMember"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type GetJoinAccessRequest200ResponseRoleNameEnum = typeof GetJoinAccessRequest200ResponseRoleNameEnum[keyof typeof GetJoinAccessRequest200ResponseRoleNameEnum]; /** * * @export * @interface GetJoinAccessRequest200ResponsePropertyIdsInner */ export interface GetJoinAccessRequest200ResponsePropertyIdsInner { } /** * Successful user permissions retrieval response * @export * @interface GetUserPermissionsSuccessResponse */ export interface GetUserPermissionsSuccessResponse { /** * Map of resource IDs to permissions * @type {{ [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }} * @memberof GetUserPermissionsSuccessResponse */ 'resources': { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }; } /** * * @export * @interface GetUserPermissionsSuccessResponseResourcesValue */ export interface GetUserPermissionsSuccessResponseResourcesValue { /** * Type of resource the permissions are assigned to * @type {string} * @memberof GetUserPermissionsSuccessResponseResourcesValue */ 'resourceType': GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum; /** * * @type {GetUserPermissionsSuccessResponseResourcesValueResourceId} * @memberof GetUserPermissionsSuccessResponseResourcesValue */ 'resourceId': GetUserPermissionsSuccessResponseResourcesValueResourceId; /** * List of permissions that are assigned to the user for the resource * @type {Array} * @memberof GetUserPermissionsSuccessResponseResourcesValue */ 'permissions': Array; } export declare const GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum: { readonly Property: "Property"; readonly Org: "Org"; readonly Brand: "Brand"; readonly SalesChannel: "SalesChannel"; }; export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum[keyof typeof GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum]; /** * ID of the resource the permissions are assigned to * @export * @interface GetUserPermissionsSuccessResponseResourcesValueResourceId */ export interface GetUserPermissionsSuccessResponseResourcesValueResourceId { } /** * * @export * @interface GlobalApiKeyStateResponse */ export interface GlobalApiKeyStateResponse { /** * * @type {string} * @memberof GlobalApiKeyStateResponse */ 'principalId': string; /** * * @type {string} * @memberof GlobalApiKeyStateResponse */ 'name'?: string; /** * * @type {string} * @memberof GlobalApiKeyStateResponse */ 'status': GlobalApiKeyStateResponseStatusEnum; /** * * @type {string} * @memberof GlobalApiKeyStateResponse */ 'expiresAt'?: string; /** * * @type {string} * @memberof GlobalApiKeyStateResponse */ 'orgId'?: string; /** * * @type {string} * @memberof GlobalApiKeyStateResponse */ 'createdByEmail': string; /** * * @type {Array} * @memberof GlobalApiKeyStateResponse */ 'permissions': Array; /** * * @type {Array} * @memberof GlobalApiKeyStateResponse */ 'resources'?: Array; /** * When true, the key is authorized for all resources (unbound Cedar resource) * @type {boolean} * @memberof GlobalApiKeyStateResponse */ 'global': boolean; /** * * @type {string} * @memberof GlobalApiKeyStateResponse */ 'avpPolicyId': string; /** * * @type {string} * @memberof GlobalApiKeyStateResponse */ 'createdAt': string; /** * * @type {string} * @memberof GlobalApiKeyStateResponse */ 'updatedAt': string; /** * ISO-8601 timestamp of the most recent successful authentication with this key * @type {string} * @memberof GlobalApiKeyStateResponse */ 'lastUsedAt'?: string; } export declare const GlobalApiKeyStateResponseStatusEnum: { readonly Active: "active"; readonly Revoked: "revoked"; }; export type GlobalApiKeyStateResponseStatusEnum = typeof GlobalApiKeyStateResponseStatusEnum[keyof typeof GlobalApiKeyStateResponseStatusEnum]; /** * * @export * @interface GlobalApiKeyStateResponseRevoked */ export interface GlobalApiKeyStateResponseRevoked { /** * * @type {string} * @memberof GlobalApiKeyStateResponseRevoked */ 'principalId': string; /** * * @type {string} * @memberof GlobalApiKeyStateResponseRevoked */ 'name'?: string; /** * * @type {string} * @memberof GlobalApiKeyStateResponseRevoked */ 'status': GlobalApiKeyStateResponseRevokedStatusEnum; /** * * @type {string} * @memberof GlobalApiKeyStateResponseRevoked */ 'expiresAt'?: string; /** * * @type {string} * @memberof GlobalApiKeyStateResponseRevoked */ 'orgId'?: string; /** * * @type {string} * @memberof GlobalApiKeyStateResponseRevoked */ 'createdByEmail': string; /** * * @type {Array} * @memberof GlobalApiKeyStateResponseRevoked */ 'permissions': Array; /** * * @type {Array} * @memberof GlobalApiKeyStateResponseRevoked */ 'resources'?: Array; /** * When true, the key is authorized for all resources (unbound Cedar resource) * @type {boolean} * @memberof GlobalApiKeyStateResponseRevoked */ 'global': boolean; /** * * @type {string} * @memberof GlobalApiKeyStateResponseRevoked */ 'avpPolicyId': string; /** * * @type {string} * @memberof GlobalApiKeyStateResponseRevoked */ 'createdAt': string; /** * * @type {string} * @memberof GlobalApiKeyStateResponseRevoked */ 'updatedAt': string; /** * ISO-8601 timestamp of the most recent successful authentication with this key * @type {string} * @memberof GlobalApiKeyStateResponseRevoked */ 'lastUsedAt'?: string; } export declare const GlobalApiKeyStateResponseRevokedStatusEnum: { readonly Active: "active"; readonly Revoked: "revoked"; }; export type GlobalApiKeyStateResponseRevokedStatusEnum = typeof GlobalApiKeyStateResponseRevokedStatusEnum[keyof typeof GlobalApiKeyStateResponseRevokedStatusEnum]; /** * * @export * @interface GlobalApiKeyStateResponseUpdated */ export interface GlobalApiKeyStateResponseUpdated { /** * * @type {string} * @memberof GlobalApiKeyStateResponseUpdated */ 'principalId': string; /** * * @type {string} * @memberof GlobalApiKeyStateResponseUpdated */ 'name'?: string; /** * * @type {string} * @memberof GlobalApiKeyStateResponseUpdated */ 'status': GlobalApiKeyStateResponseUpdatedStatusEnum; /** * * @type {string} * @memberof GlobalApiKeyStateResponseUpdated */ 'expiresAt'?: string; /** * * @type {string} * @memberof GlobalApiKeyStateResponseUpdated */ 'orgId'?: string; /** * * @type {string} * @memberof GlobalApiKeyStateResponseUpdated */ 'createdByEmail': string; /** * * @type {Array} * @memberof GlobalApiKeyStateResponseUpdated */ 'permissions': Array; /** * * @type {Array} * @memberof GlobalApiKeyStateResponseUpdated */ 'resources'?: Array; /** * When true, the key is authorized for all resources (unbound Cedar resource) * @type {boolean} * @memberof GlobalApiKeyStateResponseUpdated */ 'global': boolean; /** * * @type {string} * @memberof GlobalApiKeyStateResponseUpdated */ 'avpPolicyId': string; /** * * @type {string} * @memberof GlobalApiKeyStateResponseUpdated */ 'createdAt': string; /** * * @type {string} * @memberof GlobalApiKeyStateResponseUpdated */ 'updatedAt': string; /** * ISO-8601 timestamp of the most recent successful authentication with this key * @type {string} * @memberof GlobalApiKeyStateResponseUpdated */ 'lastUsedAt'?: string; } export declare const GlobalApiKeyStateResponseUpdatedStatusEnum: { readonly Active: "active"; readonly Revoked: "revoked"; }; export type GlobalApiKeyStateResponseUpdatedStatusEnum = typeof GlobalApiKeyStateResponseUpdatedStatusEnum[keyof typeof GlobalApiKeyStateResponseUpdatedStatusEnum]; /** * * @export * @interface InviteTokenResponse */ export interface InviteTokenResponse { /** * * @type {string} * @memberof InviteTokenResponse */ 'tokenId': string; /** * * @type {string} * @memberof InviteTokenResponse */ 'joinUrl': string; /** * * @type {string} * @memberof InviteTokenResponse */ 'expiresAt': string; /** * * @type {string} * @memberof InviteTokenResponse */ 'orgId': string; /** * * @type {Array} * @memberof InviteTokenResponse */ 'brandIds': Array; /** * * @type {Array} * @memberof InviteTokenResponse */ 'propertyIds': Array; /** * * @type {Array} * @memberof InviteTokenResponse */ 'salesChannelIds': Array; /** * * @type {string} * @memberof InviteTokenResponse */ 'roleName': InviteTokenResponseRoleNameEnum; } export declare const InviteTokenResponseRoleNameEnum: { readonly Owner: "Owner"; readonly PropertyOwner: "PropertyOwner"; readonly ManagedOwner: "ManagedOwner"; readonly Integrator: "Integrator"; readonly PropertyManager: "PropertyManager"; readonly FinanceManager: "FinanceManager"; readonly StaffMember: "StaffMember"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type InviteTokenResponseRoleNameEnum = typeof InviteTokenResponseRoleNameEnum[keyof typeof InviteTokenResponseRoleNameEnum]; /** * * @export * @interface IsInRoleRequest */ export interface IsInRoleRequest { /** * * @type {AuthorizationRequestPrincipal} * @memberof IsInRoleRequest */ 'principal': AuthorizationRequestPrincipal; /** * Array of roles to check if the principal is in * @type {Array} * @memberof IsInRoleRequest */ 'roles': Array; /** * How to check authorisation - any or all of the actions must be allowed * @type {string} * @memberof IsInRoleRequest */ 'checkMode'?: IsInRoleRequestCheckModeEnum; } export declare const IsInRoleRequestCheckModeEnum: { readonly Any: "any"; readonly All: "all"; }; export type IsInRoleRequestCheckModeEnum = typeof IsInRoleRequestCheckModeEnum[keyof typeof IsInRoleRequestCheckModeEnum]; /** * Response containing whether the principal is in any/all of the roles * @export * @interface IsInRoleResponse */ export interface IsInRoleResponse { /** * result of the check - whether the principal is in any/all of the roles * @type {boolean} * @memberof IsInRoleResponse */ 'authorized': boolean; } /** * * @export * @interface JoinAccessErrorResponse */ export interface JoinAccessErrorResponse { /** * * @type {string} * @memberof JoinAccessErrorResponse */ 'code': JoinAccessErrorResponseCodeEnum; /** * * @type {string} * @memberof JoinAccessErrorResponse */ 'message': string; } export declare const JoinAccessErrorResponseCodeEnum: { readonly AlreadyMember: "ALREADY_MEMBER"; }; export type JoinAccessErrorResponseCodeEnum = typeof JoinAccessErrorResponseCodeEnum[keyof typeof JoinAccessErrorResponseCodeEnum]; /** * An org\'s expired timed access grants, most recent first * @export * @interface ListExpiredTimedAccessGrantsResponse */ export interface ListExpiredTimedAccessGrantsResponse { /** * * @type {Array} * @memberof ListExpiredTimedAccessGrantsResponse */ 'grants': Array; /** * Pass as the cursor query param to fetch the next page. Absent on the last page * @type {string} * @memberof ListExpiredTimedAccessGrantsResponse */ 'nextCursor'?: string; } /** * * @export * @interface ListGlobalApiKeysResponse */ export interface ListGlobalApiKeysResponse { /** * * @type {Array} * @memberof ListGlobalApiKeysResponse */ 'items': Array; } /** * * @export * @interface ListJoinRequestsResponse */ export interface ListJoinRequestsResponse { /** * * @type {Array} * @memberof ListJoinRequestsResponse */ 'items': Array; } /** * * @export * @interface ListOrgRolesSuccessResponseValue */ export interface ListOrgRolesSuccessResponseValue { /** * * @type {ListOrgRolesSuccessResponseValueOrgId} * @memberof ListOrgRolesSuccessResponseValue */ 'orgId': ListOrgRolesSuccessResponseValueOrgId; /** * List of roles that are assigned to the user in the org * @type {Array} * @memberof ListOrgRolesSuccessResponseValue */ 'roles': Array; /** * Optional permission set keys applied to the roles * @type {Array} * @memberof ListOrgRolesSuccessResponseValue */ 'optionalPermissionSetKeys'?: Array; /** * Property IDs, or * for all properties, the roles are scoped to * @type {Array} * @memberof ListOrgRolesSuccessResponseValue */ 'properties'?: Array; /** * Brand IDs, or * for all brands, the roles are scoped to * @type {Array} * @memberof ListOrgRolesSuccessResponseValue */ 'brands'?: Array; /** * Sales channel IDs, or * for all sales channels, the roles are scoped to * @type {Array} * @memberof ListOrgRolesSuccessResponseValue */ 'salesChannels'?: Array; } export declare const ListOrgRolesSuccessResponseValueRolesEnum: { readonly Owner: "Owner"; readonly PropertyOwner: "PropertyOwner"; readonly ManagedOwner: "ManagedOwner"; readonly Integrator: "Integrator"; readonly PropertyManager: "PropertyManager"; readonly FinanceManager: "FinanceManager"; readonly StaffMember: "StaffMember"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type ListOrgRolesSuccessResponseValueRolesEnum = typeof ListOrgRolesSuccessResponseValueRolesEnum[keyof typeof ListOrgRolesSuccessResponseValueRolesEnum]; /** * * @export * @interface ListOrgRolesSuccessResponseValueBrandsInner */ export interface ListOrgRolesSuccessResponseValueBrandsInner { } /** * ID of the org the roles are assigned in * @export * @interface ListOrgRolesSuccessResponseValueOrgId */ export interface ListOrgRolesSuccessResponseValueOrgId { } /** * * @export * @interface ListOrgRolesSuccessResponseValueSalesChannelsInner */ export interface ListOrgRolesSuccessResponseValueSalesChannelsInner { } /** * Successful permissions retrieval response * @export * @interface ListPermissionsSuccessResponse */ export interface ListPermissionsSuccessResponse { /** * * @type {Permissions & Array} * @memberof ListPermissionsSuccessResponse */ 'permissions': Permissions & Array; } /** * * @export * @interface ListPrincipalAccessBlocksResponse */ export interface ListPrincipalAccessBlocksResponse { /** * * @type {Array} * @memberof ListPrincipalAccessBlocksResponse */ 'items': Array; } /** * Successful role definitions retrieval response * @export * @interface ListRoleDefinitionsSuccessResponse */ export interface ListRoleDefinitionsSuccessResponse { /** * Roles and the permissions they grant at each hierarchy level * @type {Array} * @memberof ListRoleDefinitionsSuccessResponse */ 'roles': Array; } /** * * @export * @interface ListRoleDefinitionsSuccessResponseRolesInner */ export interface ListRoleDefinitionsSuccessResponseRolesInner { /** * Name of the role * @type {string} * @memberof ListRoleDefinitionsSuccessResponseRolesInner */ 'name': ListRoleDefinitionsSuccessResponseRolesInnerNameEnum; /** * * @type {RoleLevels} * @memberof ListRoleDefinitionsSuccessResponseRolesInner */ 'levels': RoleLevels; /** * Permission sets that can be granted on top of the role * @type {Array} * @memberof ListRoleDefinitionsSuccessResponseRolesInner */ 'optionalPermissionSets': Array; } export declare const ListRoleDefinitionsSuccessResponseRolesInnerNameEnum: { readonly Owner: "Owner"; readonly PropertyOwner: "PropertyOwner"; readonly ManagedOwner: "ManagedOwner"; readonly Integrator: "Integrator"; readonly PropertyManager: "PropertyManager"; readonly FinanceManager: "FinanceManager"; readonly StaffMember: "StaffMember"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type ListRoleDefinitionsSuccessResponseRolesInnerNameEnum = typeof ListRoleDefinitionsSuccessResponseRolesInnerNameEnum[keyof typeof ListRoleDefinitionsSuccessResponseRolesInnerNameEnum]; /** * * @export * @interface ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner */ export interface ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner { /** * Key used to add this permission set to a role assignment * @type {string} * @memberof ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner */ 'key': string; /** * Human readable name of the permission set * @type {string} * @memberof ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner */ 'name': string; /** * * @type {RoleLevels} * @memberof ListRoleDefinitionsSuccessResponseRolesInnerOptionalPermissionSetsInner */ 'levels': RoleLevels; } /** * Successful roles retrieval response * @export * @interface ListRolesSuccessResponse */ export interface ListRolesSuccessResponse { /** * List of named roles * @type {Array} * @memberof ListRolesSuccessResponse */ 'roles': Array; } /** * The caller\'s active timed access grants * @export * @interface ListTimedAccessGrantsResponse */ export interface ListTimedAccessGrantsResponse { /** * * @type {Array} * @memberof ListTimedAccessGrantsResponse */ 'grants': Array; } /** * The named role assignment * @export * @interface NamedRoleAssignmentResponse */ export interface NamedRoleAssignmentResponse { /** * * @type {string} * @memberof NamedRoleAssignmentResponse */ 'userId': string; /** * Best-effort; omitted if the principal has no known email on file * @type {string} * @memberof NamedRoleAssignmentResponse */ 'email'?: string; /** * * @type {RoleNames} * @memberof NamedRoleAssignmentResponse */ 'role': RoleNames; /** * * @type {string} * @memberof NamedRoleAssignmentResponse */ 'assignedAt': string; } /** * Permissions * @export * @enum {string} */ export declare const Permissions: { readonly AnyAuditLogs: "AnyAuditLogs"; readonly ViewApp: "ViewApp"; readonly CreateApp: "CreateApp"; readonly UpdateApp: "UpdateApp"; readonly ViewAppName: "ViewAppName"; readonly EditAppAssets: "EditAppAssets"; readonly EditAppFeatures: "EditAppFeatures"; readonly ViewTeammates: "ViewTeammates"; readonly EditTeammates: "EditTeammates"; readonly CreateTeammateOwner: "CreateTeammateOwner"; readonly CreateTeammateManagedOwner: "CreateTeammateManagedOwner"; readonly CreateTeammateStoreOwner: "CreateTeammateStoreOwner"; readonly CreateTeammateStoreManager: "CreateTeammateStoreManager"; readonly CreateTeammateStoreStaff: "CreateTeammateStoreStaff"; readonly CreateTeammateStoreReadAccess: "CreateTeammateStoreReadAccess"; readonly CreateTeammateFinanceManager: "CreateTeammateFinanceManager"; readonly CreateTeammateIntegrator: "CreateTeammateIntegrator"; readonly CreateTeammateOnboarding: "CreateTeammateOnboarding"; readonly CreateTeammatePropertyManager: "CreateTeammatePropertyManager"; readonly CreateTeammatePropertyOwner: "CreateTeammatePropertyOwner"; readonly CreateTeammateStaffMember: "CreateTeammateStaffMember"; readonly ViewApmConfigurations: "ViewApmConfigurations"; readonly EditApmConfigurations: "EditApmConfigurations"; readonly ViewCampaignsConfigurations: "ViewCampaignsConfigurations"; readonly CreateCampaignsConfigurations: "CreateCampaignsConfigurations"; readonly UpdateCampaignsConfigurations: "UpdateCampaignsConfigurations"; readonly DeleteCampaignsConfigurations: "DeleteCampaignsConfigurations"; readonly StampLoyaltyCardAgainstCampaignsConfigurations: "StampLoyaltyCardAgainstCampaignsConfigurations"; readonly ViewDevelopersSettings: "ViewDevelopersSettings"; readonly EditDevelopersSettings: "EditDevelopersSettings"; readonly ViewOrders: "ViewOrders"; readonly UpdateOrdersAccept: "UpdateOrdersAccept"; readonly UpdateOrdersReject: "UpdateOrdersReject"; readonly UpdateOrdersRefund: "UpdateOrdersRefund"; readonly UpdateOrdersDispatch: "UpdateOrdersDispatch"; readonly ViewStores: "ViewStores"; readonly CreateStores: "CreateStores"; readonly EditStores: "EditStores"; readonly ViewStoresOpeningHours: "ViewStoresOpeningHours"; readonly UpdateStoresOpenForCollectionOrDelivery: "UpdateStoresOpenForCollectionOrDelivery"; readonly UpdateStoresOpeningHours: "UpdateStoresOpeningHours"; readonly ViewStoresOpeningHoursOverride: "ViewStoresOpeningHoursOverride"; readonly EditStoresOpeningHoursOverride: "EditStoresOpeningHoursOverride"; readonly EditStoresOpeningHoursOverrideTemporary: "EditStoresOpeningHoursOverrideTemporary"; readonly UpdateStoresName: "UpdateStoresName"; readonly EditStoreKioskSettings: "EditStoreKioskSettings"; readonly EditStoreOrderCapacity: "EditStoreOrderCapacity"; readonly EditStoreNotifications: "EditStoreNotifications"; readonly ArchiveStores: "ArchiveStores"; readonly PublishStores: "PublishStores"; readonly UpdatePrinterTerminalsAssign: "UpdatePrinterTerminalsAssign"; readonly UpdatePrinterTerminalsToggle: "UpdatePrinterTerminalsToggle"; readonly ViewStoreGroups: "ViewStoreGroups"; readonly CreateStoreGroups: "CreateStoreGroups"; readonly UpdateStoreGroups: "UpdateStoreGroups"; readonly DeleteStoreGroups: "DeleteStoreGroups"; readonly ViewDeliveryZones: "ViewDeliveryZones"; readonly CreateDeliveryZones: "CreateDeliveryZones"; readonly UpdateDeliveryZones: "UpdateDeliveryZones"; readonly DeleteDeliveryZones: "DeleteDeliveryZones"; readonly ViewMenu: "ViewMenu"; readonly CreateGlobalApiKey: "CreateGlobalAPIKey"; readonly ListGlobalApiKeys: "ListGlobalAPIKeys"; readonly BlockPrincipalAccess: "BlockPrincipalAccess"; readonly CreateMenu: "CreateMenu"; readonly UpdateMenu: "UpdateMenu"; readonly DeleteMenu: "DeleteMenu"; readonly UpdateMenuLock: "UpdateMenuLock"; readonly UpdateMenuItemsHideTemporarily: "UpdateMenuItemsHideTemporarily"; readonly EditMenuImage: "EditMenuImage"; readonly ViewVouchers: "ViewVouchers"; readonly EditVouchers: "EditVouchers"; readonly ViewWebsiteContent: "ViewWebsiteContent"; readonly EditWebsiteContent: "EditWebsiteContent"; readonly ViewWebsiteDnsVerified: "ViewWebsiteDnsVerified"; readonly ViewWebsiteCertificateCreated: "ViewWebsiteCertificateCreated"; readonly ViewWebsiteCertificateRenewed: "ViewWebsiteCertificateRenewed"; readonly ViewBankAccounts: "ViewBankAccounts"; readonly CreateBankAccounts: "CreateBankAccounts"; readonly UpdateBankAccounts: "UpdateBankAccounts"; readonly UpdateBankAccountsAssign: "UpdateBankAccountsAssign"; readonly ViewAssignedBankAccount: "ViewAssignedBankAccount"; readonly VerifyBankAccounts: "VerifyBankAccounts"; readonly ViewServiceChargeConfigurations: "ViewServiceChargeConfigurations"; readonly EditServiceChargeConfigurations: "EditServiceChargeConfigurations"; readonly EditStoreDeliveryZoneFees: "EditStoreDeliveryZoneFees"; readonly EditStoreDeliveryFeesLimited: "EditStoreDeliveryFeesLimited"; readonly ViewHydraConfig: "ViewHydraConfig"; readonly UpdateHydraConfigManage: "UpdateHydraConfigManage"; readonly InitiateBluetoothPairingMode: "InitiateBluetoothPairingMode"; readonly DeleteTerminal: "DeleteTerminal"; readonly ViewKioskTelemetry: "ViewKioskTelemetry"; readonly HydraOnly: "HydraOnly"; readonly ViewCustomers: "ViewCustomers"; readonly EditCustomers: "EditCustomers"; readonly CreateCustomers: "CreateCustomers"; readonly CreateCatalogElements: "CreateCatalogElements"; readonly UpdateCatalogElements: "UpdateCatalogElements"; readonly ViewCatalogElements: "ViewCatalogElements"; readonly DeleteCatalogElements: "DeleteCatalogElements"; readonly ViewMetafieldDefinitions: "ViewMetafieldDefinitions"; readonly CreateMetafieldDefinitions: "CreateMetafieldDefinitions"; readonly UpdateMetafieldDefinitions: "UpdateMetafieldDefinitions"; readonly DeleteMetafieldDefinitions: "DeleteMetafieldDefinitions"; readonly UpdateMetafields: "UpdateMetafields"; readonly ViewCatalogMenuChanges: "ViewCatalogMenuChanges"; readonly PublishCatalogMenuChanges: "PublishCatalogMenuChanges"; readonly ViewAppStatistics: "ViewAppStatistics"; readonly ViewApmStatistics: "ViewApmStatistics"; readonly ViewCampaignsStatistics: "ViewCampaignsStatistics"; readonly ViewCustomerStatistics: "ViewCustomerStatistics"; readonly ViewLiveStatistics: "ViewLiveStatistics"; readonly ViewOrderStatistics: "ViewOrderStatistics"; readonly ViewSalesStatistics: "ViewSalesStatistics"; readonly ViewSalesEndOfDayStatistics: "ViewSalesEndOfDayStatistics"; readonly ViewVouchersStatistics: "ViewVouchersStatistics"; readonly DownloadCustomerCsvExport: "DownloadCustomerCsvExport"; readonly ViewApmAuditLogs: "ViewApmAuditLogs"; readonly ViewStoreAuditLogs: "ViewStoreAuditLogs"; readonly ViewMenuAuditLogs: "ViewMenuAuditLogs"; readonly ViewBankAccountAuditLogs: "ViewBankAccountAuditLogs"; readonly ViewFeeConfigurationsAuditLogs: "ViewFeeConfigurationsAuditLogs"; readonly ViewOrdersAuditLogs: "ViewOrdersAuditLogs"; readonly ViewVouchersAuditLogs: "ViewVouchersAuditLogs"; readonly ViewUserEventsAuditLogs: "ViewUserEventsAuditLogs"; readonly ViewCampaignsAuditLogs: "ViewCampaignsAuditLogs"; readonly ViewTeammatesAuditLogs: "ViewTeammatesAuditLogs"; readonly ViewTimedAccessAuditLogs: "ViewTimedAccessAuditLogs"; readonly ViewAppAuditLogs: "ViewAppAuditLogs"; readonly ViewCustomerAuditLogs: "ViewCustomerAuditLogs"; readonly ViewPrinterAuditLogs: "ViewPrinterAuditLogs"; readonly ViewHydraAuditLogs: "ViewHydraAuditLogs"; readonly ViewPushNotificationAuditLogs: "ViewPushNotificationAuditLogs"; readonly ViewStripeCustomConnectedAccountAuditLogs: "ViewStripeCustomConnectedAccountAuditLogs"; readonly ViewKioskBluetoothDeviceAuditLogs: "ViewKioskBluetoothDeviceAuditLogs"; readonly ViewExternalAuditLogs: "ViewExternalAuditLogs"; readonly CreateExternalAuditLogEvents: "CreateExternalAuditLogEvents"; readonly ViewCatalogAuditLogs: "ViewCatalogAuditLogs"; readonly ViewOrderFulfillmentAuditLogs: "ViewOrderFulfillmentAuditLogs"; readonly ViewChannelAuditLogs: "ViewChannelAuditLogs"; readonly ViewAppStoreAuditLogs: "ViewAppStoreAuditLogs"; readonly SendPushNotificationToCustomer: "SendPushNotificationToCustomer"; readonly InviteDriverToApp: "InviteDriverToApp"; readonly GetDriverForApp: "GetDriverForApp"; readonly RemoveDriverFromApp: "RemoveDriverFromApp"; readonly AssignDriverToOrder: "AssignDriverToOrder"; readonly UnassignDriverFromOrder: "UnassignDriverFromOrder"; readonly UpdateOrdersDeliveryTrackingStatus: "UpdateOrdersDeliveryTrackingStatus"; readonly UpdateOrderFulfillmentStatus: "UpdateOrderFulfillmentStatus"; readonly ViewFulfillmentStatesConfiguration: "ViewFulfillmentStatesConfiguration"; readonly CreateFulfillmentStatesConfiguration: "CreateFulfillmentStatesConfiguration"; readonly UpdateFulfillmentStatesConfiguration: "UpdateFulfillmentStatesConfiguration"; readonly DeleteFulfillmentStatesConfiguration: "DeleteFulfillmentStatesConfiguration"; readonly ViewPayouts: "ViewPayouts"; readonly ViewChannels: "ViewChannels"; readonly ViewOnboarding: "ViewOnboarding"; readonly UpdateOnboarding: "UpdateOnboarding"; readonly ViewClientDevices: "ViewClientDevices"; readonly UpdateClientDevices: "UpdateClientDevices"; readonly EnrollClientDevices: "EnrollClientDevices"; readonly AssignClientDevices: "AssignClientDevices"; readonly ViewClientAuditLogs: "ViewClientAuditLogs"; readonly CreateAppStoreAppConfiguration: "CreateAppStoreAppConfiguration"; readonly ViewAppStoreAppConfiguration: "ViewAppStoreAppConfiguration"; readonly UpdateAppStoreAppConfiguration: "UpdateAppStoreAppConfiguration"; readonly DeleteAppStoreAppConfiguration: "DeleteAppStoreAppConfiguration"; readonly UpdateAppStoreAppConfigurationSettings: "UpdateAppStoreAppConfigurationSettings"; readonly CreateAppStoreSubscription: "CreateAppStoreSubscription"; readonly UpdateAppStoreSubscription: "UpdateAppStoreSubscription"; readonly DeleteAppStoreSubscription: "DeleteAppStoreSubscription"; readonly ViewSalesChannels: "ViewSalesChannels"; readonly EditSalesChannels: "EditSalesChannels"; readonly CreateSalesChannel: "CreateSalesChannel"; readonly ArchiveSalesChannel: "ArchiveSalesChannel"; readonly UnarchiveSalesChannel: "UnarchiveSalesChannel"; readonly PublishSalesChannel: "PublishSalesChannel"; readonly UnpublishSalesChannel: "UnpublishSalesChannel"; readonly CloneSalesChannel: "CloneSalesChannel"; readonly ViewPayGreenWhiteLabelConfiguration: "ViewPayGreenWhiteLabelConfiguration"; readonly CreatePayGreenWhiteLabelConfiguration: "CreatePayGreenWhiteLabelConfiguration"; readonly UpdatePayGreenWhiteLabelConfiguration: "UpdatePayGreenWhiteLabelConfiguration"; readonly UpdatePayGreenStoreConfiguration: "UpdatePayGreenStoreConfiguration"; readonly ViewSubscriptions: "ViewSubscriptions"; readonly ViewInvoices: "ViewInvoices"; readonly EditAccountsBills: "EditAccountsBills"; readonly ViewAccountsBills: "ViewAccountsBills"; readonly EditAccountsCategories: "EditAccountsCategories"; readonly ViewAccountsCategories: "ViewAccountsCategories"; readonly EditAccountsCreditAccounts: "EditAccountsCreditAccounts"; readonly ViewAccountsCreditAccounts: "ViewAccountsCreditAccounts"; readonly EditAccountsCreditBooks: "EditAccountsCreditBooks"; readonly ViewAccountsCreditBooks: "ViewAccountsCreditBooks"; readonly EditAccountsExpenses: "EditAccountsExpenses"; readonly ViewAccountsExpenses: "ViewAccountsExpenses"; readonly EditAccountsTransactionAccounts: "EditAccountsTransactionAccounts"; readonly ViewAccountsTransactionAccounts: "ViewAccountsTransactionAccounts"; readonly EditDocumentExplorer: "EditDocumentExplorer"; readonly ViewDocumentExplorer: "ViewDocumentExplorer"; readonly ViewInventoryReports: "ViewInventoryReports"; readonly EditInventoryPurchaseOrders: "EditInventoryPurchaseOrders"; readonly ViewInventoryPurchaseOrders: "ViewInventoryPurchaseOrders"; readonly EditInventoryStockItems: "EditInventoryStockItems"; readonly ViewInventoryStockItems: "ViewInventoryStockItems"; readonly EditInventorySupplier: "EditInventorySupplier"; readonly ViewInventorySupplier: "ViewInventorySupplier"; readonly EditInventoryTrackingProfiles: "EditInventoryTrackingProfiles"; readonly ViewInventoryTrackingProfiles: "ViewInventoryTrackingProfiles"; readonly ViewPayrollReports: "ViewPayrollReports"; readonly EditPayrollHoliday: "EditPayrollHoliday"; readonly ViewPayrollHoliday: "ViewPayrollHoliday"; readonly EditPayrollRota: "EditPayrollRota"; readonly ViewPayrollRota: "ViewPayrollRota"; readonly EditPayrollStaff: "EditPayrollStaff"; readonly ViewPayrollStaff: "ViewPayrollStaff"; readonly ViewSalesReports: "ViewSalesReports"; readonly ViewCostReports: "ViewCostReports"; readonly ViewMenuReports: "ViewMenuReports"; readonly ViewBrand: "ViewBrand"; readonly EditBrand: "EditBrand"; readonly CreateBrand: "CreateBrand"; readonly TransferBrand: "TransferBrand"; readonly ViewProperty: "ViewProperty"; readonly EditProperty: "EditProperty"; readonly CreateProperty: "CreateProperty"; readonly ArchiveProperty: "ArchiveProperty"; readonly ViewEntityFeatureFlags: "ViewEntityFeatureFlags"; readonly EditEntityFeatureFlags: "EditEntityFeatureFlags"; readonly CreateOrg: "CreateOrg"; readonly CreateOrgApiKey: "CreateOrgAPIKey"; readonly EditOrg: "EditOrg"; readonly ViewOrg: "ViewOrg"; readonly ViewWebhooks: "ViewWebhooks"; readonly EditWebhooks: "EditWebhooks"; readonly ViewOwnPermissions: "ViewOwnPermissions"; readonly CreatePosSale: "CreatePosSale"; readonly ComplimentPosItems: "ComplimentPosItems"; readonly ApplyPosDiscounts: "ApplyPosDiscounts"; readonly CancelPosSales: "CancelPosSales"; readonly DeliverSale: "DeliverSale"; readonly PerformCashingUp: "PerformCashingUp"; readonly OpenCashDrawer: "OpenCashDrawer"; readonly EditPosSettings: "EditPosSettings"; readonly EditPosLayout: "EditPosLayout"; readonly ViewPosDailySummaryReport: "ViewPosDailySummaryReport"; readonly ViewPosDriverSalesReport: "ViewPosDriverSalesReport"; readonly CreatePurchaseOrder: "CreatePurchaseOrder"; readonly SubmitPurchaseOrder: "SubmitPurchaseOrder"; readonly ReceivePurchaseOrder: "ReceivePurchaseOrder"; readonly ViewBusinessInsights: "ViewBusinessInsights"; readonly SnoozePosMenu: "SnoozePosMenu"; readonly SnoozePosMenuIndefinitely: "SnoozePosMenuIndefinitely"; readonly SnoozePosItem: "SnoozePosItem"; readonly SnoozePosItemIndefinitely: "SnoozePosItemIndefinitely"; readonly SnoozePosProperty: "SnoozePosProperty"; readonly RoleAdmin: "RoleAdmin"; readonly RoleFactory: "RoleFactory"; readonly RoleAuthDeveloper: "RoleAuthDeveloper"; readonly RoleFlipdishStaff: "RoleFlipdishStaff"; }; export type Permissions = typeof Permissions[keyof typeof Permissions]; /** * Principal in an org, optionally including last active timestamp * @export * @interface PrincipalInOrg */ export interface PrincipalInOrg { /** * * @type {string} * @memberof PrincipalInOrg */ 'type': PrincipalInOrgTypeEnum; /** * * @type {string} * @memberof PrincipalInOrg */ 'id': string; /** * * @type {string} * @memberof PrincipalInOrg */ 'name'?: string; /** * * @type {string} * @memberof PrincipalInOrg */ 'email'?: string; /** * * @type {string} * @memberof PrincipalInOrg */ 'phone'?: string; /** * ISO-8601 UTC timestamp of last authorization activity in this org * @type {string} * @memberof PrincipalInOrg */ 'lastActiveAt'?: string; } export declare const PrincipalInOrgTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type PrincipalInOrgTypeEnum = typeof PrincipalInOrgTypeEnum[keyof typeof PrincipalInOrgTypeEnum]; /** * Principals in org * @export * @interface PrincipalsInOrgResponse */ export interface PrincipalsInOrgResponse { /** * * @type {string} * @memberof PrincipalsInOrgResponse */ 'orgId': string; /** * List of principals in org * @type {Array} * @memberof PrincipalsInOrgResponse */ 'principals': Array; } /** * Role assignment key to rematerialize * @export * @interface RematerializeRoleAssignmentRequestBody */ export interface RematerializeRoleAssignmentRequestBody { /** * * @type {string} * @memberof RematerializeRoleAssignmentRequestBody */ 'pk': string; /** * * @type {string} * @memberof RematerializeRoleAssignmentRequestBody */ 'sk': string; } /** * Successful role assignment rematerialization response (reconcile: add missing + revoke leftovers) * @export * @interface RematerializeRoleAssignmentSuccessResponse */ export interface RematerializeRoleAssignmentSuccessResponse { /** * * @type {RematerializeRoleAssignmentSuccessResponseRoleAssignment} * @memberof RematerializeRoleAssignmentSuccessResponse */ 'roleAssignment': RematerializeRoleAssignmentSuccessResponseRoleAssignment; /** * * @type {number} * @memberof RematerializeRoleAssignmentSuccessResponse */ 'added': number; /** * * @type {number} * @memberof RematerializeRoleAssignmentSuccessResponse */ 'revoked': number; /** * * @type {number} * @memberof RematerializeRoleAssignmentSuccessResponse */ 'unchanged': number; } /** * * @export * @interface RematerializeRoleAssignmentSuccessResponseRoleAssignment */ export interface RematerializeRoleAssignmentSuccessResponseRoleAssignment { /** * * @type {string} * @memberof RematerializeRoleAssignmentSuccessResponseRoleAssignment */ 'pk': string; /** * * @type {string} * @memberof RematerializeRoleAssignmentSuccessResponseRoleAssignment */ 'sk': string; /** * * @type {string} * @memberof RematerializeRoleAssignmentSuccessResponseRoleAssignment */ 'assignmentId': string; } /** * * @export * @interface RemoveNamedRoleRequestBody */ export interface RemoveNamedRoleRequestBody { /** * The user losing the role * @type {string} * @memberof RemoveNamedRoleRequestBody */ 'userId': string; /** * * @type {RoleNames} * @memberof RemoveNamedRoleRequestBody */ 'roleName': RoleNames; } /** * * @export * @interface RemoveTeammateRequestBody */ export interface RemoveTeammateRequestBody { /** * * @type {RemoveTeammateRequestBodyPrincipal} * @memberof RemoveTeammateRequestBody */ 'principal': RemoveTeammateRequestBodyPrincipal; /** * * @type {RemoveTeammateRequestBodyActor} * @memberof RemoveTeammateRequestBody */ 'actor'?: RemoveTeammateRequestBodyActor; } /** * Actor performing the removal * @export * @interface RemoveTeammateRequestBodyActor */ export interface RemoveTeammateRequestBodyActor { /** * * @type {string} * @memberof RemoveTeammateRequestBodyActor */ 'type': RemoveTeammateRequestBodyActorTypeEnum; /** * * @type {string} * @memberof RemoveTeammateRequestBodyActor */ 'id': string; /** * * @type {string} * @memberof RemoveTeammateRequestBodyActor */ 'name'?: string; /** * * @type {string} * @memberof RemoveTeammateRequestBodyActor */ 'email'?: string; /** * * @type {string} * @memberof RemoveTeammateRequestBodyActor */ 'phone'?: string; } export declare const RemoveTeammateRequestBodyActorTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type RemoveTeammateRequestBodyActorTypeEnum = typeof RemoveTeammateRequestBodyActorTypeEnum[keyof typeof RemoveTeammateRequestBodyActorTypeEnum]; /** * Principal to remove from the org * @export * @interface RemoveTeammateRequestBodyPrincipal */ export interface RemoveTeammateRequestBodyPrincipal { /** * * @type {string} * @memberof RemoveTeammateRequestBodyPrincipal */ 'type': RemoveTeammateRequestBodyPrincipalTypeEnum; /** * * @type {string} * @memberof RemoveTeammateRequestBodyPrincipal */ 'id': string; /** * * @type {string} * @memberof RemoveTeammateRequestBodyPrincipal */ 'name'?: string; /** * * @type {string} * @memberof RemoveTeammateRequestBodyPrincipal */ 'email'?: string; /** * * @type {string} * @memberof RemoveTeammateRequestBodyPrincipal */ 'phone'?: string; } export declare const RemoveTeammateRequestBodyPrincipalTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type RemoveTeammateRequestBodyPrincipalTypeEnum = typeof RemoveTeammateRequestBodyPrincipalTypeEnum[keyof typeof RemoveTeammateRequestBodyPrincipalTypeEnum]; /** * Teammate removed from org * @export * @interface RemoveTeammateSuccessResponse */ export interface RemoveTeammateSuccessResponse { /** * * @type {string} * @memberof RemoveTeammateSuccessResponse */ 'message': string; } /** * * @export * @interface RoleAssignmentRequestBody */ export interface RoleAssignmentRequestBody { /** * * @type {RoleAssignmentRequestBodyPrincipal} * @memberof RoleAssignmentRequestBody */ 'principal': RoleAssignmentRequestBodyPrincipal; /** * Role name * @type {string} * @memberof RoleAssignmentRequestBody */ 'roleName': RoleAssignmentRequestBodyRoleNameEnum; /** * Property resource ids (e.g. p123) when scoped to properties * @type {Array} * @memberof RoleAssignmentRequestBody */ 'properties'?: Array; /** * Brand resource ids (e.g. b123) when scoped to brands * @type {Array} * @memberof RoleAssignmentRequestBody */ 'brands'?: Array; /** * Sales channel resource ids (e.g. sc123) when scoped to sales channels * @type {Array} * @memberof RoleAssignmentRequestBody */ 'salesChannels'?: Array; /** * Optional permission set keys to apply to this role assignment * @type {Array} * @memberof RoleAssignmentRequestBody */ 'optionalPermissionSetKeys'?: Array; /** * * @type {RoleAssignmentRequestBodyActor} * @memberof RoleAssignmentRequestBody */ 'actor'?: RoleAssignmentRequestBodyActor; } export declare const RoleAssignmentRequestBodyRoleNameEnum: { readonly Owner: "Owner"; readonly PropertyOwner: "PropertyOwner"; readonly ManagedOwner: "ManagedOwner"; readonly Integrator: "Integrator"; readonly PropertyManager: "PropertyManager"; readonly FinanceManager: "FinanceManager"; readonly StaffMember: "StaffMember"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type RoleAssignmentRequestBodyRoleNameEnum = typeof RoleAssignmentRequestBodyRoleNameEnum[keyof typeof RoleAssignmentRequestBodyRoleNameEnum]; /** * Actor making the assignment * @export * @interface RoleAssignmentRequestBodyActor */ export interface RoleAssignmentRequestBodyActor { /** * * @type {string} * @memberof RoleAssignmentRequestBodyActor */ 'type': RoleAssignmentRequestBodyActorTypeEnum; /** * * @type {string} * @memberof RoleAssignmentRequestBodyActor */ 'id': string; /** * * @type {string} * @memberof RoleAssignmentRequestBodyActor */ 'name'?: string; /** * * @type {string} * @memberof RoleAssignmentRequestBodyActor */ 'email'?: string; /** * * @type {string} * @memberof RoleAssignmentRequestBodyActor */ 'phone'?: string; } export declare const RoleAssignmentRequestBodyActorTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type RoleAssignmentRequestBodyActorTypeEnum = typeof RoleAssignmentRequestBodyActorTypeEnum[keyof typeof RoleAssignmentRequestBodyActorTypeEnum]; /** * Principal to assign the role to * @export * @interface RoleAssignmentRequestBodyPrincipal */ export interface RoleAssignmentRequestBodyPrincipal { /** * * @type {string} * @memberof RoleAssignmentRequestBodyPrincipal */ 'type': RoleAssignmentRequestBodyPrincipalTypeEnum; /** * * @type {string} * @memberof RoleAssignmentRequestBodyPrincipal */ 'id': string; /** * * @type {string} * @memberof RoleAssignmentRequestBodyPrincipal */ 'name'?: string; /** * * @type {string} * @memberof RoleAssignmentRequestBodyPrincipal */ 'email'?: string; /** * * @type {string} * @memberof RoleAssignmentRequestBodyPrincipal */ 'phone'?: string; } export declare const RoleAssignmentRequestBodyPrincipalTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type RoleAssignmentRequestBodyPrincipalTypeEnum = typeof RoleAssignmentRequestBodyPrincipalTypeEnum[keyof typeof RoleAssignmentRequestBodyPrincipalTypeEnum]; /** * Role assignment applied * @export * @interface RoleAssignmentSuccessResponse */ export interface RoleAssignmentSuccessResponse { /** * * @type {string} * @memberof RoleAssignmentSuccessResponse */ 'message': string; } /** * Permissions granted at a single hierarchy level * @export * @interface RoleLevelDefinition */ export interface RoleLevelDefinition { /** * input grants the permissions on the resources named in the assignment, all grants them on every resource of that level in the org * @type {string} * @memberof RoleLevelDefinition */ 'scope': RoleLevelDefinitionScopeEnum; /** * Permissions granted at this hierarchy level * @type {Array} * @memberof RoleLevelDefinition */ 'permissions': Array; } export declare const RoleLevelDefinitionScopeEnum: { readonly Input: "input"; readonly All: "all"; }; export type RoleLevelDefinitionScopeEnum = typeof RoleLevelDefinitionScopeEnum[keyof typeof RoleLevelDefinitionScopeEnum]; /** * Permissions granted, keyed by hierarchy level * @export * @interface RoleLevels */ export interface RoleLevels { /** * * @type {RoleLevelDefinition} * @memberof RoleLevels */ 'org'?: RoleLevelDefinition; /** * * @type {RoleLevelDefinition} * @memberof RoleLevels */ 'brand'?: RoleLevelDefinition; /** * * @type {RoleLevelDefinition} * @memberof RoleLevels */ 'property'?: RoleLevelDefinition; /** * * @type {RoleLevelDefinition} * @memberof RoleLevels */ 'salesChannel'?: RoleLevelDefinition; /** * * @type {RoleLevelDefinition} * @memberof RoleLevels */ 'global'?: RoleLevelDefinition; /** * * @type {RoleLevelDefinition} * @memberof RoleLevels */ 'self'?: RoleLevelDefinition; } /** * Role names * @export * @enum {string} */ export declare const RoleNames: { readonly Admin: "Admin"; readonly Factory: "Factory"; readonly AuthDeveloper: "AuthDeveloper"; readonly FlipdishStaff: "FlipdishStaff"; }; export type RoleNames = typeof RoleNames[keyof typeof RoleNames]; /** * A temporary timed access grant * @export * @interface TimedAccessGrant */ export interface TimedAccessGrant { /** * * @type {string} * @memberof TimedAccessGrant */ 'grantId': string; /** * * @type {string} * @memberof TimedAccessGrant */ 'principalType': TimedAccessGrantPrincipalTypeEnum; /** * * @type {string} * @memberof TimedAccessGrant */ 'principalId': string; /** * * @type {string} * @memberof TimedAccessGrant */ 'email': string; /** * * @type {string} * @memberof TimedAccessGrant */ 'orgId': string; /** * * @type {string} * @memberof TimedAccessGrant */ 'roleName': string; /** * * @type {Array} * @memberof TimedAccessGrant */ 'propertyIds': Array; /** * * @type {Array} * @memberof TimedAccessGrant */ 'brandIds': Array; /** * * @type {Array} * @memberof TimedAccessGrant */ 'salesChannelIds': Array; /** * * @type {string} * @memberof TimedAccessGrant */ 'startsAt': string; /** * * @type {string} * @memberof TimedAccessGrant */ 'expiresAt': string; /** * * @type {string} * @memberof TimedAccessGrant */ 'status': TimedAccessGrantStatusEnum; } export declare const TimedAccessGrantPrincipalTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type TimedAccessGrantPrincipalTypeEnum = typeof TimedAccessGrantPrincipalTypeEnum[keyof typeof TimedAccessGrantPrincipalTypeEnum]; export declare const TimedAccessGrantStatusEnum: { readonly Active: "active"; readonly Expired: "expired"; }; export type TimedAccessGrantStatusEnum = typeof TimedAccessGrantStatusEnum[keyof typeof TimedAccessGrantStatusEnum]; /** * * @export * @interface TimedAccessGrantRequestBody */ export interface TimedAccessGrantRequestBody { /** * Must match the authenticated caller * @type {string} * @memberof TimedAccessGrantRequestBody */ 'userId': string; /** * The org to grant temporary access to * @type {string} * @memberof TimedAccessGrantRequestBody */ 'orgId': string; /** * Role the pass grants * @type {string} * @memberof TimedAccessGrantRequestBody */ 'roleName': TimedAccessGrantRequestBodyRoleNameEnum; /** * Optional property scope * @type {Array} * @memberof TimedAccessGrantRequestBody */ 'propertyIds'?: Array; /** * Optional brand scope * @type {Array} * @memberof TimedAccessGrantRequestBody */ 'brandIds'?: Array; /** * Optional sales channel scope * @type {Array} * @memberof TimedAccessGrantRequestBody */ 'salesChannelIds'?: Array; } export declare const TimedAccessGrantRequestBodyRoleNameEnum: { readonly Owner: "Owner"; }; export type TimedAccessGrantRequestBodyRoleNameEnum = typeof TimedAccessGrantRequestBodyRoleNameEnum[keyof typeof TimedAccessGrantRequestBodyRoleNameEnum]; /** * The timed access grant that was created or refreshed * @export * @interface TimedAccessGrantResponse */ export interface TimedAccessGrantResponse { /** * * @type {string} * @memberof TimedAccessGrantResponse */ 'grantId': string; /** * * @type {string} * @memberof TimedAccessGrantResponse */ 'principalType': TimedAccessGrantResponsePrincipalTypeEnum; /** * * @type {string} * @memberof TimedAccessGrantResponse */ 'principalId': string; /** * * @type {string} * @memberof TimedAccessGrantResponse */ 'email': string; /** * * @type {string} * @memberof TimedAccessGrantResponse */ 'orgId': string; /** * * @type {string} * @memberof TimedAccessGrantResponse */ 'roleName': string; /** * * @type {Array} * @memberof TimedAccessGrantResponse */ 'propertyIds': Array; /** * * @type {Array} * @memberof TimedAccessGrantResponse */ 'brandIds': Array; /** * * @type {Array} * @memberof TimedAccessGrantResponse */ 'salesChannelIds': Array; /** * * @type {string} * @memberof TimedAccessGrantResponse */ 'startsAt': string; /** * * @type {string} * @memberof TimedAccessGrantResponse */ 'expiresAt': string; /** * * @type {string} * @memberof TimedAccessGrantResponse */ 'status': TimedAccessGrantResponseStatusEnum; } export declare const TimedAccessGrantResponsePrincipalTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type TimedAccessGrantResponsePrincipalTypeEnum = typeof TimedAccessGrantResponsePrincipalTypeEnum[keyof typeof TimedAccessGrantResponsePrincipalTypeEnum]; export declare const TimedAccessGrantResponseStatusEnum: { readonly Active: "active"; readonly Expired: "expired"; }; export type TimedAccessGrantResponseStatusEnum = typeof TimedAccessGrantResponseStatusEnum[keyof typeof TimedAccessGrantResponseStatusEnum]; /** * * @export * @interface UnblockPrincipalAccessRequest */ export interface UnblockPrincipalAccessRequest { /** * * @type {AccessBlockStateResponseBlockedPrincipal} * @memberof UnblockPrincipalAccessRequest */ 'principal': AccessBlockStateResponseBlockedPrincipal; } /** * * @export * @interface UnblockPrincipalAccessResponse */ export interface UnblockPrincipalAccessResponse { /** * * @type {AccessBlockStateResponseBlockedPrincipal} * @memberof UnblockPrincipalAccessResponse */ 'principal': AccessBlockStateResponseBlockedPrincipal; /** * * @type {string} * @memberof UnblockPrincipalAccessResponse */ 'status': UnblockPrincipalAccessResponseStatusEnum; } export declare const UnblockPrincipalAccessResponseStatusEnum: { readonly RestorationInProgress: "restoration_in_progress"; readonly NotBlocked: "not_blocked"; }; export type UnblockPrincipalAccessResponseStatusEnum = typeof UnblockPrincipalAccessResponseStatusEnum[keyof typeof UnblockPrincipalAccessResponseStatusEnum]; /** * * @export * @interface UpdateGlobalApiKeyRequest */ export interface UpdateGlobalApiKeyRequest { /** * * @type {string} * @memberof UpdateGlobalApiKeyRequest */ 'name'?: string; /** * * @type {Array} * @memberof UpdateGlobalApiKeyRequest */ 'permissions'?: Array; /** * * @type {AuthorizationRequestResource} * @memberof UpdateGlobalApiKeyRequest */ 'resource'?: AuthorizationRequestResource; /** * * @type {boolean} * @memberof UpdateGlobalApiKeyRequest */ 'global'?: boolean; /** * * @type {string} * @memberof UpdateGlobalApiKeyRequest */ 'expiresAt'?: string; } /** * APIKeysApi - axios parameter creator * @export */ export declare const APIKeysApiAxiosParamCreator: (configuration?: Configuration) => { /** * Authenticates the presented Automation API key (x-api-key or Authorization: ApiKey ) and returns status only: 200 when the key is active and not expired, 401 otherwise. Not authenticated by cookie/JWT sessions. * @summary Authenticate API key * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateApiKey: (options?: RawAxiosRequestConfig) => Promise; /** * Create an Automation API key (optional org association). Requires CreateGlobalAPIKey. Raw secret is returned once. * @summary Create global API key * @param {CreateGlobalApiKeyRequest} [createGlobalApiKeyRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGlobalApiKey: (createGlobalApiKeyRequest?: CreateGlobalApiKeyRequest, options?: RawAxiosRequestConfig) => Promise; /** * Self-introspection for the authenticated Automation API key (x-api-key). Returns non-secret fields only. * @summary Get current API key state * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGlobalApiKeyMe: (options?: RawAxiosRequestConfig) => Promise; /** * List Automation API keys (non-secret fields). Optional status filter (active|revoked). Requires ListGlobalAPIKeys. * @summary List global API keys * @param {ListGlobalApiKeysStatusEnum} [status] When set, only return keys with this status * @param {*} [options] Override http request option. * @throws {RequiredError} */ listGlobalApiKeys: (status?: ListGlobalApiKeysStatusEnum, options?: RawAxiosRequestConfig) => Promise; /** * Delete the STATIC AVP policy and mark the API key revoked. * @summary Revoke global API key * @param {string} apiKeyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeGlobalApiKey: (apiKeyId: string, options?: RawAxiosRequestConfig) => Promise; /** * Update permissions, resources, and/or expiry for any Automation API key. Rotates the STATIC AVP policy. * @summary Update global API key * @param {string} apiKeyId * @param {UpdateGlobalApiKeyRequest} [updateGlobalApiKeyRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGlobalApiKey: (apiKeyId: string, updateGlobalApiKeyRequest?: UpdateGlobalApiKeyRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * APIKeysApi - functional programming interface * @export */ export declare const APIKeysApiFp: (configuration?: Configuration) => { /** * Authenticates the presented Automation API key (x-api-key or Authorization: ApiKey ) and returns status only: 200 when the key is active and not expired, 401 otherwise. Not authenticated by cookie/JWT sessions. * @summary Authenticate API key * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateApiKey(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create an Automation API key (optional org association). Requires CreateGlobalAPIKey. Raw secret is returned once. * @summary Create global API key * @param {CreateGlobalApiKeyRequest} [createGlobalApiKeyRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGlobalApiKey(createGlobalApiKeyRequest?: CreateGlobalApiKeyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Self-introspection for the authenticated Automation API key (x-api-key). Returns non-secret fields only. * @summary Get current API key state * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGlobalApiKeyMe(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List Automation API keys (non-secret fields). Optional status filter (active|revoked). Requires ListGlobalAPIKeys. * @summary List global API keys * @param {ListGlobalApiKeysStatusEnum} [status] When set, only return keys with this status * @param {*} [options] Override http request option. * @throws {RequiredError} */ listGlobalApiKeys(status?: ListGlobalApiKeysStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete the STATIC AVP policy and mark the API key revoked. * @summary Revoke global API key * @param {string} apiKeyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeGlobalApiKey(apiKeyId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update permissions, resources, and/or expiry for any Automation API key. Rotates the STATIC AVP policy. * @summary Update global API key * @param {string} apiKeyId * @param {UpdateGlobalApiKeyRequest} [updateGlobalApiKeyRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGlobalApiKey(apiKeyId: string, updateGlobalApiKeyRequest?: UpdateGlobalApiKeyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * APIKeysApi - factory interface * @export */ export declare const APIKeysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Authenticates the presented Automation API key (x-api-key or Authorization: ApiKey ) and returns status only: 200 when the key is active and not expired, 401 otherwise. Not authenticated by cookie/JWT sessions. * @summary Authenticate API key * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateApiKey(options?: RawAxiosRequestConfig): AxiosPromise; /** * Create an Automation API key (optional org association). Requires CreateGlobalAPIKey. Raw secret is returned once. * @summary Create global API key * @param {CreateGlobalApiKeyRequest} [createGlobalApiKeyRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGlobalApiKey(createGlobalApiKeyRequest?: CreateGlobalApiKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Self-introspection for the authenticated Automation API key (x-api-key). Returns non-secret fields only. * @summary Get current API key state * @param {*} [options] Override http request option. * @throws {RequiredError} */ getGlobalApiKeyMe(options?: RawAxiosRequestConfig): AxiosPromise; /** * List Automation API keys (non-secret fields). Optional status filter (active|revoked). Requires ListGlobalAPIKeys. * @summary List global API keys * @param {ListGlobalApiKeysStatusEnum} [status] When set, only return keys with this status * @param {*} [options] Override http request option. * @throws {RequiredError} */ listGlobalApiKeys(status?: ListGlobalApiKeysStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete the STATIC AVP policy and mark the API key revoked. * @summary Revoke global API key * @param {string} apiKeyId * @param {*} [options] Override http request option. * @throws {RequiredError} */ revokeGlobalApiKey(apiKeyId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update permissions, resources, and/or expiry for any Automation API key. Rotates the STATIC AVP policy. * @summary Update global API key * @param {string} apiKeyId * @param {UpdateGlobalApiKeyRequest} [updateGlobalApiKeyRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGlobalApiKey(apiKeyId: string, updateGlobalApiKeyRequest?: UpdateGlobalApiKeyRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * APIKeysApi - object-oriented interface * @export * @class APIKeysApi * @extends {BaseAPI} */ export declare class APIKeysApi extends BaseAPI { /** * Authenticates the presented Automation API key (x-api-key or Authorization: ApiKey ) and returns status only: 200 when the key is active and not expired, 401 otherwise. Not authenticated by cookie/JWT sessions. * @summary Authenticate API key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof APIKeysApi */ authenticateApiKey(options?: RawAxiosRequestConfig): Promise>; /** * Create an Automation API key (optional org association). Requires CreateGlobalAPIKey. Raw secret is returned once. * @summary Create global API key * @param {CreateGlobalApiKeyRequest} [createGlobalApiKeyRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof APIKeysApi */ createGlobalApiKey(createGlobalApiKeyRequest?: CreateGlobalApiKeyRequest, options?: RawAxiosRequestConfig): Promise>; /** * Self-introspection for the authenticated Automation API key (x-api-key). Returns non-secret fields only. * @summary Get current API key state * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof APIKeysApi */ getGlobalApiKeyMe(options?: RawAxiosRequestConfig): Promise>; /** * List Automation API keys (non-secret fields). Optional status filter (active|revoked). Requires ListGlobalAPIKeys. * @summary List global API keys * @param {ListGlobalApiKeysStatusEnum} [status] When set, only return keys with this status * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof APIKeysApi */ listGlobalApiKeys(status?: ListGlobalApiKeysStatusEnum, options?: RawAxiosRequestConfig): Promise>; /** * Delete the STATIC AVP policy and mark the API key revoked. * @summary Revoke global API key * @param {string} apiKeyId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof APIKeysApi */ revokeGlobalApiKey(apiKeyId: string, options?: RawAxiosRequestConfig): Promise>; /** * Update permissions, resources, and/or expiry for any Automation API key. Rotates the STATIC AVP policy. * @summary Update global API key * @param {string} apiKeyId * @param {UpdateGlobalApiKeyRequest} [updateGlobalApiKeyRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof APIKeysApi */ updateGlobalApiKey(apiKeyId: string, updateGlobalApiKeyRequest?: UpdateGlobalApiKeyRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const ListGlobalApiKeysStatusEnum: { readonly Active: "active"; readonly Revoked: "revoked"; }; export type ListGlobalApiKeysStatusEnum = typeof ListGlobalApiKeysStatusEnum[keyof typeof ListGlobalApiKeysStatusEnum]; /** * AuthenticationApi - axios parameter creator * @export */ export declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => { /** * Authenticate and authorize a user to perform an action * @summary Authenticate and authorize Request * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateAndAuthorize: (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * AuthenticationApi - functional programming interface * @export */ export declare const AuthenticationApiFp: (configuration?: Configuration) => { /** * Authenticate and authorize a user to perform an action * @summary Authenticate and authorize Request * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AuthenticationApi - factory interface * @export */ export declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Authenticate and authorize a user to perform an action * @summary Authenticate and authorize Request * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AuthenticationApi - object-oriented interface * @export * @class AuthenticationApi * @extends {BaseAPI} */ export declare class AuthenticationApi extends BaseAPI { /** * Authenticate and authorize a user to perform an action * @summary Authenticate and authorize Request * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthenticationApi */ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise>; } /** * AuthorizationApi - axios parameter creator * @export */ export declare const AuthorizationApiAxiosParamCreator: (configuration?: Configuration) => { /** * Authenticate and authorize a user to perform an action * @summary Authenticate and authorize Request * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateAndAuthorize: (authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig) => Promise; /** * Authenticate and check if a user is in any/all of the roles * @summary Authenticate and Check Is In Role * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateAndCheckIsInRole: (authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig) => Promise; /** * Check if a user is authorized to perform an action * @summary Authorize Request * @param {AuthorizationRequest} [authorizationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authorize: (authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Check if a user is authorized to perform an action on multiple resources * @summary Authorize Batch Request * @param {AuthorizationBatchRequest} [authorizationBatchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authorizeBatch: (authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig) => Promise; /** * Check whether each principal/resource/action tuple is authorized * @summary Authorize Batch Checks Request * @param {AuthorizationChecksBatchRequest} [authorizationChecksBatchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authorizeBatchChecks: (authorizationChecksBatchRequest?: AuthorizationChecksBatchRequest, options?: RawAxiosRequestConfig) => Promise; /** * Check if a user is in any/all of the roles * @summary Check Is In Role * @param {IsInRoleRequest} [isInRoleRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkIsInRole: (isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * AuthorizationApi - functional programming interface * @export */ export declare const AuthorizationApiFp: (configuration?: Configuration) => { /** * Authenticate and authorize a user to perform an action * @summary Authenticate and authorize Request * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Authenticate and check if a user is in any/all of the roles * @summary Authenticate and Check Is In Role * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Check if a user is authorized to perform an action * @summary Authorize Request * @param {AuthorizationRequest} [authorizationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Check if a user is authorized to perform an action on multiple resources * @summary Authorize Batch Request * @param {AuthorizationBatchRequest} [authorizationBatchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Check whether each principal/resource/action tuple is authorized * @summary Authorize Batch Checks Request * @param {AuthorizationChecksBatchRequest} [authorizationChecksBatchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authorizeBatchChecks(authorizationChecksBatchRequest?: AuthorizationChecksBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Check if a user is in any/all of the roles * @summary Check Is In Role * @param {IsInRoleRequest} [isInRoleRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AuthorizationApi - factory interface * @export */ export declare const AuthorizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Authenticate and authorize a user to perform an action * @summary Authenticate and authorize Request * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Authenticate and check if a user is in any/all of the roles * @summary Authenticate and Check Is In Role * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Check if a user is authorized to perform an action * @summary Authorize Request * @param {AuthorizationRequest} [authorizationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Check if a user is authorized to perform an action on multiple resources * @summary Authorize Batch Request * @param {AuthorizationBatchRequest} [authorizationBatchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Check whether each principal/resource/action tuple is authorized * @summary Authorize Batch Checks Request * @param {AuthorizationChecksBatchRequest} [authorizationChecksBatchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authorizeBatchChecks(authorizationChecksBatchRequest?: AuthorizationChecksBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Check if a user is in any/all of the roles * @summary Check Is In Role * @param {IsInRoleRequest} [isInRoleRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AuthorizationApi - object-oriented interface * @export * @class AuthorizationApi * @extends {BaseAPI} */ export declare class AuthorizationApi extends BaseAPI { /** * Authenticate and authorize a user to perform an action * @summary Authenticate and authorize Request * @param {AuthenticateAndAuthorizeRequest} authenticateAndAuthorizeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthorizationApi */ authenticateAndAuthorize(authenticateAndAuthorizeRequest: AuthenticateAndAuthorizeRequest, options?: RawAxiosRequestConfig): Promise>; /** * Authenticate and check if a user is in any/all of the roles * @summary Authenticate and Check Is In Role * @param {AuthenticateAndCheckIsInRoleRequest} [authenticateAndCheckIsInRoleRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthorizationApi */ authenticateAndCheckIsInRole(authenticateAndCheckIsInRoleRequest?: AuthenticateAndCheckIsInRoleRequest, options?: RawAxiosRequestConfig): Promise>; /** * Check if a user is authorized to perform an action * @summary Authorize Request * @param {AuthorizationRequest} [authorizationRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthorizationApi */ authorize(authorizationRequest?: AuthorizationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Check if a user is authorized to perform an action on multiple resources * @summary Authorize Batch Request * @param {AuthorizationBatchRequest} [authorizationBatchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthorizationApi */ authorizeBatch(authorizationBatchRequest?: AuthorizationBatchRequest, options?: RawAxiosRequestConfig): Promise>; /** * Check whether each principal/resource/action tuple is authorized * @summary Authorize Batch Checks Request * @param {AuthorizationChecksBatchRequest} [authorizationChecksBatchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthorizationApi */ authorizeBatchChecks(authorizationChecksBatchRequest?: AuthorizationChecksBatchRequest, options?: RawAxiosRequestConfig): Promise>; /** * Check if a user is in any/all of the roles * @summary Check Is In Role * @param {IsInRoleRequest} [isInRoleRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthorizationApi */ checkIsInRole(isInRoleRequest?: IsInRoleRequest, options?: RawAxiosRequestConfig): Promise>; } /** * AuthorizedEntitiesApi - axios parameter creator * @export */ export declare const AuthorizedEntitiesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Get the authorized brands for a given org * @summary Get Authorized Brands * @param {string} orgId * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorizedBrands: (orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig) => Promise; /** * Get the authorized orgs for a given principal * @summary Get Authorized Orgs * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorizedOrgs: (getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig) => Promise; /** * Get the authorized properties for a given org * @summary Get Authorized Properties * @param {string} orgId * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorizedProperties: (orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * AuthorizedEntitiesApi - functional programming interface * @export */ export declare const AuthorizedEntitiesApiFp: (configuration?: Configuration) => { /** * Get the authorized brands for a given org * @summary Get Authorized Brands * @param {string} orgId * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the authorized orgs for a given principal * @summary Get Authorized Orgs * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the authorized properties for a given org * @summary Get Authorized Properties * @param {string} orgId * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AuthorizedEntitiesApi - factory interface * @export */ export declare const AuthorizedEntitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Get the authorized brands for a given org * @summary Get Authorized Brands * @param {string} orgId * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get the authorized orgs for a given principal * @summary Get Authorized Orgs * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get the authorized properties for a given org * @summary Get Authorized Properties * @param {string} orgId * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AuthorizedEntitiesApi - object-oriented interface * @export * @class AuthorizedEntitiesApi * @extends {BaseAPI} */ export declare class AuthorizedEntitiesApi extends BaseAPI { /** * Get the authorized brands for a given org * @summary Get Authorized Brands * @param {string} orgId * @param {GetAuthorizedBrandsRequest} [getAuthorizedBrandsRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthorizedEntitiesApi */ getAuthorizedBrands(orgId: string, getAuthorizedBrandsRequest?: GetAuthorizedBrandsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get the authorized orgs for a given principal * @summary Get Authorized Orgs * @param {GetAuthorizedOrgsRequest} [getAuthorizedOrgsRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthorizedEntitiesApi */ getAuthorizedOrgs(getAuthorizedOrgsRequest?: GetAuthorizedOrgsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get the authorized properties for a given org * @summary Get Authorized Properties * @param {string} orgId * @param {GetAuthorizedPropertiesRequest} [getAuthorizedPropertiesRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuthorizedEntitiesApi */ getAuthorizedProperties(orgId: string, getAuthorizedPropertiesRequest?: GetAuthorizedPropertiesRequest, options?: RawAxiosRequestConfig): Promise>; } /** * ConfigurationDataApi - axios parameter creator * @export */ export declare const ConfigurationDataApiAxiosParamCreator: (configuration?: Configuration) => { /** * List the available permissions * @summary List Permissions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissions: (options?: RawAxiosRequestConfig) => Promise; /** * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets * @summary List Role Definitions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listRoleDefinitions: (options?: RawAxiosRequestConfig) => Promise; /** * List the available roles * @summary List Roles * @param {*} [options] Override http request option. * @throws {RequiredError} */ listRoles: (options?: RawAxiosRequestConfig) => Promise; }; /** * ConfigurationDataApi - functional programming interface * @export */ export declare const ConfigurationDataApiFp: (configuration?: Configuration) => { /** * List the available permissions * @summary List Permissions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets * @summary List Role Definitions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listRoleDefinitions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List the available roles * @summary List Roles * @param {*} [options] Override http request option. * @throws {RequiredError} */ listRoles(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ConfigurationDataApi - factory interface * @export */ export declare const ConfigurationDataApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * List the available permissions * @summary List Permissions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPermissions(options?: RawAxiosRequestConfig): AxiosPromise; /** * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets * @summary List Role Definitions * @param {*} [options] Override http request option. * @throws {RequiredError} */ listRoleDefinitions(options?: RawAxiosRequestConfig): AxiosPromise; /** * List the available roles * @summary List Roles * @param {*} [options] Override http request option. * @throws {RequiredError} */ listRoles(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * ConfigurationDataApi - object-oriented interface * @export * @class ConfigurationDataApi * @extends {BaseAPI} */ export declare class ConfigurationDataApi extends BaseAPI { /** * List the available permissions * @summary List Permissions * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigurationDataApi */ listPermissions(options?: RawAxiosRequestConfig): Promise>; /** * List the teammate roles with the permissions they grant at each hierarchy level, including optional permission sets * @summary List Role Definitions * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigurationDataApi */ listRoleDefinitions(options?: RawAxiosRequestConfig): Promise>; /** * List the available roles * @summary List Roles * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ConfigurationDataApi */ listRoles(options?: RawAxiosRequestConfig): Promise>; } /** * JoinAccessApi - axios parameter creator * @export */ export declare const JoinAccessApiAxiosParamCreator: (configuration?: Configuration) => { /** * Grants access via AuthZ V2 role assignment (source join). Optional body fields override the role and property scope stored on the pending request; omitted fields use the request defaults from the invite token. * @summary Accept a pending join access request * @param {string} orgId * @param {string} requestId * @param {AcceptJoinRequest} [acceptJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ acceptJoinAccessRequest: (orgId: string, requestId: string, acceptJoinRequest?: AcceptJoinRequest, options?: RawAxiosRequestConfig) => Promise; /** * Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one. * @summary Create an invite token * @param {string} orgId * @param {CreateInviteTokenRequest} [createInviteTokenRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInviteToken: (orgId: string, createInviteTokenRequest?: CreateInviteTokenRequest, options?: RawAxiosRequestConfig) => Promise; /** * Validates the opaque invite token and creates (or returns) a pending AccessRequest for the property/role encoded on the token. * @summary Submit a join access request from an invite token * @param {string} orgId * @param {CreateJoinRequest} [createJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createJoinAccessRequest: (orgId: string, createJoinRequest?: CreateJoinRequest, options?: RawAxiosRequestConfig) => Promise; /** * Returns request status for the authenticated requester only. Owners should use the list endpoint. * @summary Get a join access request by id * @param {string} orgId * @param {string} requestId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getJoinAccessRequest: (orgId: string, requestId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns pending AccessRequests for an org. Optional propertyId/brandId filters. Requires ViewTeammates on orgId. * @summary List pending join requests for an organization * @param {string} orgId * @param {string} [propertyId] * @param {string} [brandId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listJoinAccessRequests: (orgId: string, propertyId?: string, brandId?: string, options?: RawAxiosRequestConfig) => Promise; /** * Rejects a pending AccessRequest without granting access. * @summary Reject a pending join access request * @param {string} orgId * @param {string} requestId * @param {*} [options] Override http request option. * @throws {RequiredError} */ rejectJoinAccessRequest: (orgId: string, requestId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * JoinAccessApi - functional programming interface * @export */ export declare const JoinAccessApiFp: (configuration?: Configuration) => { /** * Grants access via AuthZ V2 role assignment (source join). Optional body fields override the role and property scope stored on the pending request; omitted fields use the request defaults from the invite token. * @summary Accept a pending join access request * @param {string} orgId * @param {string} requestId * @param {AcceptJoinRequest} [acceptJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ acceptJoinAccessRequest(orgId: string, requestId: string, acceptJoinRequest?: AcceptJoinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one. * @summary Create an invite token * @param {string} orgId * @param {CreateInviteTokenRequest} [createInviteTokenRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInviteToken(orgId: string, createInviteTokenRequest?: CreateInviteTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Validates the opaque invite token and creates (or returns) a pending AccessRequest for the property/role encoded on the token. * @summary Submit a join access request from an invite token * @param {string} orgId * @param {CreateJoinRequest} [createJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createJoinAccessRequest(orgId: string, createJoinRequest?: CreateJoinRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns request status for the authenticated requester only. Owners should use the list endpoint. * @summary Get a join access request by id * @param {string} orgId * @param {string} requestId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns pending AccessRequests for an org. Optional propertyId/brandId filters. Requires ViewTeammates on orgId. * @summary List pending join requests for an organization * @param {string} orgId * @param {string} [propertyId] * @param {string} [brandId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listJoinAccessRequests(orgId: string, propertyId?: string, brandId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Rejects a pending AccessRequest without granting access. * @summary Reject a pending join access request * @param {string} orgId * @param {string} requestId * @param {*} [options] Override http request option. * @throws {RequiredError} */ rejectJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * JoinAccessApi - factory interface * @export */ export declare const JoinAccessApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Grants access via AuthZ V2 role assignment (source join). Optional body fields override the role and property scope stored on the pending request; omitted fields use the request defaults from the invite token. * @summary Accept a pending join access request * @param {string} orgId * @param {string} requestId * @param {AcceptJoinRequest} [acceptJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ acceptJoinAccessRequest(orgId: string, requestId: string, acceptJoinRequest?: AcceptJoinRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one. * @summary Create an invite token * @param {string} orgId * @param {CreateInviteTokenRequest} [createInviteTokenRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createInviteToken(orgId: string, createInviteTokenRequest?: CreateInviteTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Validates the opaque invite token and creates (or returns) a pending AccessRequest for the property/role encoded on the token. * @summary Submit a join access request from an invite token * @param {string} orgId * @param {CreateJoinRequest} [createJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createJoinAccessRequest(orgId: string, createJoinRequest?: CreateJoinRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns request status for the authenticated requester only. Owners should use the list endpoint. * @summary Get a join access request by id * @param {string} orgId * @param {string} requestId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns pending AccessRequests for an org. Optional propertyId/brandId filters. Requires ViewTeammates on orgId. * @summary List pending join requests for an organization * @param {string} orgId * @param {string} [propertyId] * @param {string} [brandId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listJoinAccessRequests(orgId: string, propertyId?: string, brandId?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Rejects a pending AccessRequest without granting access. * @summary Reject a pending join access request * @param {string} orgId * @param {string} requestId * @param {*} [options] Override http request option. * @throws {RequiredError} */ rejectJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * JoinAccessApi - object-oriented interface * @export * @class JoinAccessApi * @extends {BaseAPI} */ export declare class JoinAccessApi extends BaseAPI { /** * Grants access via AuthZ V2 role assignment (source join). Optional body fields override the role and property scope stored on the pending request; omitted fields use the request defaults from the invite token. * @summary Accept a pending join access request * @param {string} orgId * @param {string} requestId * @param {AcceptJoinRequest} [acceptJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof JoinAccessApi */ acceptJoinAccessRequest(orgId: string, requestId: string, acceptJoinRequest?: AcceptJoinRequest, options?: RawAxiosRequestConfig): Promise>; /** * Mints an opaque invite token after validating the RMS terminal passport. Call again when a previous token expires to get a new one. * @summary Create an invite token * @param {string} orgId * @param {CreateInviteTokenRequest} [createInviteTokenRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof JoinAccessApi */ createInviteToken(orgId: string, createInviteTokenRequest?: CreateInviteTokenRequest, options?: RawAxiosRequestConfig): Promise>; /** * Validates the opaque invite token and creates (or returns) a pending AccessRequest for the property/role encoded on the token. * @summary Submit a join access request from an invite token * @param {string} orgId * @param {CreateJoinRequest} [createJoinRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof JoinAccessApi */ createJoinAccessRequest(orgId: string, createJoinRequest?: CreateJoinRequest, options?: RawAxiosRequestConfig): Promise>; /** * Returns request status for the authenticated requester only. Owners should use the list endpoint. * @summary Get a join access request by id * @param {string} orgId * @param {string} requestId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof JoinAccessApi */ getJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns pending AccessRequests for an org. Optional propertyId/brandId filters. Requires ViewTeammates on orgId. * @summary List pending join requests for an organization * @param {string} orgId * @param {string} [propertyId] * @param {string} [brandId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof JoinAccessApi */ listJoinAccessRequests(orgId: string, propertyId?: string, brandId?: string, options?: RawAxiosRequestConfig): Promise>; /** * Rejects a pending AccessRequest without granting access. * @summary Reject a pending join access request * @param {string} orgId * @param {string} requestId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof JoinAccessApi */ rejectJoinAccessRequest(orgId: string, requestId: string, options?: RawAxiosRequestConfig): Promise>; } /** * NamedRolesApi - axios parameter creator * @export */ export declare const NamedRolesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Grants a user the named role given in the body. The caller must themselves hold a named role, and may only assign roles at or below their own privilege level (see NamedRolePrivilegeLevel in auth-config); AuthDeveloper can never be assigned here, it\'s IaC-only. Idempotent: assigning twice returns the same result. Mirrors /orgs/{orgId}/roleAssignments/apply. * @summary Assign a named role * @param {ApplyNamedRoleRequestBody} [applyNamedRoleRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ applyNamedRole: (applyNamedRoleRequestBody?: ApplyNamedRoleRequestBody, options?: RawAxiosRequestConfig) => Promise; /** * Removes the named role given in the body so the user can no longer act as it. Does not end passes already held; those run to their own expiry. Subject to the same privilege-level gate and AuthDeveloper block as assignment. Mirrors /orgs/{orgId}/roleAssignments/remove. * @summary Remove a named role * @param {RemoveNamedRoleRequestBody} [removeNamedRoleRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeNamedRole: (removeNamedRoleRequestBody?: RemoveNamedRoleRequestBody, options?: RawAxiosRequestConfig) => Promise; }; /** * NamedRolesApi - functional programming interface * @export */ export declare const NamedRolesApiFp: (configuration?: Configuration) => { /** * Grants a user the named role given in the body. The caller must themselves hold a named role, and may only assign roles at or below their own privilege level (see NamedRolePrivilegeLevel in auth-config); AuthDeveloper can never be assigned here, it\'s IaC-only. Idempotent: assigning twice returns the same result. Mirrors /orgs/{orgId}/roleAssignments/apply. * @summary Assign a named role * @param {ApplyNamedRoleRequestBody} [applyNamedRoleRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ applyNamedRole(applyNamedRoleRequestBody?: ApplyNamedRoleRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Removes the named role given in the body so the user can no longer act as it. Does not end passes already held; those run to their own expiry. Subject to the same privilege-level gate and AuthDeveloper block as assignment. Mirrors /orgs/{orgId}/roleAssignments/remove. * @summary Remove a named role * @param {RemoveNamedRoleRequestBody} [removeNamedRoleRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeNamedRole(removeNamedRoleRequestBody?: RemoveNamedRoleRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * NamedRolesApi - factory interface * @export */ export declare const NamedRolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Grants a user the named role given in the body. The caller must themselves hold a named role, and may only assign roles at or below their own privilege level (see NamedRolePrivilegeLevel in auth-config); AuthDeveloper can never be assigned here, it\'s IaC-only. Idempotent: assigning twice returns the same result. Mirrors /orgs/{orgId}/roleAssignments/apply. * @summary Assign a named role * @param {ApplyNamedRoleRequestBody} [applyNamedRoleRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ applyNamedRole(applyNamedRoleRequestBody?: ApplyNamedRoleRequestBody, options?: RawAxiosRequestConfig): AxiosPromise; /** * Removes the named role given in the body so the user can no longer act as it. Does not end passes already held; those run to their own expiry. Subject to the same privilege-level gate and AuthDeveloper block as assignment. Mirrors /orgs/{orgId}/roleAssignments/remove. * @summary Remove a named role * @param {RemoveNamedRoleRequestBody} [removeNamedRoleRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeNamedRole(removeNamedRoleRequestBody?: RemoveNamedRoleRequestBody, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * NamedRolesApi - object-oriented interface * @export * @class NamedRolesApi * @extends {BaseAPI} */ export declare class NamedRolesApi extends BaseAPI { /** * Grants a user the named role given in the body. The caller must themselves hold a named role, and may only assign roles at or below their own privilege level (see NamedRolePrivilegeLevel in auth-config); AuthDeveloper can never be assigned here, it\'s IaC-only. Idempotent: assigning twice returns the same result. Mirrors /orgs/{orgId}/roleAssignments/apply. * @summary Assign a named role * @param {ApplyNamedRoleRequestBody} [applyNamedRoleRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NamedRolesApi */ applyNamedRole(applyNamedRoleRequestBody?: ApplyNamedRoleRequestBody, options?: RawAxiosRequestConfig): Promise>; /** * Removes the named role given in the body so the user can no longer act as it. Does not end passes already held; those run to their own expiry. Subject to the same privilege-level gate and AuthDeveloper block as assignment. Mirrors /orgs/{orgId}/roleAssignments/remove. * @summary Remove a named role * @param {RemoveNamedRoleRequestBody} [removeNamedRoleRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NamedRolesApi */ removeNamedRole(removeNamedRoleRequestBody?: RemoveNamedRoleRequestBody, options?: RawAxiosRequestConfig): Promise>; } /** * PrincipalAccessBlockApi - axios parameter creator * @export */ export declare const PrincipalAccessBlockApiAxiosParamCreator: (configuration?: Configuration) => { /** * Write an access_block flag and a temporary AVP forbid so authorization checks DENY. Decision-cache bust is delayed like other grant changes. Grant drain/restore runs asynchronously. Authentication still succeeds. Requires BlockPrincipalAccess. * @summary Block principal access * @param {BlockPrincipalAccessRequest} [blockPrincipalAccessRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ blockPrincipalAccess: (blockPrincipalAccessRequest?: BlockPrincipalAccessRequest, options?: RawAxiosRequestConfig) => Promise; /** * Get the current access block for a principal. Requires BlockPrincipalAccess. * @summary Get principal access block * @param {GetPrincipalAccessBlockTypeEnum} type * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPrincipalAccessBlock: (type: GetPrincipalAccessBlockTypeEnum, id: string, options?: RawAxiosRequestConfig) => Promise; /** * List currently blocked principals. Optional type filter. Requires BlockPrincipalAccess. * @summary List principal access blocks * @param {ListPrincipalAccessBlocksTypeEnum} [type] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPrincipalAccessBlocks: (type?: ListPrincipalAccessBlocksTypeEnum, options?: RawAxiosRequestConfig) => Promise; /** * Start restoring existing role assignments. The access_block flag is removed asynchronously after restoration completes, and authorization remains denied until then. Requires BlockPrincipalAccess. * @summary Unblock principal access * @param {UnblockPrincipalAccessRequest} [unblockPrincipalAccessRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unblockPrincipalAccess: (unblockPrincipalAccessRequest?: UnblockPrincipalAccessRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * PrincipalAccessBlockApi - functional programming interface * @export */ export declare const PrincipalAccessBlockApiFp: (configuration?: Configuration) => { /** * Write an access_block flag and a temporary AVP forbid so authorization checks DENY. Decision-cache bust is delayed like other grant changes. Grant drain/restore runs asynchronously. Authentication still succeeds. Requires BlockPrincipalAccess. * @summary Block principal access * @param {BlockPrincipalAccessRequest} [blockPrincipalAccessRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ blockPrincipalAccess(blockPrincipalAccessRequest?: BlockPrincipalAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the current access block for a principal. Requires BlockPrincipalAccess. * @summary Get principal access block * @param {GetPrincipalAccessBlockTypeEnum} type * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPrincipalAccessBlock(type: GetPrincipalAccessBlockTypeEnum, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List currently blocked principals. Optional type filter. Requires BlockPrincipalAccess. * @summary List principal access blocks * @param {ListPrincipalAccessBlocksTypeEnum} [type] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPrincipalAccessBlocks(type?: ListPrincipalAccessBlocksTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Start restoring existing role assignments. The access_block flag is removed asynchronously after restoration completes, and authorization remains denied until then. Requires BlockPrincipalAccess. * @summary Unblock principal access * @param {UnblockPrincipalAccessRequest} [unblockPrincipalAccessRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unblockPrincipalAccess(unblockPrincipalAccessRequest?: UnblockPrincipalAccessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * PrincipalAccessBlockApi - factory interface * @export */ export declare const PrincipalAccessBlockApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Write an access_block flag and a temporary AVP forbid so authorization checks DENY. Decision-cache bust is delayed like other grant changes. Grant drain/restore runs asynchronously. Authentication still succeeds. Requires BlockPrincipalAccess. * @summary Block principal access * @param {BlockPrincipalAccessRequest} [blockPrincipalAccessRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ blockPrincipalAccess(blockPrincipalAccessRequest?: BlockPrincipalAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get the current access block for a principal. Requires BlockPrincipalAccess. * @summary Get principal access block * @param {GetPrincipalAccessBlockTypeEnum} type * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPrincipalAccessBlock(type: GetPrincipalAccessBlockTypeEnum, id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * List currently blocked principals. Optional type filter. Requires BlockPrincipalAccess. * @summary List principal access blocks * @param {ListPrincipalAccessBlocksTypeEnum} [type] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPrincipalAccessBlocks(type?: ListPrincipalAccessBlocksTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise; /** * Start restoring existing role assignments. The access_block flag is removed asynchronously after restoration completes, and authorization remains denied until then. Requires BlockPrincipalAccess. * @summary Unblock principal access * @param {UnblockPrincipalAccessRequest} [unblockPrincipalAccessRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ unblockPrincipalAccess(unblockPrincipalAccessRequest?: UnblockPrincipalAccessRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * PrincipalAccessBlockApi - object-oriented interface * @export * @class PrincipalAccessBlockApi * @extends {BaseAPI} */ export declare class PrincipalAccessBlockApi extends BaseAPI { /** * Write an access_block flag and a temporary AVP forbid so authorization checks DENY. Decision-cache bust is delayed like other grant changes. Grant drain/restore runs asynchronously. Authentication still succeeds. Requires BlockPrincipalAccess. * @summary Block principal access * @param {BlockPrincipalAccessRequest} [blockPrincipalAccessRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PrincipalAccessBlockApi */ blockPrincipalAccess(blockPrincipalAccessRequest?: BlockPrincipalAccessRequest, options?: RawAxiosRequestConfig): Promise>; /** * Get the current access block for a principal. Requires BlockPrincipalAccess. * @summary Get principal access block * @param {GetPrincipalAccessBlockTypeEnum} type * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PrincipalAccessBlockApi */ getPrincipalAccessBlock(type: GetPrincipalAccessBlockTypeEnum, id: string, options?: RawAxiosRequestConfig): Promise>; /** * List currently blocked principals. Optional type filter. Requires BlockPrincipalAccess. * @summary List principal access blocks * @param {ListPrincipalAccessBlocksTypeEnum} [type] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PrincipalAccessBlockApi */ listPrincipalAccessBlocks(type?: ListPrincipalAccessBlocksTypeEnum, options?: RawAxiosRequestConfig): Promise>; /** * Start restoring existing role assignments. The access_block flag is removed asynchronously after restoration completes, and authorization remains denied until then. Requires BlockPrincipalAccess. * @summary Unblock principal access * @param {UnblockPrincipalAccessRequest} [unblockPrincipalAccessRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof PrincipalAccessBlockApi */ unblockPrincipalAccess(unblockPrincipalAccessRequest?: UnblockPrincipalAccessRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetPrincipalAccessBlockTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type GetPrincipalAccessBlockTypeEnum = typeof GetPrincipalAccessBlockTypeEnum[keyof typeof GetPrincipalAccessBlockTypeEnum]; /** * @export */ export declare const ListPrincipalAccessBlocksTypeEnum: { readonly User: "User"; readonly Automation: "Automation"; readonly Kiosk: "Kiosk"; readonly Terminal: "Terminal"; }; export type ListPrincipalAccessBlocksTypeEnum = typeof ListPrincipalAccessBlocksTypeEnum[keyof typeof ListPrincipalAccessBlocksTypeEnum]; /** * RoleAssignmentApi - axios parameter creator * @export */ export declare const RoleAssignmentApiAxiosParamCreator: (configuration?: Configuration) => { /** * Apply a role assignment for the target user without invoking legacy teammate/Zeus role assignment flows. * @summary Apply role assignment * @param {string} orgId * @param {RoleAssignmentRequestBody} [roleAssignmentRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ applyRoleAssignment: (orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig) => Promise; /** * Reconciles policy assignments for the role assignment principal: creates missing policies and revokes leftovers that materialize no longer emits * @summary Rematerialize Role Assignment * @param {string} orgId * @param {RematerializeRoleAssignmentRequestBody} [rematerializeRoleAssignmentRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rematerializeRoleAssignmentV2: (orgId: string, rematerializeRoleAssignmentRequestBody?: RematerializeRoleAssignmentRequestBody, options?: RawAxiosRequestConfig) => Promise; /** * 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. * @summary Remove teammate * @param {string} orgId * @param {RemoveTeammateRequestBody} [removeTeammateRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeTeammate: (orgId: string, removeTeammateRequestBody?: RemoveTeammateRequestBody, options?: RawAxiosRequestConfig) => Promise; }; /** * RoleAssignmentApi - functional programming interface * @export */ export declare const RoleAssignmentApiFp: (configuration?: Configuration) => { /** * Apply a role assignment for the target user without invoking legacy teammate/Zeus role assignment flows. * @summary Apply role assignment * @param {string} orgId * @param {RoleAssignmentRequestBody} [roleAssignmentRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Reconciles policy assignments for the role assignment principal: creates missing policies and revokes leftovers that materialize no longer emits * @summary Rematerialize Role Assignment * @param {string} orgId * @param {RematerializeRoleAssignmentRequestBody} [rematerializeRoleAssignmentRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rematerializeRoleAssignmentV2(orgId: string, rematerializeRoleAssignmentRequestBody?: RematerializeRoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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. * @summary Remove teammate * @param {string} orgId * @param {RemoveTeammateRequestBody} [removeTeammateRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeTeammate(orgId: string, removeTeammateRequestBody?: RemoveTeammateRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * RoleAssignmentApi - factory interface * @export */ export declare const RoleAssignmentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Apply a role assignment for the target user without invoking legacy teammate/Zeus role assignment flows. * @summary Apply role assignment * @param {string} orgId * @param {RoleAssignmentRequestBody} [roleAssignmentRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): AxiosPromise; /** * Reconciles policy assignments for the role assignment principal: creates missing policies and revokes leftovers that materialize no longer emits * @summary Rematerialize Role Assignment * @param {string} orgId * @param {RematerializeRoleAssignmentRequestBody} [rematerializeRoleAssignmentRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rematerializeRoleAssignmentV2(orgId: string, rematerializeRoleAssignmentRequestBody?: RematerializeRoleAssignmentRequestBody, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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. * @summary Remove teammate * @param {string} orgId * @param {RemoveTeammateRequestBody} [removeTeammateRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeTeammate(orgId: string, removeTeammateRequestBody?: RemoveTeammateRequestBody, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * RoleAssignmentApi - object-oriented interface * @export * @class RoleAssignmentApi * @extends {BaseAPI} */ export declare class RoleAssignmentApi extends BaseAPI { /** * Apply a role assignment for the target user without invoking legacy teammate/Zeus role assignment flows. * @summary Apply role assignment * @param {string} orgId * @param {RoleAssignmentRequestBody} [roleAssignmentRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RoleAssignmentApi */ applyRoleAssignment(orgId: string, roleAssignmentRequestBody?: RoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise>; /** * Reconciles policy assignments for the role assignment principal: creates missing policies and revokes leftovers that materialize no longer emits * @summary Rematerialize Role Assignment * @param {string} orgId * @param {RematerializeRoleAssignmentRequestBody} [rematerializeRoleAssignmentRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RoleAssignmentApi */ rematerializeRoleAssignmentV2(orgId: string, rematerializeRoleAssignmentRequestBody?: RematerializeRoleAssignmentRequestBody, options?: RawAxiosRequestConfig): Promise>; /** * 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. * @summary Remove teammate * @param {string} orgId * @param {RemoveTeammateRequestBody} [removeTeammateRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof RoleAssignmentApi */ removeTeammate(orgId: string, removeTeammateRequestBody?: RemoveTeammateRequestBody, options?: RawAxiosRequestConfig): Promise>; } /** * TimedAccessApi - axios parameter creator * @export */ export declare const TimedAccessApiAxiosParamCreator: (configuration?: Configuration) => { /** * Grants the authenticated caller temporary Owner access to a single org. Requesting again while a pass is active extends it rather than creating a second one. * @summary Create a timed access pass * @param {string} orgId * @param {TimedAccessGrantRequestBody} [timedAccessGrantRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTimedAccessGrant: (orgId: string, timedAccessGrantRequestBody?: TimedAccessGrantRequestBody, options?: RawAxiosRequestConfig) => Promise; /** * Returns the org’s expired timed access passes, most recent first. Intended for client-facing visibility into Flipdish staff access to their org, not for the staff member themselves. * @summary An org\'s expired timed access grant history * @param {string} orgId * @param {number} [limit] Page size, defaults to a server-chosen value * @param {string} [cursor] Opaque pagination cursor returned as nextCursor on a previous page * @param {*} [options] Override http request option. * @throws {RequiredError} */ listExpiredTimedAccessGrantsForOrg: (orgId: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the authenticated caller\'s active pass for the requested org. * @summary List the caller\'s active timed access pass for an org * @param {string} orgId * @param {ListMyTimedAccessGrantsStatusEnum} [status] Only active grants are returned. The caller comes from the auth context * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMyTimedAccessGrants: (orgId: string, status?: ListMyTimedAccessGrantsStatusEnum, options?: RawAxiosRequestConfig) => Promise; }; /** * TimedAccessApi - functional programming interface * @export */ export declare const TimedAccessApiFp: (configuration?: Configuration) => { /** * Grants the authenticated caller temporary Owner access to a single org. Requesting again while a pass is active extends it rather than creating a second one. * @summary Create a timed access pass * @param {string} orgId * @param {TimedAccessGrantRequestBody} [timedAccessGrantRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTimedAccessGrant(orgId: string, timedAccessGrantRequestBody?: TimedAccessGrantRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the org’s expired timed access passes, most recent first. Intended for client-facing visibility into Flipdish staff access to their org, not for the staff member themselves. * @summary An org\'s expired timed access grant history * @param {string} orgId * @param {number} [limit] Page size, defaults to a server-chosen value * @param {string} [cursor] Opaque pagination cursor returned as nextCursor on a previous page * @param {*} [options] Override http request option. * @throws {RequiredError} */ listExpiredTimedAccessGrantsForOrg(orgId: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the authenticated caller\'s active pass for the requested org. * @summary List the caller\'s active timed access pass for an org * @param {string} orgId * @param {ListMyTimedAccessGrantsStatusEnum} [status] Only active grants are returned. The caller comes from the auth context * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMyTimedAccessGrants(orgId: string, status?: ListMyTimedAccessGrantsStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TimedAccessApi - factory interface * @export */ export declare const TimedAccessApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Grants the authenticated caller temporary Owner access to a single org. Requesting again while a pass is active extends it rather than creating a second one. * @summary Create a timed access pass * @param {string} orgId * @param {TimedAccessGrantRequestBody} [timedAccessGrantRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTimedAccessGrant(orgId: string, timedAccessGrantRequestBody?: TimedAccessGrantRequestBody, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the org’s expired timed access passes, most recent first. Intended for client-facing visibility into Flipdish staff access to their org, not for the staff member themselves. * @summary An org\'s expired timed access grant history * @param {string} orgId * @param {number} [limit] Page size, defaults to a server-chosen value * @param {string} [cursor] Opaque pagination cursor returned as nextCursor on a previous page * @param {*} [options] Override http request option. * @throws {RequiredError} */ listExpiredTimedAccessGrantsForOrg(orgId: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the authenticated caller\'s active pass for the requested org. * @summary List the caller\'s active timed access pass for an org * @param {string} orgId * @param {ListMyTimedAccessGrantsStatusEnum} [status] Only active grants are returned. The caller comes from the auth context * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMyTimedAccessGrants(orgId: string, status?: ListMyTimedAccessGrantsStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * TimedAccessApi - object-oriented interface * @export * @class TimedAccessApi * @extends {BaseAPI} */ export declare class TimedAccessApi extends BaseAPI { /** * Grants the authenticated caller temporary Owner access to a single org. Requesting again while a pass is active extends it rather than creating a second one. * @summary Create a timed access pass * @param {string} orgId * @param {TimedAccessGrantRequestBody} [timedAccessGrantRequestBody] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TimedAccessApi */ createTimedAccessGrant(orgId: string, timedAccessGrantRequestBody?: TimedAccessGrantRequestBody, options?: RawAxiosRequestConfig): Promise>; /** * Returns the org’s expired timed access passes, most recent first. Intended for client-facing visibility into Flipdish staff access to their org, not for the staff member themselves. * @summary An org\'s expired timed access grant history * @param {string} orgId * @param {number} [limit] Page size, defaults to a server-chosen value * @param {string} [cursor] Opaque pagination cursor returned as nextCursor on a previous page * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TimedAccessApi */ listExpiredTimedAccessGrantsForOrg(orgId: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise>; /** * Returns the authenticated caller\'s active pass for the requested org. * @summary List the caller\'s active timed access pass for an org * @param {string} orgId * @param {ListMyTimedAccessGrantsStatusEnum} [status] Only active grants are returned. The caller comes from the auth context * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TimedAccessApi */ listMyTimedAccessGrants(orgId: string, status?: ListMyTimedAccessGrantsStatusEnum, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const ListMyTimedAccessGrantsStatusEnum: { readonly Active: "active"; }; export type ListMyTimedAccessGrantsStatusEnum = typeof ListMyTimedAccessGrantsStatusEnum[keyof typeof ListMyTimedAccessGrantsStatusEnum]; /** * UserManagementApi - axios parameter creator * @export */ export declare const UserManagementApiAxiosParamCreator: (configuration?: Configuration) => { /** * List the users in a given org * @summary List Users in Org * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsersInOrg: (orgId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * UserManagementApi - functional programming interface * @export */ export declare const UserManagementApiFp: (configuration?: Configuration) => { /** * List the users in a given org * @summary List Users in Org * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserManagementApi - factory interface * @export */ export declare const UserManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * List the users in a given org * @summary List Users in Org * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * UserManagementApi - object-oriented interface * @export * @class UserManagementApi * @extends {BaseAPI} */ export declare class UserManagementApi extends BaseAPI { /** * List the users in a given org * @summary List Users in Org * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserManagementApi */ listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise>; } /** * UserPermissionsApi - axios parameter creator * @export */ export declare const UserPermissionsApiAxiosParamCreator: (configuration?: Configuration) => { /** * List the current permission assignments in the org * @summary List Org Permissions * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrgPermissions: (orgId: string, options?: RawAxiosRequestConfig) => Promise; /** * List the current roles assignments in the org * @summary List Org Roles * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrgRoles: (orgId: string, options?: RawAxiosRequestConfig) => Promise; /** * List the available permissions for the current user * @summary List Own Permissions * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOwnPermissions: (orgId: string, options?: RawAxiosRequestConfig) => Promise; /** * List the available permissions for a given user * @summary List User Permissions * @param {string} orgId * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUserPermissions: (orgId: string, userId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * UserPermissionsApi - functional programming interface * @export */ export declare const UserPermissionsApiFp: (configuration?: Configuration) => { /** * List the current permission assignments in the org * @summary List Org Permissions * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }; }>>; /** * List the current roles assignments in the org * @summary List Org Roles * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: ListOrgRolesSuccessResponseValue; }>>; /** * List the available permissions for the current user * @summary List Own Permissions * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List the available permissions for a given user * @summary List User Permissions * @param {string} orgId * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UserPermissionsApi - factory interface * @export */ export declare const UserPermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * List the current permission assignments in the org * @summary List Org Permissions * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: { [key: string]: GetUserPermissionsSuccessResponseResourcesValue; }; }>; /** * List the current roles assignments in the org * @summary List Org Roles * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: ListOrgRolesSuccessResponseValue; }>; /** * List the available permissions for the current user * @summary List Own Permissions * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * List the available permissions for a given user * @summary List User Permissions * @param {string} orgId * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} */ listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * UserPermissionsApi - object-oriented interface * @export * @class UserPermissionsApi * @extends {BaseAPI} */ export declare class UserPermissionsApi extends BaseAPI { /** * List the current permission assignments in the org * @summary List Org Permissions * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserPermissionsApi */ listOrgPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise>; /** * List the current roles assignments in the org * @summary List Org Roles * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserPermissionsApi */ listOrgRoles(orgId: string, options?: RawAxiosRequestConfig): Promise>; /** * List the available permissions for the current user * @summary List Own Permissions * @param {string} orgId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserPermissionsApi */ listOwnPermissions(orgId: string, options?: RawAxiosRequestConfig): Promise>; /** * List the available permissions for a given user * @summary List User Permissions * @param {string} orgId * @param {string} userId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserPermissionsApi */ listUserPermissions(orgId: string, userId: string, options?: RawAxiosRequestConfig): Promise>; }