@wix/user-management 1.0.0

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

@@ -0,0 +1,219 @@
+interface AccountV2$1 {
+    /** Account ID. */
+    accountId?: string;
+}
+interface Paging$1 {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface CreateAccountRequest$1 {
+    /** The user to create under the new account, with the roles defined in `roles`. */
+    user: User$1;
+    /**
+     * 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$1 {
+    /** User's unique email address details. Required. */
+    email?: Email$1;
+    /** 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$1[];
+    /** Additional user details. */
+    userDetails?: UserDetails$1;
+}
+/** User's email address. */
+interface Email$1 {
+    /** 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$1 {
+    /** 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$1 {
+    /** 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$1 {
+    /** The created account. */
+    account?: AccountV2$1;
+}
+interface PagingMetadata$1 {
+    /** 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$1 {
+    /**
+     * Paging options to limit and offset the number of items.
+     * Default: 20. Max: 50.
+     */
+    paging?: Paging$1;
+}
+interface ListChildAccountsResponse$1 {
+    /** The requested child accounts. */
+    childAccounts?: AccountV2$1[];
+    /** Metadata of the response pagination. */
+    pagingMetadata?: PagingMetadata$1;
+}
+interface AccountV2NonNullableFields$1 {
+    accountId: string;
+}
+interface CreateAccountResponseNonNullableFields$1 {
+    account?: AccountV2NonNullableFields$1;
+}
+interface ListChildAccountsResponseNonNullableFields$1 {
+    childAccounts: AccountV2NonNullableFields$1[];
+}
+
+interface AccountV2 {
+    /** Account ID. */
+    accountId?: string;
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+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 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 AccountV2NonNullableFields {
+    accountId: string;
+}
+interface CreateAccountResponseNonNullableFields {
+    account?: AccountV2NonNullableFields;
+}
+interface ListChildAccountsResponseNonNullableFields {
+    childAccounts: AccountV2NonNullableFields[];
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createAccount(): __PublicMethodMetaInfo<'POST', {}, CreateAccountRequest, CreateAccountRequest$1, CreateAccountResponse & CreateAccountResponseNonNullableFields, CreateAccountResponse$1 & CreateAccountResponseNonNullableFields$1>;
+declare function listChildAccounts(): __PublicMethodMetaInfo<'GET', {}, ListChildAccountsRequest, ListChildAccountsRequest$1, ListChildAccountsResponse & ListChildAccountsResponseNonNullableFields, ListChildAccountsResponse$1 & ListChildAccountsResponseNonNullableFields$1>;
+
+type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
+declare const meta_createAccount: typeof createAccount;
+declare const meta_listChildAccounts: typeof listChildAccounts;
+declare namespace meta {
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_createAccount as createAccount, meta_listChildAccounts as listChildAccounts };
+}
+
+export { meta as accounts };