@wix/user-management 1.0.0

package/type-bundles/index.bundle.d.ts

@@ -0,0 +1,909 @@
+type HostModule<T, H extends Host> = {
+    __type: 'host';
+    create(host: H): T;
+};
+type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
+type Host<Environment = unknown> = {
+    channel: {
+        observeState(callback: (props: unknown, environment: Environment) => unknown): {
+            disconnect: () => void;
+        } | Promise<{
+            disconnect: () => void;
+        }>;
+    };
+    environment?: Environment;
+    /**
+     * Optional name of the environment, use for logging
+     */
+    name?: string;
+    /**
+     * Optional bast url to use for API requests, for example `www.wixapis.com`
+     */
+    apiBaseUrl?: string;
+    /**
+     * Possible data to be provided by every host, for cross cutting concerns
+     * like internationalization, billing, etc.
+     */
+    essentials?: {
+        /**
+         * The language of the currently viewed session
+         */
+        language?: string;
+        /**
+         * The locale of the currently viewed session
+         */
+        locale?: string;
+        /**
+         * Any headers that should be passed through to the API requests
+         */
+        passThroughHeaders?: Record<string, string>;
+    };
+};
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+    getActiveToken?: () => string | undefined;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+type ServicePluginMethodInput = {
+    request: any;
+    metadata: any;
+};
+type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata = {
+    name: string;
+    primaryHttpMappingPath: string;
+    transformations: {
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
+        toREST: (...args: unknown[]) => unknown;
+    };
+};
+type ServicePluginDefinition<Contract extends ServicePluginContract> = {
+    __type: 'service-plugin-definition';
+    componentType: string;
+    methods: ServicePluginMethodMetadata[];
+    __contract: Contract;
+};
+declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
+type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
+declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
+
+type RequestContext = {
+    isSSR: boolean;
+    host: string;
+    protocol?: string;
+};
+type ResponseTransformer = (data: any, headers?: any) => any;
+/**
+ * Ambassador request options types are copied mostly from AxiosRequestConfig.
+ * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
+ * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
+ */
+type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
+type AmbassadorRequestOptions<T = any> = {
+    _?: T;
+    url?: string;
+    method?: Method;
+    params?: any;
+    data?: any;
+    transformResponse?: ResponseTransformer | ResponseTransformer[];
+};
+type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
+    __isAmbassador: boolean;
+};
+type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
+type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare const emptyObjectSymbol: unique symbol;
+
+/**
+Represents a strictly empty plain object, the `{}` value.
+
+When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
+
+@example
+```
+import type {EmptyObject} from 'type-fest';
+
+// The following illustrates the problem with `{}`.
+const foo1: {} = {}; // Pass
+const foo2: {} = []; // Pass
+const foo3: {} = 42; // Pass
+const foo4: {} = {a: 1}; // Pass
+
+// With `EmptyObject` only the first case is valid.
+const bar1: EmptyObject = {}; // Pass
+const bar2: EmptyObject = 42; // Fail
+const bar3: EmptyObject = []; // Fail
+const bar4: EmptyObject = {a: 1}; // Fail
+```
+
+Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
+
+@category Object
+*/
+type EmptyObject = {[emptyObjectSymbol]?: never};
+
+/**
+Returns a boolean for whether the two given types are equal.
+
+@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
+@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
+
+Use-cases:
+- If you want to make a conditional branch based on the result of a comparison of two types.
+
+@example
+```
+import type {IsEqual} from 'type-fest';
+
+// This type returns a boolean for whether the given array includes the given item.
+// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
+type Includes<Value extends readonly any[], Item> =
+	Value extends readonly [Value[0], ...infer rest]
+		? IsEqual<Value[0], Item> extends true
+			? true
+			: Includes<rest, Item>
+		: false;
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsEqual<A, B> =
+	(<G>() => G extends A ? 1 : 2) extends
+	(<G>() => G extends B ? 1 : 2)
+		? true
+		: false;
+
+/**
+Filter out keys from an object.
+
+Returns `never` if `Exclude` is strictly equal to `Key`.
+Returns `never` if `Key` extends `Exclude`.
+Returns `Key` otherwise.
+
+@example
+```
+type Filtered = Filter<'foo', 'foo'>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', string>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', 'foo'>;
+//=> 'bar'
+```
+
+@see {Except}
+*/
+type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
+
+type ExceptOptions = {
+	/**
+	Disallow assigning non-specified properties.
+
+	Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
+
+	@default false
+	*/
+	requireExactProps?: boolean;
+};
+
+/**
+Create a type from an object type without certain keys.
+
+We recommend setting the `requireExactProps` option to `true`.
+
+This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
+
+This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
+
+@example
+```
+import type {Except} from 'type-fest';
+
+type Foo = {
+	a: number;
+	b: string;
+};
+
+type FooWithoutA = Except<Foo, 'a'>;
+//=> {b: string}
+
+const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
+//=> errors: 'a' does not exist in type '{ b: string; }'
+
+type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
+//=> {a: number} & Partial<Record<"b", never>>
+
+const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
+//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
+```
+
+@category Object
+*/
+type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
+	[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
+} & (Options['requireExactProps'] extends true
+	? Partial<Record<KeysType, never>>
+	: {});
+
+/**
+Returns a boolean for whether the given type is `never`.
+
+@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
+@link https://stackoverflow.com/a/53984913/10292952
+@link https://www.zhenghao.io/posts/ts-never
+
+Useful in type utilities, such as checking if something does not occur.
+
+@example
+```
+import type {IsNever, And} from 'type-fest';
+
+// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
+type AreStringsEqual<A extends string, B extends string> =
+	And<
+		IsNever<Exclude<A, B>> extends true ? true : false,
+		IsNever<Exclude<B, A>> extends true ? true : false
+	>;
+
+type EndIfEqual<I extends string, O extends string> =
+	AreStringsEqual<I, O> extends true
+		? never
+		: void;
+
+function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
+	if (input === output) {
+		process.exit(0);
+	}
+}
+
+endIfEqual('abc', 'abc');
+//=> never
+
+endIfEqual('abc', '123');
+//=> void
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsNever<T> = [T] extends [never] ? true : false;
+
+/**
+An if-else-like type that resolves depending on whether the given type is `never`.
+
+@see {@link IsNever}
+
+@example
+```
+import type {IfNever} from 'type-fest';
+
+type ShouldBeTrue = IfNever<never>;
+//=> true
+
+type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
+//=> 'bar'
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
+	IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
+);
+
+/**
+Extract the keys from a type where the value type of the key extends the given `Condition`.
+
+Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
+
+@example
+```
+import type {ConditionalKeys} from 'type-fest';
+
+interface Example {
+	a: string;
+	b: string | number;
+	c?: string;
+	d: {};
+}
+
+type StringKeysOnly = ConditionalKeys<Example, string>;
+//=> 'a'
+```
+
+To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
+
+@example
+```
+import type {ConditionalKeys} from 'type-fest';
+
+type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
+//=> 'a' | 'c'
+```
+
+@category Object
+*/
+type ConditionalKeys<Base, Condition> =
+{
+	// Map through all the keys of the given base type.
+	[Key in keyof Base]-?:
+	// Pick only keys with types extending the given `Condition` type.
+	Base[Key] extends Condition
+	// Retain this key
+	// If the value for the key extends never, only include it if `Condition` also extends never
+		? IfNever<Base[Key], IfNever<Condition, Key, never>, Key>
+	// Discard this key since the condition fails.
+		: never;
+	// Convert the produced object into a union type of the keys which passed the conditional test.
+}[keyof Base];
+
+/**
+Exclude keys from a shape that matches the given `Condition`.
+
+This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
+
+@example
+```
+import type {Primitive, ConditionalExcept} from 'type-fest';
+
+class Awesome {
+	name: string;
+	successes: number;
+	failures: bigint;
+
+	run() {}
+}
+
+type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
+//=> {run: () => void}
+```
+
+@example
+```
+import type {ConditionalExcept} from 'type-fest';
+
+interface Example {
+	a: string;
+	b: string | number;
+	c: () => void;
+	d: {};
+}
+
+type NonStringKeysOnly = ConditionalExcept<Example, string>;
+//=> {b: string | number; c: () => void; d: {}}
+```
+
+@category Object
+*/
+type ConditionalExcept<Base, Condition> = Except<
+Base,
+ConditionalKeys<Base, Condition>
+>;
+
+/**
+ * Descriptors are objects that describe the API of a module, and the module
+ * can either be a REST module or a host module.
+ * This type is recursive, so it can describe nested modules.
+ */
+type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
+    [key: string]: Descriptors | PublicMetadata | any;
+};
+/**
+ * This type takes in a descriptors object of a certain Host (including an `unknown` host)
+ * and returns an object with the same structure, but with all descriptors replaced with their API.
+ * Any non-descriptor properties are removed from the returned object, including descriptors that
+ * do not match the given host (as they will not work with the given host).
+ */
+type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
+    done: T;
+    recurse: T extends {
+        __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
+    } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
+        [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
+            -1,
+            0,
+            1,
+            2,
+            3,
+            4,
+            5
+        ][Depth]> : never;
+    }, EmptyObject>;
+}[Depth extends -1 ? 'done' : 'recurse'];
+type PublicMetadata = {
+    PACKAGE_NAME?: string;
+};
+
+declare global {
+    interface ContextualClient {
+    }
+}
+/**
+ * A type used to create concerete types from SDK descriptors in
+ * case a contextual client is available.
+ */
+type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
+    host: Host;
+} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
+
+interface AccountV2 {
+    /** Account ID. */
+    accountId?: string;
+}
+interface GetUserAccountRequest {
+    /** the user id that his account we query */
+    userId?: string;
+}
+interface Account {
+    /** Account ID. */
+    accountId?: string;
+    /** Account slug - used in the free URL prefix */
+    slug?: string;
+    /** Account name (display) */
+    accountName?: string | null;
+    /**
+     * DEPRECATED field of account image
+     * @deprecated
+     */
+    accountImg?: string | null;
+    /** account status */
+    status?: AccountStatus;
+    /** account owner user id */
+    accountOwner?: string;
+    /** account extra properties */
+    accountProperties?: AccountProperties;
+    /** the account creation date */
+    dateCreated?: Date | null;
+    /** last time account was updated */
+    dateUpdated?: Date | null;
+}
+/** enum with all available statuses of account */
+declare enum AccountStatus {
+    ACTIVE = "ACTIVE",
+    BLOCKED = "BLOCKED",
+    DELETED = "DELETED"
+}
+/** All relevant account properties */
+interface AccountProperties {
+    /** Whether this account is a team account. */
+    isTeam?: boolean;
+    /**
+     * Account image (display)
+     * relevant mainly for CoBranded accounts
+     */
+    accountImg?: string | null;
+    /**
+     * the account banner (display)
+     * relevant mainly for CoBranded accounts
+     */
+    accountBanner?: string | null;
+    /**
+     * the account logo (display)
+     * wll be shown as the account logo in the UI (top right corner, contributor list etc..)
+     */
+    accountLogo?: string | null;
+    /**
+     * account co branding flag (if exists)
+     * an enum for CoBranding flag contains 4 possible options:
+     * None - the account is not CoBranded
+     * CoBranded - the account has a CoBranding flag
+     * CoBranded_Customer_New - the account is a contributor of a CoBranded account. This account was created because of the contributor invite
+     * CoBranded_Customer_Existing - the account is a contributor of a CoBranded account. This account was created before the invite of the contributor invite
+     */
+    coBranding?: CoBranding;
+    /** account's website URL (shown on co branding customers sites) */
+    websiteUrl?: string | null;
+    /** the id of the parent account of this account, if it has a parent */
+    parentAccountId?: string | null;
+}
+/** co branding flag options for account */
+declare enum CoBranding {
+    None = "None",
+    CoBranded = "CoBranded",
+    CoBranded_Customer_New = "CoBranded_Customer_New",
+    CoBranded_Customer_Existing = "CoBranded_Customer_Existing"
+}
+interface GetUserAccountsRequest {
+    /** the user id that his accounts we query */
+    userId?: string;
+    /** Limited to max 20 at a single request */
+    paging?: Paging;
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface AccountsResponse {
+    accounts?: Account[];
+}
+interface GetMyUserAccountsRequest {
+    /** Limited to max 20 at a single request */
+    paging?: Paging;
+}
+interface GetAccountRequest {
+    /** the account id that it's data should be retrieved */
+    accountId?: string;
+}
+interface AccountResponse {
+    account?: Account;
+}
+interface GetMyAccountRequest {
+}
+interface GetAccountsRequest {
+    /** the account id to retrieve */
+    accountIds?: string[];
+}
+interface CreateAccountRequest {
+    /** The user to create under the new account, with the roles defined in `roles`. */
+    user: User;
+    /**
+     * Roles to be assigned to the user in the new account. To retrieve all available roles, call Get Roles Info in the Users API.
+     * Default: OWNER.
+     */
+    roles?: string[] | null;
+}
+/** A User to be created under an implicitly provided accountId: must have a unique email. */
+interface User {
+    /** User's unique email address details. Required. */
+    email?: Email;
+    /** User's single sign on identity, when the user is identified via SSO authentication response token params, as specified by [OpenID Connect](https://openid.net/developers/how-connect-works/) (aka. OIDC) protocol. */
+    ssoIdentities?: SsoIdentity[];
+    /** Additional user details. */
+    userDetails?: UserDetails;
+}
+/** User's email address. */
+interface Email {
+    /** User's email address. */
+    emailAddress?: string;
+    /** Whether the caller has verified the user's email address. */
+    isVerified?: boolean;
+}
+/** Single Sign On (aka. SSO) identity; user is identified via SSO authentication response token params, as specified by OpenID Connect (aka. OIDC) protocol */
+interface SsoIdentity {
+    /** An SSO setting (URLs, clientId, secret, etc. as required by OIDC protocol) for a specific Identity-Provider (aka. IdP) for a specific Wix account. */
+    ssoId?: string;
+    /**
+     * User ID as stored in IdP. For example a "sub" claim of OIDC protocol,
+     * or any other alternative, specified by IdP (Identity Provider).
+     */
+    userId?: string;
+}
+/** additional user details */
+interface UserDetails {
+    /** User's first name. */
+    firstName?: string | null;
+    /** User's last name. */
+    lastName?: string | null;
+    /** URL to location of user's profile picture. */
+    profilePictureUrl?: string | null;
+    /** User's preferred language in [ISO 639-1:2002](https://en.wikipedia.org/wiki/ISO_639-1) format. For example, "en", "es". */
+    language?: string | null;
+    /**
+     * Original Client IP from which a request was made.
+     * This is useful in case where a createUser API is called by some server call, which, in turn, has been called by some client from another IP.
+     * Wix checks this IP against the [OFAC sanctioned countries](https://ofac.treasury.gov/sanctions-programs-and-country-information).
+     */
+    clientIp?: string | null;
+}
+interface CreateAccountResponse {
+    /** The created account. */
+    account?: AccountV2;
+}
+interface CreateAccountForMyUserRequest {
+    /** the account name */
+    accountName?: string | null;
+    /** account image url */
+    accountImg?: string | null;
+    /** whether to mark the account as `studio` */
+    studio?: boolean;
+}
+interface CreateAccountTenantRequest {
+    slug?: string | null;
+}
+interface CreateAccountTenantResponse {
+    account?: AccountV2;
+}
+interface CreateAccountAndAssignUserRequest {
+    /** the user id for which we are creating the account */
+    userId?: string;
+    /** the user name of the user for which the account is created */
+    userName?: string;
+    /** the parent account of the created account */
+    parentAccountId?: string | null;
+    /** whether to mark the account as `studio` */
+    studio?: boolean;
+}
+interface UpdateAccountRequest {
+    /** the account id to update */
+    accountId?: string;
+    /**
+     * DEPRECATED field of image
+     * @deprecated
+     */
+    accountImg?: string | null;
+    /** optional - new account name */
+    accountName?: string | null;
+    /**
+     * the new properties for the account.
+     * can be passed partially - and only relevant fields will be updated
+     */
+    accountProperties?: AccountProperties;
+}
+interface UpdateParentAccountRequest extends UpdateParentAccountRequestUpdateOneOf {
+    /** Removes the parent account */
+    remove?: RemoveParent;
+}
+/** @oneof */
+interface UpdateParentAccountRequestUpdateOneOf {
+    /** Removes the parent account */
+    remove?: RemoveParent;
+}
+interface RemoveParent {
+}
+interface UpdateParentAccountResponse {
+    newParentAccountId?: string | null;
+}
+interface DeleteAccountRequest {
+    /** the account id to delete */
+    accountId?: string;
+    /** will throw exception if trying to delete the account of the last user when the value is true */
+    shouldNotDeleteLastAccount?: boolean;
+}
+interface EmptyResponse {
+}
+interface UpdateSlugRequest {
+    /** account id */
+    accountId?: string;
+    /** new slug */
+    newSlugName?: string;
+}
+interface IsTeamRequest {
+    /** the account id to check if it's a team account */
+    accountId?: string;
+}
+interface IsTeamResponse {
+    /** true if the account is marked as a team account, false if not */
+    isTeamAccount?: boolean;
+}
+interface MarkAccountFlagRequest extends MarkAccountFlagRequestFlagOneOf {
+    /**
+     * account co branding flag (if exists)
+     * an enum for CoBranding flag contains 4 possible options:
+     * None - the account is not CoBranded
+     * CoBranded - the account has a CoBranding flag
+     * CoBranded_Customer_New - the account is a contributor of a CoBranded account. This account was created because of the contributor invite
+     * CoBranded_Customer_Existing - the account is a contributor of a CoBranded account. This account was created before the invite of the contributor invite
+     */
+    coBranding?: CoBranding;
+    /** the account id to mark */
+    accountId?: string;
+    /** the inviting account id in case the flag is given by an invite */
+    invitedByAccountId?: string | null;
+}
+/** @oneof */
+interface MarkAccountFlagRequestFlagOneOf {
+    /**
+     * account co branding flag (if exists)
+     * an enum for CoBranding flag contains 4 possible options:
+     * None - the account is not CoBranded
+     * CoBranded - the account has a CoBranding flag
+     * CoBranded_Customer_New - the account is a contributor of a CoBranded account. This account was created because of the contributor invite
+     * CoBranded_Customer_Existing - the account is a contributor of a CoBranded account. This account was created before the invite of the contributor invite
+     */
+    coBranding?: CoBranding;
+}
+interface GetParentAccountInfoRequest {
+}
+interface GetParentAccountInfoResponse {
+    /** The info of the parent account, if the account has a parent */
+    parentAccountInfo?: AccountInfo;
+}
+interface AccountInfo {
+    /** The name of the account */
+    name?: string | null;
+    /** The url of the image of the account */
+    image?: string | null;
+}
+interface GetSubAccountsRequest {
+    /** Offset-based pagination for the response. Default page size is 20, max page size is 50 */
+    paging?: Paging;
+}
+interface GetSubAccountsResponse {
+    /** The sub accounts of the target account */
+    subAccounts?: SubAccountInfo[];
+    /** Metadata of the response pagination */
+    pagingMetadata?: PagingMetadata;
+}
+interface SubAccountInfo {
+    /** The id of the sub account */
+    accountId?: string;
+}
+interface PagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+interface ListChildAccountsRequest {
+    /**
+     * Paging options to limit and offset the number of items.
+     * Default: 20. Max: 50.
+     */
+    paging?: Paging;
+}
+interface ListChildAccountsResponse {
+    /** The requested child accounts. */
+    childAccounts?: AccountV2[];
+    /** Metadata of the response pagination. */
+    pagingMetadata?: PagingMetadata;
+}
+interface SetIsReadOnlyAccountRequest {
+    accountId?: string;
+    isReadOnly?: boolean;
+}
+interface AccountV2NonNullableFields {
+    accountId: string;
+}
+interface CreateAccountResponseNonNullableFields {
+    account?: AccountV2NonNullableFields;
+}
+interface ListChildAccountsResponseNonNullableFields {
+    childAccounts: AccountV2NonNullableFields[];
+}
+interface CreateAccountOptions {
+    /**
+     * Roles to be assigned to the user in the new account. To retrieve all available roles, call Get Roles Info in the Users API.
+     * Default: OWNER.
+     */
+    roles?: string[] | null;
+}
+interface ListChildAccountsOptions {
+    /**
+     * Paging options to limit and offset the number of items.
+     * Default: 20. Max: 50.
+     */
+    paging?: Paging;
+}
+
+declare function createAccount$1(httpClient: HttpClient): CreateAccountSignature;
+interface CreateAccountSignature {
+    /**
+     * Creates a new Wix account, and creates a new Wix user as the account owner.
+     * The newly created account is a child account of the account used to create it, making that account its parent.
+     *
+     * > **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 - The user to create under the new account, with the roles defined in `roles`.
+     * @param - Filter options.
+     */
+    (user: User, options?: CreateAccountOptions | undefined): Promise<CreateAccountResponse & CreateAccountResponseNonNullableFields>;
+}
+declare function listChildAccounts$1(httpClient: HttpClient): ListChildAccountsSignature;
+interface ListChildAccountsSignature {
+    /**
+     * Retrieves a list of child account IDs for the requesting account.
+     * If no child accounts exist, an empty list will be returned.
+     *
+     * > **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?: ListChildAccountsOptions | undefined): Promise<ListChildAccountsResponse & ListChildAccountsResponseNonNullableFields>;
+}
+
+declare const createAccount: MaybeContext<BuildRESTFunction<typeof createAccount$1> & typeof createAccount$1>;
+declare const listChildAccounts: MaybeContext<BuildRESTFunction<typeof listChildAccounts$1> & typeof listChildAccounts$1>;
+
+type index_d_Account = Account;
+type index_d_AccountInfo = AccountInfo;
+type index_d_AccountProperties = AccountProperties;
+type index_d_AccountResponse = AccountResponse;
+type index_d_AccountStatus = AccountStatus;
+declare const index_d_AccountStatus: typeof AccountStatus;
+type index_d_AccountV2 = AccountV2;
+type index_d_AccountsResponse = AccountsResponse;
+type index_d_CoBranding = CoBranding;
+declare const index_d_CoBranding: typeof CoBranding;
+type index_d_CreateAccountAndAssignUserRequest = CreateAccountAndAssignUserRequest;
+type index_d_CreateAccountForMyUserRequest = CreateAccountForMyUserRequest;
+type index_d_CreateAccountOptions = CreateAccountOptions;
+type index_d_CreateAccountRequest = CreateAccountRequest;
+type index_d_CreateAccountResponse = CreateAccountResponse;
+type index_d_CreateAccountResponseNonNullableFields = CreateAccountResponseNonNullableFields;
+type index_d_CreateAccountTenantRequest = CreateAccountTenantRequest;
+type index_d_CreateAccountTenantResponse = CreateAccountTenantResponse;
+type index_d_DeleteAccountRequest = DeleteAccountRequest;
+type index_d_Email = Email;
+type index_d_EmptyResponse = EmptyResponse;
+type index_d_GetAccountRequest = GetAccountRequest;
+type index_d_GetAccountsRequest = GetAccountsRequest;
+type index_d_GetMyAccountRequest = GetMyAccountRequest;
+type index_d_GetMyUserAccountsRequest = GetMyUserAccountsRequest;
+type index_d_GetParentAccountInfoRequest = GetParentAccountInfoRequest;
+type index_d_GetParentAccountInfoResponse = GetParentAccountInfoResponse;
+type index_d_GetSubAccountsRequest = GetSubAccountsRequest;
+type index_d_GetSubAccountsResponse = GetSubAccountsResponse;
+type index_d_GetUserAccountRequest = GetUserAccountRequest;
+type index_d_GetUserAccountsRequest = GetUserAccountsRequest;
+type index_d_IsTeamRequest = IsTeamRequest;
+type index_d_IsTeamResponse = IsTeamResponse;
+type index_d_ListChildAccountsOptions = ListChildAccountsOptions;
+type index_d_ListChildAccountsRequest = ListChildAccountsRequest;
+type index_d_ListChildAccountsResponse = ListChildAccountsResponse;
+type index_d_ListChildAccountsResponseNonNullableFields = ListChildAccountsResponseNonNullableFields;
+type index_d_MarkAccountFlagRequest = MarkAccountFlagRequest;
+type index_d_MarkAccountFlagRequestFlagOneOf = MarkAccountFlagRequestFlagOneOf;
+type index_d_Paging = Paging;
+type index_d_PagingMetadata = PagingMetadata;
+type index_d_RemoveParent = RemoveParent;
+type index_d_SetIsReadOnlyAccountRequest = SetIsReadOnlyAccountRequest;
+type index_d_SsoIdentity = SsoIdentity;
+type index_d_SubAccountInfo = SubAccountInfo;
+type index_d_UpdateAccountRequest = UpdateAccountRequest;
+type index_d_UpdateParentAccountRequest = UpdateParentAccountRequest;
+type index_d_UpdateParentAccountRequestUpdateOneOf = UpdateParentAccountRequestUpdateOneOf;
+type index_d_UpdateParentAccountResponse = UpdateParentAccountResponse;
+type index_d_UpdateSlugRequest = UpdateSlugRequest;
+type index_d_User = User;
+type index_d_UserDetails = UserDetails;
+declare const index_d_createAccount: typeof createAccount;
+declare const index_d_listChildAccounts: typeof listChildAccounts;
+declare namespace index_d {
+  export { type index_d_Account as Account, type index_d_AccountInfo as AccountInfo, type index_d_AccountProperties as AccountProperties, type index_d_AccountResponse as AccountResponse, index_d_AccountStatus as AccountStatus, type index_d_AccountV2 as AccountV2, type index_d_AccountsResponse as AccountsResponse, index_d_CoBranding as CoBranding, type index_d_CreateAccountAndAssignUserRequest as CreateAccountAndAssignUserRequest, type index_d_CreateAccountForMyUserRequest as CreateAccountForMyUserRequest, type index_d_CreateAccountOptions as CreateAccountOptions, type index_d_CreateAccountRequest as CreateAccountRequest, type index_d_CreateAccountResponse as CreateAccountResponse, type index_d_CreateAccountResponseNonNullableFields as CreateAccountResponseNonNullableFields, type index_d_CreateAccountTenantRequest as CreateAccountTenantRequest, type index_d_CreateAccountTenantResponse as CreateAccountTenantResponse, type index_d_DeleteAccountRequest as DeleteAccountRequest, type index_d_Email as Email, type index_d_EmptyResponse as EmptyResponse, type index_d_GetAccountRequest as GetAccountRequest, type index_d_GetAccountsRequest as GetAccountsRequest, type index_d_GetMyAccountRequest as GetMyAccountRequest, type index_d_GetMyUserAccountsRequest as GetMyUserAccountsRequest, type index_d_GetParentAccountInfoRequest as GetParentAccountInfoRequest, type index_d_GetParentAccountInfoResponse as GetParentAccountInfoResponse, type index_d_GetSubAccountsRequest as GetSubAccountsRequest, type index_d_GetSubAccountsResponse as GetSubAccountsResponse, type index_d_GetUserAccountRequest as GetUserAccountRequest, type index_d_GetUserAccountsRequest as GetUserAccountsRequest, type index_d_IsTeamRequest as IsTeamRequest, type index_d_IsTeamResponse as IsTeamResponse, type index_d_ListChildAccountsOptions as ListChildAccountsOptions, type index_d_ListChildAccountsRequest as ListChildAccountsRequest, type index_d_ListChildAccountsResponse as ListChildAccountsResponse, type index_d_ListChildAccountsResponseNonNullableFields as ListChildAccountsResponseNonNullableFields, type index_d_MarkAccountFlagRequest as MarkAccountFlagRequest, type index_d_MarkAccountFlagRequestFlagOneOf as MarkAccountFlagRequestFlagOneOf, type index_d_Paging as Paging, type index_d_PagingMetadata as PagingMetadata, type index_d_RemoveParent as RemoveParent, type index_d_SetIsReadOnlyAccountRequest as SetIsReadOnlyAccountRequest, type index_d_SsoIdentity as SsoIdentity, type index_d_SubAccountInfo as SubAccountInfo, type index_d_UpdateAccountRequest as UpdateAccountRequest, type index_d_UpdateParentAccountRequest as UpdateParentAccountRequest, type index_d_UpdateParentAccountRequestUpdateOneOf as UpdateParentAccountRequestUpdateOneOf, type index_d_UpdateParentAccountResponse as UpdateParentAccountResponse, type index_d_UpdateSlugRequest as UpdateSlugRequest, type index_d_User as User, type index_d_UserDetails as UserDetails, index_d_createAccount as createAccount, index_d_listChildAccounts as listChildAccounts };
+}
+
+export { index_d as accounts };