@wix/auto_sdk_user-management_users 1.0.13 → 1.0.15

package/build/cjs/index.d.ts

@@ -0,0 +1,48 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { SearchTeamOptions, SearchTeamResponse, GetRolesInfoOptions, GetRolesInfoResponse, UpdateTeamMemberAssignmentsOptions, UpdateTeamMemberAssignmentsResponse } from './index.typings.js';
+export { AccountInfo, AccountInvite, AccountResourceContext, ApiCondition, ApiInviteAssignment, ApiPolicy, ApiResource, AreasFilter, AssignedPolicy, AssignedSubject, Assignment, AssignmentV3, ChangeRoleRequest, ChangeRoleResponse, ChangeRoleV2Options, ChangeRoleV2Request, ChangeRoleV2Response, CompanionResource, Condition, ConditionAttributeType, ConditionOperator, ConditionOperatorOperatorsOneOf, ConditionType, ConditionTypeOfOneOf, ConditionValue, ConditionValueValueOneOf, Conditions, Contributor, CreateCustomRoleRequest, CreateCustomRoleResponse, CustomRole, CustomRoleV2, DependOnOperator, Direction, EditorType, Effect, EnvironmentCondition, EnvironmentConditionConditionOneOf, EqualOperator, ExperimentCondition, ExperimentOperator, Facet, FacetType, FacetValue, FolderResource, FullNameResource, FullNameResourceResourceContextOneOf, GetPeopleRequest, GetPeopleResponse, GetPoliciesRequest, GetPoliciesResponse, GetRolesInfoRequest, GetRolesRequest, GetRolesResponse, GetRolesV2Request, GetRolesV2Response, GetScopesRequest, GetScopesResponse, GetSubjectsAssignmentsRequest, GetSubjectsAssignmentsResponse, GetTeamInvitesRequest, GetTeamInvitesResponse, GetTeamRequest, GetTeamResponse, GetTeamV2Response, GetUsersRequest, GetUsersResponse, Host, Invite, InviteAssignment, InviteAssignmentV3, InviteResourceAssignment, InviteStatus, InviteV3, JoinedCondition, JoinedConditionOperator, LikeOperator, LocationsRestriction, Name, OrderField, Ordering, OrganizationResourceContext, Paging, People, PeopleResource, PeopleResourceResourceTypeOneOf, PeopleType, PermissionScope, Person, PersonMetaData, PersonPersonOneOf, Policy, PolicyCondition, PolicyStatement, PolicyType, PredefinedRole, PredefinedRoleV2, PredefinedRoles, PredefinedRolesArea, PredefinedRolesAreaV2, RemoveMemberRequest, RemoveMemberResponse, Resource, ResourceType, Restriction, RestrictionRestrictionsOneOf, Role, RoleInfo, RoleInfoV2, RoleLevel, RoleLevelRestriction, RoleVisibility, RolesInfoFilter, ScopeArea, ScopeLevel, SearchTeamRequest, SimpleCondition, SimpleConditionOperator, SimpleConditionValue, SimpleConditionValueValueOneOf, SiteResourceContext, SiteRestriction, Subject, SubjectAssignments, SubjectContext, SubjectContextType, SubjectType, TeamMember, TeamMemberV3, TeamMemberV3MembersOneOf, UpdateTeamMemberAssignmentsRequest, User, UserV3, Visibility } from './index.typings.js';
+
+declare function removeMember$1(httpClient: HttpClient): RemoveMemberSignature;
+interface RemoveMemberSignature {
+    /**
+     * Removes a team member from the requesting account.
+     * > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
+     * @param - User ID of the team member to remove.
+     */
+    (userId: string): Promise<void>;
+}
+declare function searchTeam$1(httpClient: HttpClient): SearchTeamSignature;
+interface SearchTeamSignature {
+    /**
+     * Retrieves all team members of the requesting account, based on the provided filters and free text queries.
+     * > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
+     * @param - Filter options.
+     */
+    (options?: SearchTeamOptions | undefined): Promise<SearchTeamResponse>;
+}
+declare function getRolesInfo$1(httpClient: HttpClient): GetRolesInfoSignature;
+interface GetRolesInfoSignature {
+    /**
+     * Retrieves all available roles in the requesting account, including predefined and custom roles.
+     * > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
+     * @param - Filter options.
+     */
+    (options?: GetRolesInfoOptions | undefined): Promise<GetRolesInfoResponse>;
+}
+declare function updateTeamMemberAssignments$1(httpClient: HttpClient): UpdateTeamMemberAssignmentsSignature;
+interface UpdateTeamMemberAssignmentsSignature {
+    /**
+     * Updates the assignments of roles and conditions for an existing team member.  Changing assignments changes the team member’s access to account assets.
+     * > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
+     * @param - ID of team member being affected.
+     * @param - Filter options. The `assignmentIdsToRemove` and `newAssignments` fields **must** be passed.
+     */
+    (userId: string, options: UpdateTeamMemberAssignmentsOptions): Promise<UpdateTeamMemberAssignmentsResponse>;
+}
+
+declare const removeMember: MaybeContext<BuildRESTFunction<typeof removeMember$1> & typeof removeMember$1>;
+declare const searchTeam: MaybeContext<BuildRESTFunction<typeof searchTeam$1> & typeof searchTeam$1>;
+declare const getRolesInfo: MaybeContext<BuildRESTFunction<typeof getRolesInfo$1> & typeof getRolesInfo$1>;
+declare const updateTeamMemberAssignments: MaybeContext<BuildRESTFunction<typeof updateTeamMemberAssignments$1> & typeof updateTeamMemberAssignments$1>;
+
+export { GetRolesInfoOptions, GetRolesInfoResponse, SearchTeamOptions, SearchTeamResponse, UpdateTeamMemberAssignmentsOptions, UpdateTeamMemberAssignmentsResponse, getRolesInfo, removeMember, searchTeam, updateTeamMemberAssignments };

