@flipdish/authorization 0.2.32 → 0.2.33

package/dist/api.d.ts

@@ -963,6 +963,58 @@ export type GetUserPermissionsSuccessResponseResourcesValueResourceTypeEnum = ty
  */
 export interface GetUserPermissionsSuccessResponseResourcesValueResourceId {
 }
+/**
+ * Grant teammate app access to a user being assigned within a brand for the first time.
+ * @export
+ * @interface GrantTeammateAccessRequestBody
+ */
+export interface GrantTeammateAccessRequestBody {
+    /**
+     * Teammate app access level (role)
+     * @type {string}
+     * @memberof GrantTeammateAccessRequestBody
+     */
+    'appAccessLevel': GrantTeammateAccessRequestBodyAppAccessLevelEnum;
+    /**
+     * Brand identifier (AppId); normalized to lowercase when stored
+     * @type {string}
+     * @memberof GrantTeammateAccessRequestBody
+     */
+    'brandId': string;
+    /**
+     * Org-wide store access; when false, propertyIds are required for property-scoped roles
+     * @type {boolean}
+     * @memberof GrantTeammateAccessRequestBody
+     */
+    'hasAccessToAllStores': boolean;
+    /**
+     * Property resource ids (e.g. p123) when scoped to properties
+     * @type {Array<string>}
+     * @memberof GrantTeammateAccessRequestBody
+     */
+    'propertyIds'?: Array<string>;
+    /**
+     * Target user email; persisted on first assignment only
+     * @type {string}
+     * @memberof GrantTeammateAccessRequestBody
+     */
+    'userEmail': string;
+    /**
+     * Target user display name; persisted on first assignment only
+     * @type {string}
+     * @memberof GrantTeammateAccessRequestBody
+     */
+    'userName'?: string;
+}
+export declare const GrantTeammateAccessRequestBodyAppAccessLevelEnum: {
+    readonly Owner: "Owner";
+    readonly ManagedOwner: "ManagedOwner";
+    readonly PropertyOwner: "PropertyOwner";
+    readonly PropertyManager: "PropertyManager";
+    readonly FinanceManager: "FinanceManager";
+    readonly Integrator: "Integrator";
+};
+export type GrantTeammateAccessRequestBodyAppAccessLevelEnum = typeof GrantTeammateAccessRequestBodyAppAccessLevelEnum[keyof typeof GrantTeammateAccessRequestBodyAppAccessLevelEnum];
 /**
  *
  * @export
@@ -1389,6 +1441,60 @@ export declare const Permissions: {
     readonly RoleAuthDeveloper: "RoleAuthDeveloper";
 };
 export type Permissions = typeof Permissions[keyof typeof Permissions];
+/**
+ * Principal with teammate permission summary
+ * @export
+ * @interface PrincipalInOrgWithTeammatePermissionSummary
+ */
+export interface PrincipalInOrgWithTeammatePermissionSummary {
+    /**
+     *
+     * @type {string}
+     * @memberof PrincipalInOrgWithTeammatePermissionSummary
+     */
+    'type': PrincipalInOrgWithTeammatePermissionSummaryTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof PrincipalInOrgWithTeammatePermissionSummary
+     */
+    'id': string;
+    /**
+     *
+     * @type {string}
+     * @memberof PrincipalInOrgWithTeammatePermissionSummary
+     */
+    'name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PrincipalInOrgWithTeammatePermissionSummary
+     */
+    'email'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PrincipalInOrgWithTeammatePermissionSummary
+     */
+    'phone'?: string;
+    /**
+     * Teammate role label; null when no compensating role or unknown
+     * @type {string}
+     * @memberof PrincipalInOrgWithTeammatePermissionSummary
+     */
+    'roleDisplay': string;
+    /**
+     * True when granular roles differ from default for the compensating role
+     * @type {boolean}
+     * @memberof PrincipalInOrgWithTeammatePermissionSummary
+     */
+    'isCustomised': boolean;
+}
+export declare const PrincipalInOrgWithTeammatePermissionSummaryTypeEnum: {
+    readonly User: "User";
+    readonly Automation: "Automation";
+};
+export type PrincipalInOrgWithTeammatePermissionSummaryTypeEnum = typeof PrincipalInOrgWithTeammatePermissionSummaryTypeEnum[keyof typeof PrincipalInOrgWithTeammatePermissionSummaryTypeEnum];
 /**
  * Principals in org
  * @export
@@ -1408,6 +1514,25 @@ export interface PrincipalsInOrgResponse {
      */
     'principals': Array<AuthorizationRequestPrincipal>;
 }
