@wix/auto_sdk_user-management_contributors 1.0.0

package/build/internal/es/src/identity-v1-contributor-contributors.universal.d.ts

@@ -0,0 +1,678 @@
+export interface Contributor {
+    /** Contributor's metadata. */
+    metaData?: PersonMetaData;
+    /** Whether the contributor account is a team account. */
+    isTeam?: boolean | null;
+    /** Date that the contributor joined the site. */
+    joinedAt?: Date | null;
+    /** Email address that received the invite. */
+    invitedEmail?: string | null;
+    /** Whether the contributor account is a client account. */
+    isClient?: boolean | null;
+    /**
+     * Contributor's user ID.
+     * @readonly
+     */
+    _id?: string;
+}
+export interface PersonMetaData {
+    /** Contributor's account ID. */
+    _id?: string;
+    /** Contributor's full name. */
+    fullName?: string | null;
+    /** URL for contributor's profile image. */
+    imageUrl?: string | null;
+    /** Contributor's email address. */
+    email?: string | null;
+    /** Contributor's access to assets and their assigned role (`policy`) for that asset. */
+    assignments?: Assignment[];
+}
+export interface Assignment {
+    /** Role assigned to the user. */
+    policy?: AssignedPolicy;
+    /** Unique ID for this specific assignment. */
+    assignmentId?: string;
+    /** Identity assigned to the asset in an assignment, referred to as subject. Supported subjects include user IDs, account IDs, and app IDs. */
+    subject?: Subject;
+}
+export interface AssignedPolicy {
+    /** Role ID. */
+    policyId?: string;
+    /** Role title. */
+    title?: string | null;
+    /** Role description. */
+    description?: string | null;
+}
+export interface Restriction extends RestrictionRestrictionsOneOf {
+    /**
+     * Deprecated.
+     * @deprecated
+     */
+    resource?: Resource;
+    /** List of conditions restricting the user's access. Currently only folder conditions are supported. */
+    conditions?: Conditions;
+    /** Site where the assignment restrictions apply. */
+    site?: SiteRestriction;
+    /** Location where the assignment restrictions apply. */
+    locations?: LocationsRestriction;
+}
+/** @oneof */
+export interface RestrictionRestrictionsOneOf {
+    /**
+     * Deprecated.
+     * @deprecated
+     */
+    resource?: Resource;
+    /** List of conditions restricting the user's access. Currently only folder conditions are supported. */
+    conditions?: Conditions;
+    /** Site where the assignment restrictions apply. */
+    site?: SiteRestriction;
+    /** Location where the assignment restrictions apply. */
+    locations?: LocationsRestriction;
+}
+export interface Resource {
+    /** Resource type. */
+    resourceType?: ResourceType;
+    /** Resource ID. */
+    _id?: string;
+    value?: string | null;
+}
+export declare enum ResourceType {
+    UNKNOWN_RESOURCE_TYPE = "UNKNOWN_RESOURCE_TYPE",
+    SITE = "SITE"
+}
+export interface Conditions {
+    /** List of conditions. */
+    conditions?: Condition[];
+}
+export interface Condition {
+    /** Condition type. */
+    conditionType?: ConditionAttributeType;
+    /** Condition ID. */
+    _id?: string;
+    /** Expected value of the condition. When `conditionType` = "FOLDER", this is the folder path. */
+    value?: string | null;
+}
+export declare enum ConditionAttributeType {
+    UNKNOWN_CONDITION_TYPE = "UNKNOWN_CONDITION_TYPE",
+    FOLDER = "FOLDER"
+}
+export interface SiteRestriction {
+    /** Site ID. */
+    _id?: string;
+    /** Site name. */
+    value?: string | null;
+}
+export interface CompanionResource {
+    /** Asset ID (referred to here as resource ID). */
+    _id?: string;
+    /** Asset type (referred to here as resource type). as predefined in the authorization system */
+    resourceType?: string;
+}
+export interface LocationsRestriction {
+    /** Location IDs. */
+    ids?: string[];
+}
+export interface Subject {
+    /** ID of identity assigned to the asset. */
+    _id?: string;
+    /** Type of identity assigned to the asset. Supported subject types include user IDs, account IDs, and app IDs. */
+    subjectType?: SubjectType;
+    /** Context of identity assigned to the asset. For example, a `subjectType` = `USER` will have `context` = `ACCOUNT`. */
+    context?: SubjectContext;
+}
+export declare enum SubjectType {
+    UNKNOWN = "UNKNOWN",
+    ACCOUNT = "ACCOUNT",
+    USER = "USER",
+    USER_GROUP = "USER_GROUP",
+    MEMBER_GROUP = "MEMBER_GROUP",
+    VISITOR_GROUP = "VISITOR_GROUP",
+    EXTERNAL_APP = "EXTERNAL_APP",
+    ACCOUNT_GROUP = "ACCOUNT_GROUP",
+    WIX_APP = "WIX_APP"
+}
+export interface SubjectContext {
+    _id?: string;
+    contextType?: SubjectContextType;
+}
+export declare enum SubjectContextType {
+    UNKNOWN_CTX = "UNKNOWN_CTX",
+    ORG_CTX = "ORG_CTX",
+    ACCOUNT_CTX = "ACCOUNT_CTX"
+}
+export interface GetAppContributorsRequest {
+    appId?: string;
+    /** The locale of the request. Defaults to en-us. */
+    locale?: string | null;
+}
+export interface GetAppContributorsResponse {
+    contributors?: Contributor[];
+    invites?: AppInvite[];
+}
+export interface AppInvite {
+    /** @readonly */
+    _id?: string;
+    /** TODO: amitis - remove this comment after the next merge */
+    destEmail?: string;
+    /** @readonly */
+    status?: string;
+    /** @readonly */
+    acceptLink?: string;
+    invitePurpose?: string | null;
+    policies?: AssignedPolicy[];
+    /** @readonly */
+    expirationDate?: Date | null;
+    /** @readonly */
+    dateCreated?: Date | null;
+    /** @readonly */
+    dateUpdated?: Date | null;
+}
+export interface GetSiteContributorsRequest {
+    /** The locale of the request. Defaults to en-us */
+    locale?: string | null;
+}
+export interface GetSiteContributorsResponse {
+    users?: User[];
+    teams?: Team[];
+    invites?: SiteInvite[];
+    policies?: Policy[];
+    permissions?: string[];
+    userId?: string;
+    loggedInAccountId?: string;
+    pendingOwner?: PendingOwner;
+    contributorLimit?: ContributorLimit;
+    predefinedRoles?: PredefinedRoles;
+}
+export interface User {
+    /** User ID. */
+    _id?: string;
+    /**
+     * Deprecated.
+     * @deprecated
+     */
+    roles?: string[];
+    /** User's email address. */
+    email?: string;
+    /** User's name. */
+    name?: Name;
+    /** URL to user's profile image, when provided. */
+    profileImage?: string | null;
+    /** Date the user joined the team. */
+    joinedTeamAt?: Date | null;
+    /**
+     * Deprecated.
+     * @deprecated
+     */
+    policyIds?: string[];
+    /** Resources the user can access. */
+    assignments?: Assignment[];
+}
+export interface Name {
+    /** User's first name. */
+    firstName?: string;
+    /** User's last name. */
+    lastName?: string;
+}
+export interface Team {
+    accountId?: string;
+    accountInfo?: AccountInfo;
+    policyIds?: string[];
+    joinedAt?: Date | null;
+}
+export interface AccountInfo {
+    accountName?: string;
+    accountImage?: string;
+    isTeam?: boolean;
+}
+export interface SiteInvite {
+    /**
+     * Invite ID.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Site ID the user is invited to as a collaborator.
+     * @readonly
+     */
+    siteId?: string;
+    /** Email address where the invite was sent. */
+    email?: string;
+    /** Role IDs included in the invite. */
+    policyIds?: string[];
+    /**
+     * Deprecated. Use `inviterAccountId`.
+     * @readonly
+     * @deprecated
+     */
+    inviterId?: string;
+    /**
+     * Invite Status.
+     *
+     * Supported values:
+     * - **Pending:** The invite has been sent and is valid, waiting for the user's response.
+     * - **Used:** The invite has been accepted.
+     * - **Deleted:** The invite has been deleted or revoked.
+     * - **Declined:** The user declined the invite.
+     * - **Expired:** The invite has expired without being accepted.
+     */
+    status?: InviteStatus;
+    /** Link to accept the invite. */
+    acceptLink?: string;
+    /**
+     * Inviting account ID.
+     * @readonly
+     */
+    inviterAccountId?: string;
+    /**
+     * Account ID that accepted the invite. Populated only once the invite is accepted.
+     * @readonly
+     */
+    acceptedByAccountId?: string | null;
+    /** Date the invite was created. */
+    dateCreated?: Date | null;
+    /** User's Wix Bookings staff ID, if relevant. */
+    staffId?: string | null;
+    /** Invite expiration date */
+    expirationDate?: Date | null;
+    /**
+     * Location ids included in the invite
+     * @readonly
+     */
+    locationIds?: string[];
+}
+/** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */
+export declare enum InviteStatus {
+    Pending = "Pending",
+    Used = "Used",
+    Deleted = "Deleted",
+    Declined = "Declined",
+    Expired = "Expired"
+}
+export interface Policy {
+    _id?: string;
+    description?: string | null;
+    name?: string | null;
+    isCustom?: boolean;
+    scopes?: string[];
+}
+export interface PendingOwner {
+    email?: string;
+    expirationDate?: Date | null;
+    acceptLink?: string;
+}
+export interface ContributorLimit {
+    contributorLimit?: number;
+}
+export interface PredefinedRoles {
+    roles?: PredefinedRole[];
+}
+export interface PredefinedRole {
+    titleKey?: string;
+    roles?: Role[];
+    title?: string | null;
+    areaId?: string;
+}
+export interface Role {
+    _id?: string;
+    deprecatedKey?: string;
+    /** @deprecated */
+    titleKey?: string;
+    /** @deprecated */
+    descriptionKey?: string;
+    deprecated?: boolean;
+    restrictFromLevel?: string;
+    experiments?: string[];
+    appDefIds?: string[];
+    title?: string | null;
+    description?: string | null;
+    isCustom?: boolean;
+    scopes?: string[];
+    availableResourceTypes?: ResourceType[];
+    availableConditions?: ConditionAttributeType[];
+    limitToEditorTypes?: string[];
+}
+export interface GetSiteContributorsV2Request {
+    /** The locale of the request. Defaults to en-us. */
+    locale?: string | null;
+    /** The set of desired fields. */
+    fields?: string[];
+}
+export interface GetSiteContributorsV2Response {
+    /** List of contributors of the given site. */
+    contributors?: Contributor[];
+    /** List of invites to contribute to the given site. */
+    invites?: SiteInvite[];
+    /** Quota information for contributors on the given site. */
+    contributorsQuota?: ContributorsQuota;
+}
+export interface ContributorsQuota extends ContributorsQuotaOptionsOneOf {
+    /** Limited contributors quota details. */
+    limitedOptions?: LimitedOptions;
+    /** Type of contributors quota */
+    type?: Type;
+}
+/** @oneof */
+export interface ContributorsQuotaOptionsOneOf {
+    /** Limited contributors quota details. */
+    limitedOptions?: LimitedOptions;
+}
+/** Enum to represent different types of contributors quota. */
+export declare enum Type {
+    UNKNOWN = "UNKNOWN",
+    LIMITED = "LIMITED",
+    UNLIMITED = "UNLIMITED"
+}
+/** Details for a limited contributors quota. */
+export interface LimitedOptions {
+    /** Maximum number of contributors allowed. */
+    limit?: number;
+    /** Number of accepted or pending invitations. */
+    used?: number;
+}
+export interface HandleSiteTransferRequest {
+    originalOwnerAccountId?: string;
+    newOwnerAccountId?: string;
+    metaSiteId?: string;
+    keepOriginalOwnerAsContributor?: boolean;
+}
+export interface HandleSiteTransferResponse {
+}
+export interface GetCurrentUserRolesRequest {
+    /** The locale of the request. Defaults to en-us */
+    locale?: string | null;
+}
+export interface GetCurrentUserRolesResponse {
+    roles?: LocalizedRole[];
+}
+export interface LocalizedRole {
+    name?: string;
+    description?: string | null;
+}
+export interface BulkGetUserRolesOnSiteRequest {
+    users?: UserSubject[];
+    /** The locale of the request. Defaults to en-us */
+    locale?: string | null;
+}
+export interface UserSubject {
+    userId?: string;
+    accountId?: string;
+}
+export interface BulkGetUserRolesOnSiteResponse {
+    userRoles?: UserLocalizedRoles[];
+}
+export interface UserLocalizedRoles {
+    user?: UserSubject;
+    roles?: LocalizedRole[];
+}
+export interface BulkValidateEmailInviteEligibilityRequest {
+    /** List of emails to be checked for invite eligibility. */
+    emails?: string[];
+}
+export interface BulkValidateEmailInviteEligibilityResponse {
+    /** List of email invite eligibility results. */
+    emailsEligibility?: EmailInviteEligibility[];
+}
+export interface EmailInviteEligibility {
+    /** The email address being checked. */
+    email?: string;
+    /** Whether the email is eligible for an invite. */
+    eligible?: boolean;
+}
+export interface ChangeContributorRoleRequest {
+    /** Contributor's account ID. */
+    accountId: string;
+    /** New roles to assign to the contributor on the site. */
+    newRoles: SiteRoleAssignment[];
+}
+export interface SiteRoleAssignment {
+    /** Role ID. Sometimes referred to as policy ID. See [Roles and Permissions](https://support.wix.com/en/article/roles-permissions-overview) for a list of available roles. */
+    roleId?: string;
+    /**
+     * Assignment ID mapping the role to the contributor on the site.
+     * @readonly
+     */
+    assignmentId?: string;
+}
+export interface ChangeContributorRoleResponse {
+    /** New roles assigned to the contributor on the site. */
+    newAssignedRoles?: SiteRoleAssignment[];
+}
+export interface ChangeContributorLocationRequest {
+    /** Contributor's account ID. */
+    accountId: string;
+    /** New locations to assign to the contributor on the site. */
+    newLocations: string[];
+}
+export interface ChangeContributorLocationResponse {
+    /** New locations assigned to the contributor on the site. */
+    newAssignedLocations?: SiteLocationAssignment[];
+}
+export interface SiteLocationAssignment {
+    locationId?: string;
+    /** @readonly */
+    assignmentIds?: string[];
+}
+export interface QuerySiteContributorsRequest {
+    filter?: QuerySiteContributorsFilter;
+}
+export interface QuerySiteContributorsFilter {
+    /** Role IDs (referred to here as policy IDs) to return. See [Roles and Permissions](https://support.wix.com/en/article/roles-permissions-overview) for available roles. */
+    policyIds?: string[];
+}
+export declare enum FieldSet {
+    UNKNOWN = "UNKNOWN",
+    /** Include only `account_id` and `account_owner_id` fields. */
+    META_DATA = "META_DATA"
+}
+export interface QuerySiteContributorsResponse {
+    /** List of site contributors. */
+    contributors?: ContributorV2[];
+}
+export interface ContributorV2 {
+    /** Contributor's account ID. */
+    accountId?: string | null;
+    /** User ID of the owner of the account that the contributor has joined. */
+    accountOwnerId?: string | null;
+}
+export interface GetContributorsQuotaRequest {
+}
+export interface GetContributorsQuotaResponse {
+    /** Quota information for contributors on the given site. */
+    contributorsQuota?: ContributorsQuota;
+}
+interface AssignedPolicyNonNullableFields {
+    policyId: string;
+}
+interface ResourceNonNullableFields {
+    resourceType: ResourceType;
+    _id: string;
+}
+interface ConditionNonNullableFields {
+    conditionType: ConditionAttributeType;
+    _id: string;
+}
+interface ConditionsNonNullableFields {
+    conditions: ConditionNonNullableFields[];
+}
+interface CompanionResourceNonNullableFields {
+    _id: string;
+    resourceType: string;
+}
+interface SiteRestrictionNonNullableFields {
+    _id: string;
+    resource?: CompanionResourceNonNullableFields;
+}
+interface LocationsRestrictionNonNullableFields {
+    ids: string[];
+}
+interface RestrictionNonNullableFields {
+    resource?: ResourceNonNullableFields;
+    conditions?: ConditionsNonNullableFields;
+    site?: SiteRestrictionNonNullableFields;
+    locations?: LocationsRestrictionNonNullableFields;
+}
+interface SubjectContextNonNullableFields {
+    _id: string;
+    contextType: SubjectContextType;
+}
+interface SubjectNonNullableFields {
+    _id: string;
+    subjectType: SubjectType;
+    context?: SubjectContextNonNullableFields;
+}
+interface AssignmentNonNullableFields {
+    policy?: AssignedPolicyNonNullableFields;
+    assignmentId: string;
+    restrictions?: RestrictionNonNullableFields;
+    subject?: SubjectNonNullableFields;
+}
+interface PersonMetaDataNonNullableFields {
+    _id: string;
+    assignments: AssignmentNonNullableFields[];
+}
+interface ContributorNonNullableFields {
+    metaData?: PersonMetaDataNonNullableFields;
+    _id: string;
+}
+interface SiteInviteNonNullableFields {
+    _id: string;
+    siteId: string;
+    email: string;
+    policyIds: string[];
+    inviterId: string;
+    status: InviteStatus;
+    acceptLink: string;
+    inviterAccountId: string;
+    locationIds: string[];
+}
+interface LimitedOptionsNonNullableFields {
+    limit: number;
+    used: number;
+}
+interface ContributorsQuotaNonNullableFields {
+    limitedOptions?: LimitedOptionsNonNullableFields;
+    type: Type;
+}
+export interface GetSiteContributorsV2ResponseNonNullableFields {
+    contributors: ContributorNonNullableFields[];
+    invites: SiteInviteNonNullableFields[];
+    contributorsQuota?: ContributorsQuotaNonNullableFields;
+}
+interface SiteRoleAssignmentNonNullableFields {
+    roleId: string;
+    assignmentId: string;
+}
+export interface ChangeContributorRoleResponseNonNullableFields {
+    newAssignedRoles: SiteRoleAssignmentNonNullableFields[];
+}
+interface SiteLocationAssignmentNonNullableFields {
+    locationId: string;
+    assignmentIds: string[];
+}
+export interface ChangeContributorLocationResponseNonNullableFields {
+    newAssignedLocations: SiteLocationAssignmentNonNullableFields[];
+}
+export interface GetContributorsQuotaResponseNonNullableFields {
+    contributorsQuota?: ContributorsQuotaNonNullableFields;
+}
+/**
+ * returns a list of all the contributors + invites to be contributors of a given meta site ID taken from the
+ * context.
+ * @internal
+ * @documentationMaturity preview
+ * @permissionId site-users.view-users
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.roles.management.api.SiteRolesManagementService.GetSiteContributorsV2
+ */
+export declare function getSiteContributorsV2(options?: GetSiteContributorsV2Options): Promise<GetSiteContributorsV2Response & GetSiteContributorsV2ResponseNonNullableFields>;
+export interface GetSiteContributorsV2Options {
+    /** The locale of the request. Defaults to en-us. */
+    locale?: string | null;
+    /** The set of desired fields. */
+    fields?: string[];
+}
+/**
+ * Overrides all the roles of a contributor for the specified site.
+ * @param accountId - Contributor's account ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField accountId
+ * @requiredField options
+ * @requiredField options.newRoles
+ * @param options - Filter options. The `newRoles` field **must** be passed.
+ * @permissionId SITE_ROLES.CHANGE_ROLE
+ * @fqn com.wixpress.roles.management.api.SiteRolesManagementService.ChangeRole
+ */
+export declare function changeRole(accountId: string, options: ChangeRoleOptions): Promise<ChangeContributorRoleResponse & ChangeContributorRoleResponseNonNullableFields>;
+export interface ChangeRoleOptions {
+    /** New roles to assign to the contributor on the site. */
+    newRoles: SiteRoleAssignment[];
+}
+/** @param accountId - Contributor's account ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField accountId
+ * @requiredField options
+ * @requiredField options.newLocations
+ * @permissionId SITE_ROLES.CHANGE_LOCATION
+ * @fqn com.wixpress.roles.management.api.SiteRolesManagementService.ChangeContributorLocation
+ */
+export declare function changeContributorLocation(accountId: string, options: ChangeContributorLocationOptions): Promise<ChangeContributorLocationResponse & ChangeContributorLocationResponseNonNullableFields>;
+export interface ChangeContributorLocationOptions {
+    /** New locations to assign to the contributor on the site. */
+    newLocations: string[];
+}
+/**
+ * Retrieves a list of contributors for the specified site, given the provided filters.
+ * @public
+ * @documentationMaturity preview
+ * @param options - Filter options.
+ * @permissionId site-users.view-users
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.roles.management.api.SiteRolesManagementService.QuerySiteContributors
+ */
+export declare function querySiteContributors(options?: QuerySiteContributorsOptions): Promise<QuerySiteContributorsResponse>;
+export interface QuerySiteContributorsOptions {
+    filter?: QuerySiteContributorsFilter;
+}
+/**
+ * returns the quota information for contributors on the given site.
+ * @internal
+ * @documentationMaturity preview
+ * @permissionId site-users.view-users
+ * @permissionScope Manage Bookings Services and Settings
+ * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionScope Manage Portfolio
+ * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope Access Verticals by Automations
+ * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @applicableIdentity APP
+ * @fqn com.wixpress.roles.management.api.SiteRolesManagementService.GetContributorsQuota
+ */
+export declare function getContributorsQuota(): Promise<GetContributorsQuotaResponse & GetContributorsQuotaResponseNonNullableFields>;
+export {};