package/build/{identity-roles-v1-user-users.universal-CDCph1O2.d.mts → cjs/index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface User {
     /** User ID. */
     _id?: string;
@@ -1141,6 +1143,24 @@ interface CustomRoleV2 {
     /** Whether this role is assigned to the current user */
     assigned?: boolean;
 }
+/**
+ * Removes a team member from the requesting account.
+ * > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
+ * @param userId - User ID of the team member to remove.
+ * @public
+ * @requiredField userId
+ * @permissionId team.delete-member
+ * @fqn com.wixpress.roles.management.api.RolesManagementService.RemoveMember
+ */
+declare function removeMember(userId: string): Promise<void>;
+/**
+ * Retrieves all team members of the requesting account, based on the provided filters and free text queries.
+ * > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
+ * @public
+ * @param options - Filter options.
+ * @fqn com.wixpress.roles.management.api.RolesManagementService.SearchTeam
+ */
+declare function searchTeam(options?: SearchTeamOptions): Promise<NonNullablePaths<SearchTeamResponse, `facets` | `facets.${number}.facetType` | `teamMembers` | `teamMembers.${number}.user._id` | `teamMembers.${number}.user.name.firstName` | `teamMembers.${number}.user.name.lastName` | `teamMembers.${number}.invite._id` | `teamMembers.${number}.invite.status`>>;
 interface SearchTeamOptions {
     /** Free text to search for within team member name and email address fields. */
     query?: string | null;
@@ -1159,6 +1179,15 @@ interface SearchTeamOptions {
     /** Pagination. */
     paging?: Paging;
 }
+/**
+ * Retrieves all available roles in the requesting account, including predefined and custom roles.
+ * > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
+ * @public
+ * @param options - Filter options.
+ * @permissionId ACCOUNT_ROLES.GET_ROLES
+ * @fqn com.wixpress.roles.management.api.RolesManagementService.GetRolesInfo
+ */
+declare function getRolesInfo(options?: GetRolesInfoOptions): Promise<NonNullablePaths<GetRolesInfoResponse, `predefinedRoles` | `predefinedRoles.${number}._id` | `predefinedRoles.${number}.title` | `predefinedRoles.${number}.description` | `predefinedRoles.${number}.restrictFromLevel` | `customRoles` | `customRoles.${number}._id` | `customRoles.${number}.title` | `customRoles.${number}.description` | `customRoles.${number}.restrictFromLevel`>>;
 interface GetRolesInfoOptions {
     /** Language of predefined roles names and descriptions to return, in ISO 639 format. Default: `en`. */
     locale?: string | null;
@@ -1171,6 +1200,20 @@ interface ChangeRoleV2Options {
     /** Existing assignment IDs to remove. To retrieve all existing assignment IDs for a team member, call Search Team. */
     assignmentIdsToReplace: string[];
 }
+/**
+ * Updates the assignments of roles and conditions for an existing team member.  Changing assignments changes the team member’s access to account assets.
+ * > **Important**: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.
+ * @param userId - ID of team member being affected.
+ * @public
+ * @requiredField options
+ * @requiredField options.assignmentIdsToRemove
+ * @requiredField options.newAssignments
+ * @requiredField userId
+ * @param options - Filter options. The `assignmentIdsToRemove` and `newAssignments` fields **must** be passed.
+ * @permissionId team.manage-team-member-roles
+ * @fqn com.wixpress.roles.management.api.RolesManagementService.UpdateTeamMemberAssignments
+ */
+declare function updateTeamMemberAssignments(userId: string, options: NonNullablePaths<UpdateTeamMemberAssignmentsOptions, `assignmentIdsToRemove` | `newAssignments`>): Promise<NonNullablePaths<UpdateTeamMemberAssignmentsResponse, `assignments` | `assignments.${number}.restrictions.resource.resourceType` | `assignments.${number}.restrictions.resource._id` | `assignments.${number}.restrictions.site._id` | `assignments.${number}.subject._id` | `assignments.${number}.subject.subjectType`>>;
 interface UpdateTeamMemberAssignmentsOptions {
     /**
      * New assignments to apply to the team member in this account.
@@ -1185,4 +1228,4 @@ interface UpdateTeamMemberAssignmentsOptions {
     assignmentIdsToRemove: string[];
 }
 
-export { type ConditionType as $, type Assignment as A, type AccountInvite as B, ConditionAttributeType as C, Direction as D, EditorType as E, FacetType as F, type GetRolesInfoOptions as G, Host as H, InviteStatus as I, JoinedConditionOperator as J, type InviteResourceAssignment as K, type LocationsRestriction as L, type InviteAssignment as M, type Name as N, OrderField as O, PeopleType as P, type FullNameResource as Q, ResourceType as R, type SearchTeamOptions as S, type FullNameResourceResourceContextOneOf as T, type UpdateTeamMemberAssignmentsOptions as U, Visibility as V, type SiteResourceContext as W, type AccountResourceContext as X, type OrganizationResourceContext as Y, type Resource as Z, type PolicyCondition as _, type SearchTeamResponse as a, type GetRolesResponse as a$, type ConditionTypeOfOneOf as a0, type SimpleCondition as a1, type SimpleConditionValue as a2, type SimpleConditionValueValueOneOf as a3, type JoinedCondition as a4, type EnvironmentCondition as a5, type EnvironmentConditionConditionOneOf as a6, type ExperimentCondition as a7, type Condition as a8, type ConditionOperator as a9, type GetPeopleResponse as aA, type People as aB, type Person as aC, type PersonPersonOneOf as aD, type Contributor as aE, type PersonMetaData as aF, type TeamMember as aG, type GetTeamV2Response as aH, type GetTeamInvitesRequest as aI, type GetTeamInvitesResponse as aJ, type Invite as aK, type ApiInviteAssignment as aL, type GetPoliciesRequest as aM, type AreasFilter as aN, type GetPoliciesResponse as aO, type SearchTeamRequest as aP, type Ordering as aQ, type Facet as aR, type FacetValue as aS, type TeamMemberV3 as aT, type TeamMemberV3MembersOneOf as aU, type UserV3 as aV, type AssignmentV3 as aW, type AssignedSubject as aX, type InviteV3 as aY, type InviteAssignmentV3 as aZ, type GetRolesRequest as a_, type ConditionOperatorOperatorsOneOf as aa, type EqualOperator as ab, type ConditionValue as ac, type ConditionValueValueOneOf as ad, type LikeOperator as ae, type ExperimentOperator as af, type DependOnOperator as ag, type AccountInfo as ah, type ApiPolicy as ai, type PredefinedRoles as aj, type PredefinedRole as ak, type Role as al, type ChangeRoleRequest as am, type ChangeRoleResponse as an, type RemoveMemberRequest as ao, type RemoveMemberResponse as ap, type GetUsersRequest as aq, type GetUsersResponse as ar, type GetScopesRequest as as, type GetScopesResponse as at, type ScopeArea as au, type PermissionScope as av, type GetPeopleRequest as aw, type PeopleResource as ax, type PeopleResourceResourceTypeOneOf as ay, type FolderResource as az, type GetRolesInfoResponse as b, type PredefinedRolesArea as b0, type PredefinedRoleV2 as b1, type CustomRole as b2, type GetRolesInfoRequest as b3, type RolesInfoFilter as b4, type RoleInfo as b5, type CreateCustomRoleRequest as b6, type Policy as b7, type PolicyStatement as b8, type CreateCustomRoleResponse as b9, type ChangeRoleV2Request as ba, type ChangeRoleV2Response as bb, type UpdateTeamMemberAssignmentsRequest as bc, type GetSubjectsAssignmentsRequest as bd, type GetSubjectsAssignmentsResponse as be, type SubjectAssignments as bf, type GetRolesV2Request as bg, type GetRolesV2Response as bh, type PredefinedRolesAreaV2 as bi, type RoleInfoV2 as bj, type CustomRoleV2 as bk, type ChangeRoleV2Options as bl, type UpdateTeamMemberAssignmentsResponse as c, SubjectType as d, SubjectContextType as e, SimpleConditionOperator as f, ScopeLevel as g, RoleLevel as h, RoleLevelRestriction as i, RoleVisibility as j, PolicyType as k, Effect as l, type User as m, type AssignedPolicy as n, type Restriction as o, type RestrictionRestrictionsOneOf as p, type ApiResource as q, type Conditions as r, type ApiCondition as s, type SiteRestriction as t, type CompanionResource as u, type Subject as v, type SubjectContext as w, type GetTeamRequest as x, type Paging as y, type GetTeamResponse as z };
+export { type AccountInfo, type AccountInvite, type AccountResourceContext, type ApiCondition, type ApiInviteAssignment, type ApiPolicy, type ApiResource, type AreasFilter, type AssignedPolicy, type AssignedSubject, type Assignment, type AssignmentV3, type ChangeRoleRequest, type ChangeRoleResponse, type ChangeRoleV2Options, type ChangeRoleV2Request, type ChangeRoleV2Response, type CompanionResource, type Condition, ConditionAttributeType, type ConditionAttributeTypeWithLiterals, type ConditionOperator, type ConditionOperatorOperatorsOneOf, type ConditionType, type ConditionTypeOfOneOf, type ConditionValue, type ConditionValueValueOneOf, type Conditions, type Contributor, type CreateCustomRoleRequest, type CreateCustomRoleResponse, type CustomRole, type CustomRoleV2, type DependOnOperator, Direction, type DirectionWithLiterals, EditorType, type EditorTypeWithLiterals, Effect, type EffectWithLiterals, type EnvironmentCondition, type EnvironmentConditionConditionOneOf, type EqualOperator, type ExperimentCondition, type ExperimentOperator, type Facet, FacetType, type FacetTypeWithLiterals, type FacetValue, type FolderResource, type FullNameResource, type FullNameResourceResourceContextOneOf, type GetPeopleRequest, type GetPeopleResponse, type GetPoliciesRequest, type GetPoliciesResponse, type GetRolesInfoOptions, type GetRolesInfoRequest, type GetRolesInfoResponse, type GetRolesRequest, type GetRolesResponse, type GetRolesV2Request, type GetRolesV2Response, type GetScopesRequest, type GetScopesResponse, type GetSubjectsAssignmentsRequest, type GetSubjectsAssignmentsResponse, type GetTeamInvitesRequest, type GetTeamInvitesResponse, type GetTeamRequest, type GetTeamResponse, type GetTeamV2Response, type GetUsersRequest, type GetUsersResponse, Host, type HostWithLiterals, type Invite, type InviteAssignment, type InviteAssignmentV3, type InviteResourceAssignment, InviteStatus, type InviteStatusWithLiterals, type InviteV3, type JoinedCondition, JoinedConditionOperator, type JoinedConditionOperatorWithLiterals, type LikeOperator, type LocationsRestriction, type Name, OrderField, type OrderFieldWithLiterals, type Ordering, type OrganizationResourceContext, type Paging, type People, type PeopleResource, type PeopleResourceResourceTypeOneOf, PeopleType, type PeopleTypeWithLiterals, type PermissionScope, type Person, type PersonMetaData, type PersonPersonOneOf, type Policy, type PolicyCondition, type PolicyStatement, PolicyType, type PolicyTypeWithLiterals, type PredefinedRole, type PredefinedRoleV2, type PredefinedRoles, type PredefinedRolesArea, type PredefinedRolesAreaV2, type RemoveMemberRequest, type RemoveMemberResponse, type Resource, ResourceType, type ResourceTypeWithLiterals, type Restriction, type RestrictionRestrictionsOneOf, type Role, type RoleInfo, type RoleInfoV2, RoleLevel, RoleLevelRestriction, type RoleLevelRestrictionWithLiterals, type RoleLevelWithLiterals, RoleVisibility, type RoleVisibilityWithLiterals, type RolesInfoFilter, type ScopeArea, ScopeLevel, type ScopeLevelWithLiterals, type SearchTeamOptions, type SearchTeamRequest, type SearchTeamResponse, type SimpleCondition, SimpleConditionOperator, type SimpleConditionOperatorWithLiterals, type SimpleConditionValue, type SimpleConditionValueValueOneOf, type SiteResourceContext, type SiteRestriction, type Subject, type SubjectAssignments, type SubjectContext, SubjectContextType, type SubjectContextTypeWithLiterals, SubjectType, type SubjectTypeWithLiterals, type TeamMember, type TeamMemberV3, type TeamMemberV3MembersOneOf, type UpdateTeamMemberAssignmentsOptions, type UpdateTeamMemberAssignmentsRequest, type UpdateTeamMemberAssignmentsResponse, type User, type UserV3, Visibility, type VisibilityWithLiterals, getRolesInfo, removeMember, searchTeam, updateTeamMemberAssignments };