+/**
+ * Principals in org including teammate permission summary per principal
+ * @export
+ * @interface PrincipalsInOrgWithTeammatePermissionSummaryResponse
+ */
+export interface PrincipalsInOrgWithTeammatePermissionSummaryResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof PrincipalsInOrgWithTeammatePermissionSummaryResponse
+     */
+    'orgId': string;
+    /**
+     * List of principals with roleDisplay and isCustomised
+     * @type {Array<PrincipalInOrgWithTeammatePermissionSummary>}
+     * @memberof PrincipalsInOrgWithTeammatePermissionSummaryResponse
+     */
+    'principals': Array<PrincipalInOrgWithTeammatePermissionSummary>;
+}
 /**
  * Details for revoking a forbidden role from a principal
  * @export
@@ -1572,6 +1697,59 @@ export declare const RoleNames: {
     readonly AuthDeveloper: "AuthDeveloper";
 };
 export type RoleNames = typeof RoleNames[keyof typeof RoleNames];
+/**
+ * Teammate access applied
+ * @export
+ * @interface TeammateAccessSuccessResponse
+ */
+export interface TeammateAccessSuccessResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof TeammateAccessSuccessResponse
+     */
+    'message': string;
+}
+/**
+ * Update teammate app access for an existing teammate. Email and name are not accepted on update; the existing values stored against the user id are reused.
+ * @export
+ * @interface UpdateTeammateAccessRequestBody
+ */
+export interface UpdateTeammateAccessRequestBody {
+    /**
+     * Teammate app access level (role)
+     * @type {string}
+     * @memberof UpdateTeammateAccessRequestBody
+     */
+    'appAccessLevel': UpdateTeammateAccessRequestBodyAppAccessLevelEnum;
+    /**
+     * Brand identifier (AppId); normalized to lowercase when stored
+     * @type {string}
+     * @memberof UpdateTeammateAccessRequestBody
+     */
+    'brandId': string;
+    /**
+     * Org-wide store access; when false, propertyIds are required for property-scoped roles
+     * @type {boolean}
+     * @memberof UpdateTeammateAccessRequestBody
+     */
+    'hasAccessToAllStores': boolean;
+    /**
+     * Property resource ids (e.g. p123) when scoped to properties
+     * @type {Array<string>}
+     * @memberof UpdateTeammateAccessRequestBody
+     */
+    'propertyIds'?: Array<string>;
+}
+export declare const UpdateTeammateAccessRequestBodyAppAccessLevelEnum: {
+    readonly Owner: "Owner";
+    readonly ManagedOwner: "ManagedOwner";
+    readonly PropertyOwner: "PropertyOwner";
+    readonly PropertyManager: "PropertyManager";
+    readonly FinanceManager: "FinanceManager";
+    readonly Integrator: "Integrator";
+};
+export type UpdateTeammateAccessRequestBodyAppAccessLevelEnum = typeof UpdateTeammateAccessRequestBodyAppAccessLevelEnum[keyof typeof UpdateTeammateAccessRequestBodyAppAccessLevelEnum];
 /**
  *
  * @export
@@ -2204,6 +2382,16 @@ export declare const RoleAssignmentApiAxiosParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     getPrincipalRoles: (orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Grant teammate app access and underlying permissions for a user being assigned within a brand for the first time. Email and name are persisted on first assignment only and must be supplied here.
+     * @summary Grant teammate access to a new user
+     * @param {string} orgId
+     * @param {string} userId Target Flipdish user id (numeric string)
+     * @param {GrantTeammateAccessRequestBody} [grantTeammateAccessRequestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    grantTeammateAccess: (orgId: string, userId: string, grantTeammateAccessRequestBody?: GrantTeammateAccessRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Revokes a forbidden role from a given principal (user, group, etc.)
      * @summary Revoke Forbidden Role from Principal
@@ -2222,6 +2410,16 @@ export declare const RoleAssignmentApiAxiosParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     revokeRoleFromPrincipal: (orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update teammate app access and underlying permissions for an existing teammate. The user must already have been granted access for this brand. Email and name are not accepted on update; existing values are reused. Returns 404 if no existing assignment is found.
+     * @summary Update teammate access for an existing user
+     * @param {string} orgId
+     * @param {string} userId Target Flipdish user id (numeric string)
+     * @param {UpdateTeammateAccessRequestBody} [updateTeammateAccessRequestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTeammateAccess: (orgId: string, userId: string, updateTeammateAccessRequestBody?: UpdateTeammateAccessRequestBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * RoleAssignmentApi - functional programming interface
@@ -2246,6 +2444,16 @@ export declare const RoleAssignmentApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPrincipalRolesSuccessResponse>>;
+    /**
+     * Grant teammate app access and underlying permissions for a user being assigned within a brand for the first time. Email and name are persisted on first assignment only and must be supplied here.
+     * @summary Grant teammate access to a new user
+     * @param {string} orgId
+     * @param {string} userId Target Flipdish user id (numeric string)
+     * @param {GrantTeammateAccessRequestBody} [grantTeammateAccessRequestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    grantTeammateAccess(orgId: string, userId: string, grantTeammateAccessRequestBody?: GrantTeammateAccessRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeammateAccessSuccessResponse>>;
     /**
      * Revokes a forbidden role from a given principal (user, group, etc.)
      * @summary Revoke Forbidden Role from Principal
@@ -2264,6 +2472,16 @@ export declare const RoleAssignmentApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RevokeRoleSuccessResponse>>;
+    /**
+     * Update teammate app access and underlying permissions for an existing teammate. The user must already have been granted access for this brand. Email and name are not accepted on update; existing values are reused. Returns 404 if no existing assignment is found.
+     * @summary Update teammate access for an existing user
+     * @param {string} orgId
+     * @param {string} userId Target Flipdish user id (numeric string)
+     * @param {UpdateTeammateAccessRequestBody} [updateTeammateAccessRequestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTeammateAccess(orgId: string, userId: string, updateTeammateAccessRequestBody?: UpdateTeammateAccessRequestBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TeammateAccessSuccessResponse>>;
 };
 /**
  * RoleAssignmentApi - factory interface
@@ -2288,6 +2506,16 @@ export declare const RoleAssignmentApiFactory: (configuration?: Configuration, b
      * @throws {RequiredError}
      */
     getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<GetPrincipalRolesSuccessResponse>;
