Function createAccountClient
-
createAccountClient(
options?: AccountClientOptions,
): {
confirmEmailChange: (
body: EmailChangeConfirmRequest,
) => Promise<Record<string, string>>;
getProfile: (signal?: AbortSignal) => Promise<ShopUserProfile>;
getSettings: (signal?: AbortSignal) => Promise<PublicShopSettings>;
login: (body: UserLoginRequest) => Promise<AccountLoginResponse>;
logout: () => Promise<Record<string, string>>;
register: (
body: ShopUserProfileCreateRequest,
) => Promise<Record<string, string>>;
requestPasswordReset: (
body: PasswordResetRequest,
) => Promise<Record<string, string>>;
setPassword: (
body: PasswordResetConfirmRequest,
) => Promise<Record<string, string>>;
verifyEmail: (
body: EmailVerificationRequest,
) => Promise<Record<string, string>>;
}Parameters
- options: AccountClientOptions = {}
Returns {
confirmEmailChange: (
body: EmailChangeConfirmRequest,
) => Promise<Record<string, string>>;
getProfile: (signal?: AbortSignal) => Promise<ShopUserProfile>;
getSettings: (signal?: AbortSignal) => Promise<PublicShopSettings>;
login: (body: UserLoginRequest) => Promise<AccountLoginResponse>;
logout: () => Promise<Record<string, string>>;
register: (
body: ShopUserProfileCreateRequest,
) => Promise<Record<string, string>>;
requestPasswordReset: (
body: PasswordResetRequest,
) => Promise<Record<string, string>>;
setPassword: (
body: PasswordResetConfirmRequest,
) => Promise<Record<string, string>>;
verifyEmail: (
body: EmailVerificationRequest,
) => Promise<Record<string, string>>;
}-
confirmEmailChange: (body: EmailChangeConfirmRequest) => Promise<Record<string, string>>
Confirm a one-time email change token.
-
getProfile: (signal?: AbortSignal) => Promise<ShopUserProfile>
Load the authoritative authenticated profile. Optional signal cancels the read.
-
getSettings: (signal?: AbortSignal) => Promise<PublicShopSettings>
Read public installation settings. Optional signal cancels the request.
-
login: (body: UserLoginRequest) => Promise<AccountLoginResponse>
Sign in through the host proxy; browser JSON must omit upstream access tokens.
-
logout: () => Promise<Record<string, string>>
Invalidate the current host session.
-
register: (body: ShopUserProfileCreateRequest) => Promise<Record<string, string>>
Request registration without revealing account existence.
-
requestPasswordReset: (body: PasswordResetRequest) => Promise<Record<string, string>>
Request a reset email without revealing account existence.
-
setPassword: (body: PasswordResetConfirmRequest) => Promise<Record<string, string>>
Set the account password from a one-time token.
-
verifyEmail: (body: EmailVerificationRequest) => Promise<Record<string, string>>
Confirm a one-time email verification token.
Fixed relative API paths prevent credentials being sent to another origin.