interface AccountInvite$1 { /** * Invite ID. * @readonly */ id?: string; /** * Account ID. * @readonly */ accountId?: string; /** Email address where the invite was sent. */ email?: string; /** * Deprecated. Use `policyIds`. * @deprecated */ role?: 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 has declined the invite. * - **Expired:** The invite has expired without being accepted. */ status?: InviteStatus$1; /** 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; /** Role IDs included in the invite. */ policyIds?: string[]; /** Date the invite was last updated. */ dateUpdated?: Date | null; /** Assets the users are invited to join. */ assignments?: InviteResourceAssignment$1[]; /** Invite expiration date. */ expirationDate?: Date | null; } /** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */ declare enum InviteStatus$1 { Pending = "Pending", Used = "Used", Deleted = "Deleted", Declined = "Declined", Expired = "Expired" } interface InviteResourceAssignment$1 { /** Role ID. */ policyId?: string; /** Resources the user will be able to access. */ assignments?: InviteAssignment$1[]; } interface InviteAssignment$1 { /** Full name of resource to be assigned. */ fullNameResource?: FullNameResource$1; } interface FullNameResource$1 extends FullNameResourceResourceContextOneOf$1 { /** Specific site details. */ siteContext?: SiteResourceContext$1; /** Specific account details. */ accountContext?: AccountResourceContext$1; } /** @oneof */ interface FullNameResourceResourceContextOneOf$1 { /** Specific site details. */ siteContext?: SiteResourceContext$1; /** Specific account details. */ accountContext?: AccountResourceContext$1; } /** Site resource context. It indicates that the resource is under a site (can be the site itself or some asset of a site, like a blog post) */ interface SiteResourceContext$1 { /** Site ID. */ metasiteId?: string; } /** Account resource contexts. It indicates that the resource is under the account (can be the account itself or some asset of an account, like a logo or a domain) */ interface AccountResourceContext$1 { /** Account ID. */ accountId?: string; } declare enum SimpleConditionOperator$1 { UNKNOWN_SIMPLE_OP = "UNKNOWN_SIMPLE_OP", EQUAL = "EQUAL" } declare enum JoinedConditionOperator$1 { UNKNOWN_JOIN_OP = "UNKNOWN_JOIN_OP", OR = "OR", AND = "AND" } declare enum SubjectType$1 { 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" } declare enum SubjectContextType$1 { UNKNOWN_CTX = "UNKNOWN_CTX", ORG_CTX = "ORG_CTX", ACCOUNT_CTX = "ACCOUNT_CTX" } interface CreateInviteRequest$1 { /** Array of potential team members' email addresses and their corresponding assignments (how they will be assigned when they accept the invite). */ subjectsAssignments: SubjectInviteAssignments$1[]; /** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */ defaultEmailLanguage?: string | null; } interface SubjectInviteAssignments$1 { /** Invitee's email address. */ subjectEmail?: string; /** Mapping of roles (referred to here as policies) and assets (referred to here as resources) that will be assigned to the invitee when they accept the invite. When no resources are specified, the invitee will be given access to everything within the account. */ assignments?: InviteResourceAssignment$1[]; } interface CreateInviteResponse$1 { /** Invites that were sent successfully. */ successfulInvites?: AccountInvite$1[]; /** Invites that failed. */ failedInvites?: InviteFailure$1[]; } interface InviteFailure$1 { /** Email address of the failed invite. */ subjectEmail?: string; /** Error description. */ errorMessage?: string; } interface SiteResourceContextNonNullableFields$1 { metasiteId: string; } interface AccountResourceContextNonNullableFields$1 { accountId: string; } interface FullNameResourceNonNullableFields$1 { siteContext?: SiteResourceContextNonNullableFields$1; accountContext?: AccountResourceContextNonNullableFields$1; } interface SimpleConditionValueNonNullableFields$1 { attrName: string; stringValue: string; boolValue: boolean; } interface SimpleConditionNonNullableFields$1 { attrName: string; value?: SimpleConditionValueNonNullableFields$1; op: SimpleConditionOperator$1; conditionModelId: string; } interface JoinedConditionNonNullableFields$1 { op: JoinedConditionOperator$1; conditions: ConditionTypeNonNullableFields$1[]; } interface ExperimentConditionNonNullableFields$1 { spec: string; fallbackValue: string; expectedValue: string; } interface EnvironmentConditionNonNullableFields$1 { experimentCondition?: ExperimentConditionNonNullableFields$1; } interface ConditionValueNonNullableFields$1 { attrName: string; stringValue: string; boolValue: boolean; } interface EqualOperatorNonNullableFields$1 { attrName: string; value?: ConditionValueNonNullableFields$1; } interface LikeOperatorNonNullableFields$1 { attrName: string; values: string[]; } interface ExperimentOperatorNonNullableFields$1 { spec: string; fallbackValue: string; expectedValue: string; } interface SubjectContextNonNullableFields$1 { id: string; contextType: SubjectContextType$1; } interface SubjectNonNullableFields$1 { id: string; subjectType: SubjectType$1; context?: SubjectContextNonNullableFields$1; } interface DependOnOperatorNonNullableFields$1 { dependOnSubject?: SubjectNonNullableFields$1; } interface ConditionOperatorNonNullableFields$1 { equals?: EqualOperatorNonNullableFields$1; like?: LikeOperatorNonNullableFields$1; experiment?: ExperimentOperatorNonNullableFields$1; dependOn?: DependOnOperatorNonNullableFields$1; } interface ConditionNonNullableFields$1 { conditionModelId: string; operator?: ConditionOperatorNonNullableFields$1; } interface ConditionTypeNonNullableFields$1 { simpleCondition?: SimpleConditionNonNullableFields$1; joinedConditions?: JoinedConditionNonNullableFields$1; environmentCondition?: EnvironmentConditionNonNullableFields$1; condition?: ConditionNonNullableFields$1; } interface PolicyConditionNonNullableFields$1 { condition?: ConditionTypeNonNullableFields$1; } interface InviteAssignmentNonNullableFields$1 { fullNameResource?: FullNameResourceNonNullableFields$1; condition?: PolicyConditionNonNullableFields$1; } interface InviteResourceAssignmentNonNullableFields$1 { policyId: string; assignments: InviteAssignmentNonNullableFields$1[]; } interface AccountInviteNonNullableFields$1 { id: string; accountId: string; email: string; role: string; inviterId: string; status: InviteStatus$1; acceptLink: string; inviterAccountId: string; policyIds: string[]; assignments: InviteResourceAssignmentNonNullableFields$1[]; } interface InviteFailureNonNullableFields$1 { subjectEmail: string; errorMessage: string; } interface CreateInviteResponseNonNullableFields$1 { successfulInvites: AccountInviteNonNullableFields$1[]; failedInvites: InviteFailureNonNullableFields$1[]; } interface AccountInvite { /** * Invite ID. * @readonly */ _id?: string; /** * Account ID. * @readonly */ accountId?: string; /** Email address where the invite was sent. */ email?: string; /** * Deprecated. Use `policyIds`. * @deprecated */ role?: 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 has 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; /** Role IDs included in the invite. */ policyIds?: string[]; /** Date the invite was last updated. */ dateUpdated?: Date | null; /** Assets the users are invited to join. */ assignments?: InviteResourceAssignment[]; /** Invite expiration date. */ expirationDate?: Date | null; } /** Invite status stating whether the invite was accepted, waiting to be accepted, deleted etc.. */ declare enum InviteStatus { Pending = "Pending", Used = "Used", Deleted = "Deleted", Declined = "Declined", Expired = "Expired" } interface InviteResourceAssignment { /** Role ID. */ policyId?: string; /** Resources the user will be able to access. */ assignments?: InviteAssignment[]; } interface InviteAssignment { /** Full name of resource to be assigned. */ fullNameResource?: FullNameResource; } interface FullNameResource extends FullNameResourceResourceContextOneOf { /** Specific site details. */ siteContext?: SiteResourceContext; /** Specific account details. */ accountContext?: AccountResourceContext; } /** @oneof */ interface FullNameResourceResourceContextOneOf { /** Specific site details. */ siteContext?: SiteResourceContext; /** Specific account details. */ accountContext?: AccountResourceContext; } /** Site resource context. It indicates that the resource is under a site (can be the site itself or some asset of a site, like a blog post) */ interface SiteResourceContext { /** Site ID. */ metasiteId?: string; } /** Account resource contexts. It indicates that the resource is under the account (can be the account itself or some asset of an account, like a logo or a domain) */ interface AccountResourceContext { /** Account ID. */ accountId?: string; } declare enum SimpleConditionOperator { UNKNOWN_SIMPLE_OP = "UNKNOWN_SIMPLE_OP", EQUAL = "EQUAL" } declare enum JoinedConditionOperator { UNKNOWN_JOIN_OP = "UNKNOWN_JOIN_OP", OR = "OR", AND = "AND" } 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" } declare enum SubjectContextType { UNKNOWN_CTX = "UNKNOWN_CTX", ORG_CTX = "ORG_CTX", ACCOUNT_CTX = "ACCOUNT_CTX" } interface CreateInviteRequest { /** Array of potential team members' email addresses and their corresponding assignments (how they will be assigned when they accept the invite). */ subjectsAssignments: SubjectInviteAssignments[]; /** Language of emails to send. Relevant only for recipients that don't currently have a Wix user ID. Default: Site owner's language. */ defaultEmailLanguage?: string | null; } interface SubjectInviteAssignments { /** Invitee's email address. */ subjectEmail?: string; /** Mapping of roles (referred to here as policies) and assets (referred to here as resources) that will be assigned to the invitee when they accept the invite. When no resources are specified, the invitee will be given access to everything within the account. */ assignments?: InviteResourceAssignment[]; } interface CreateInviteResponse { /** Invites that were sent successfully. */ successfulInvites?: AccountInvite[]; /** Invites that failed. */ failedInvites?: InviteFailure[]; } interface InviteFailure { /** Email address of the failed invite. */ subjectEmail?: string; /** Error description. */ errorMessage?: string; } interface SiteResourceContextNonNullableFields { metasiteId: string; } interface AccountResourceContextNonNullableFields { accountId: string; } interface FullNameResourceNonNullableFields { siteContext?: SiteResourceContextNonNullableFields; accountContext?: AccountResourceContextNonNullableFields; } interface SimpleConditionValueNonNullableFields { attrName: string; stringValue: string; boolValue: boolean; } interface SimpleConditionNonNullableFields { attrName: string; value?: SimpleConditionValueNonNullableFields; op: SimpleConditionOperator; conditionModelId: string; } interface JoinedConditionNonNullableFields { op: JoinedConditionOperator; conditions: ConditionTypeNonNullableFields[]; } interface ExperimentConditionNonNullableFields { spec: string; fallbackValue: string; expectedValue: string; } interface EnvironmentConditionNonNullableFields { experimentCondition?: ExperimentConditionNonNullableFields; } interface ConditionValueNonNullableFields { attrName: string; stringValue: string; boolValue: boolean; } interface EqualOperatorNonNullableFields { attrName: string; value?: ConditionValueNonNullableFields; } interface LikeOperatorNonNullableFields { attrName: string; values: string[]; } interface ExperimentOperatorNonNullableFields { spec: string; fallbackValue: string; expectedValue: string; } interface SubjectContextNonNullableFields { _id: string; contextType: SubjectContextType; } interface SubjectNonNullableFields { _id: string; subjectType: SubjectType; context?: SubjectContextNonNullableFields; } interface DependOnOperatorNonNullableFields { dependOnSubject?: SubjectNonNullableFields; } interface ConditionOperatorNonNullableFields { equals?: EqualOperatorNonNullableFields; like?: LikeOperatorNonNullableFields; experiment?: ExperimentOperatorNonNullableFields; dependOn?: DependOnOperatorNonNullableFields; } interface ConditionNonNullableFields { conditionModelId: string; operator?: ConditionOperatorNonNullableFields; } interface ConditionTypeNonNullableFields { simpleCondition?: SimpleConditionNonNullableFields; joinedConditions?: JoinedConditionNonNullableFields; environmentCondition?: EnvironmentConditionNonNullableFields; condition?: ConditionNonNullableFields; } interface PolicyConditionNonNullableFields { condition?: ConditionTypeNonNullableFields; } interface InviteAssignmentNonNullableFields { fullNameResource?: FullNameResourceNonNullableFields; condition?: PolicyConditionNonNullableFields; } interface InviteResourceAssignmentNonNullableFields { policyId: string; assignments: InviteAssignmentNonNullableFields[]; } interface AccountInviteNonNullableFields { _id: string; accountId: string; email: string; role: string; inviterId: string; status: InviteStatus; acceptLink: string; inviterAccountId: string; policyIds: string[]; assignments: InviteResourceAssignmentNonNullableFields[]; } interface InviteFailureNonNullableFields { subjectEmail: string; errorMessage: string; } interface CreateInviteResponseNonNullableFields { successfulInvites: AccountInviteNonNullableFields[]; failedInvites: InviteFailureNonNullableFields[]; } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function createInvite(): __PublicMethodMetaInfo<'POST', {}, CreateInviteRequest, CreateInviteRequest$1, CreateInviteResponse & CreateInviteResponseNonNullableFields, CreateInviteResponse$1 & CreateInviteResponseNonNullableFields$1>; export { type __PublicMethodMetaInfo, createInvite };