+    /**
+     * Grant teammate app access and underlying permissions for a user being assigned within a brand for the first time. Email and name are persisted on first assignment only and must be supplied here.
+     * @summary Grant teammate access to a new user
+     * @param {string} orgId
+     * @param {string} userId Target Flipdish user id (numeric string)
+     * @param {GrantTeammateAccessRequestBody} [grantTeammateAccessRequestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    grantTeammateAccess(orgId: string, userId: string, grantTeammateAccessRequestBody?: GrantTeammateAccessRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<TeammateAccessSuccessResponse>;
     /**
      * Revokes a forbidden role from a given principal (user, group, etc.)
      * @summary Revoke Forbidden Role from Principal
@@ -2306,6 +2534,16 @@ export declare const RoleAssignmentApiFactory: (configuration?: Configuration, b
      * @throws {RequiredError}
      */
     revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<RevokeRoleSuccessResponse>;
+    /**
+     * Update teammate app access and underlying permissions for an existing teammate. The user must already have been granted access for this brand. Email and name are not accepted on update; existing values are reused. Returns 404 if no existing assignment is found.
+     * @summary Update teammate access for an existing user
+     * @param {string} orgId
+     * @param {string} userId Target Flipdish user id (numeric string)
+     * @param {UpdateTeammateAccessRequestBody} [updateTeammateAccessRequestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTeammateAccess(orgId: string, userId: string, updateTeammateAccessRequestBody?: UpdateTeammateAccessRequestBody, options?: RawAxiosRequestConfig): AxiosPromise<TeammateAccessSuccessResponse>;
 };
 /**
  * RoleAssignmentApi - object-oriented interface
@@ -2334,6 +2572,17 @@ export declare class RoleAssignmentApi extends BaseAPI {
      * @memberof RoleAssignmentApi
      */
     getPrincipalRoles(orgId: string, getPrincipalRolesRequestBody?: GetPrincipalRolesRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPrincipalRolesSuccessResponse, any, {}>>;
+    /**
+     * Grant teammate app access and underlying permissions for a user being assigned within a brand for the first time. Email and name are persisted on first assignment only and must be supplied here.
+     * @summary Grant teammate access to a new user
+     * @param {string} orgId
+     * @param {string} userId Target Flipdish user id (numeric string)
+     * @param {GrantTeammateAccessRequestBody} [grantTeammateAccessRequestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RoleAssignmentApi
+     */
+    grantTeammateAccess(orgId: string, userId: string, grantTeammateAccessRequestBody?: GrantTeammateAccessRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeammateAccessSuccessResponse, any, {}>>;
     /**
      * Revokes a forbidden role from a given principal (user, group, etc.)
      * @summary Revoke Forbidden Role from Principal
@@ -2354,6 +2603,17 @@ export declare class RoleAssignmentApi extends BaseAPI {
      * @memberof RoleAssignmentApi
      */
     revokeRoleFromPrincipal(orgId: string, revokeRoleRequestBody?: RevokeRoleRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RevokeRoleSuccessResponse, any, {}>>;
+    /**
+     * Update teammate app access and underlying permissions for an existing teammate. The user must already have been granted access for this brand. Email and name are not accepted on update; existing values are reused. Returns 404 if no existing assignment is found.
+     * @summary Update teammate access for an existing user
+     * @param {string} orgId
+     * @param {string} userId Target Flipdish user id (numeric string)
+     * @param {UpdateTeammateAccessRequestBody} [updateTeammateAccessRequestBody]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RoleAssignmentApi
+     */
+    updateTeammateAccess(orgId: string, userId: string, updateTeammateAccessRequestBody?: UpdateTeammateAccessRequestBody, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TeammateAccessSuccessResponse, any, {}>>;
 }
 /**
  * UserManagementApi - axios parameter creator
@@ -2368,6 +2628,14 @@ export declare const UserManagementApiAxiosParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     listUsersInOrg: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Same principals as list users, plus roleDisplay and isCustomised per principal (extra Dynamo reads for compensating roles and granular assignments).
+     * @summary List Users in Org with teammate permission summary
+     * @param {string} orgId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUsersInOrgWithTeammatePermissionSummary: (orgId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * UserManagementApi - functional programming interface
@@ -2382,6 +2650,14 @@ export declare const UserManagementApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrincipalsInOrgResponse>>;
+    /**
+     * Same principals as list users, plus roleDisplay and isCustomised per principal (extra Dynamo reads for compensating roles and granular assignments).
+     * @summary List Users in Org with teammate permission summary
+     * @param {string} orgId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUsersInOrgWithTeammatePermissionSummary(orgId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PrincipalsInOrgWithTeammatePermissionSummaryResponse>>;
 };
 /**
  * UserManagementApi - factory interface
@@ -2396,6 +2672,14 @@ export declare const UserManagementApiFactory: (configuration?: Configuration, b
      * @throws {RequiredError}
      */
     listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrincipalsInOrgResponse>;
+    /**
+     * Same principals as list users, plus roleDisplay and isCustomised per principal (extra Dynamo reads for compensating roles and granular assignments).
+     * @summary List Users in Org with teammate permission summary
+     * @param {string} orgId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listUsersInOrgWithTeammatePermissionSummary(orgId: string, options?: RawAxiosRequestConfig): AxiosPromise<PrincipalsInOrgWithTeammatePermissionSummaryResponse>;
 };
 /**
  * UserManagementApi - object-oriented interface
@@ -2413,6 +2697,15 @@ export declare class UserManagementApi extends BaseAPI {
      * @memberof UserManagementApi
      */
     listUsersInOrg(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrincipalsInOrgResponse, any, {}>>;
+    /**
+     * Same principals as list users, plus roleDisplay and isCustomised per principal (extra Dynamo reads for compensating roles and granular assignments).
+     * @summary List Users in Org with teammate permission summary
+     * @param {string} orgId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserManagementApi
+     */
+    listUsersInOrgWithTeammatePermissionSummary(orgId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PrincipalsInOrgWithTeammatePermissionSummaryResponse, any, {}>>;
 }
 /**
  * UserPermissionsApi - axios parameter creator