CustomerRepository | storefront-sdk

Hierarchy

RepositoryBase
- CustomerRepository

Methods

accessTokenDetails

accessTokenDetails(customerAccessToken?: string): Promise<GraphqlResponse<CustomerAccessTokenDetailsData>>

- Defined in sdk-full/customer-repository.ts:373
Renews a customer access token

Parameters
- Optional customerAccessToken: string
  
  The current customer access token
Returns Promise<GraphqlResponse<CustomerAccessTokenDetailsData>>

accessTokenRenew

accessTokenRenew(customerAccessToken?: string): Promise<GraphqlResponse<CustomerAccessTokenRenewData>>

- Defined in sdk-full/customer-repository.ts:351
Renews a customer access token

Parameters
- Optional customerAccessToken: string
  
  The current customer access token
Returns Promise<GraphqlResponse<CustomerAccessTokenRenewData>>

authenticate

authenticate(input: string, password: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerAuthenticatedLoginData>>

- Defined in sdk-full/customer-repository.ts:94
Authenticates a customer

Parameters
- input: string
  
  The email, CPF or CNPJ of the customer
- password: string
  
  The password of the customer
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerAuthenticatedLoginData>>

authenticateAccessKey

authenticateAccessKey(email: string, accessKey: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerAuthenticateAccessKeyData>>

- Defined in sdk-full/customer-repository.ts:668
Authenticates a customer using an access key

Parameters
- email: string
  
  The email of the customer
- accessKey: string
  
  The access key sent to customer's email
- Optional recaptchaToken: string
  
  The recaptcha token
Returns Promise<GraphqlResponse<CustomerAuthenticateAccessKeyData>>

completeRegistration

completeRegistration(input: CustomerSimpleCreateInputGraphInput, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerCompletePartialRegistrationData>>

- Defined in sdk-full/customer-repository.ts:231
Completes the registration process for a customer

Parameters
- input: CustomerSimpleCreateInputGraphInput
  
  The input data for completing registration
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerCompletePartialRegistrationData>>

create

create(input: CustomerCreateInput, recaptchaToken?: string): Promise<GraphqlResponse<CustomerCreateData>>

- Defined in sdk-full/customer-repository.ts:388
Creates a new customer

Parameters
- input: CustomerCreateInput
  
  The data for creating a new customer
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerCreateData>>

createAddress

createAddress(addressInput: CreateCustomerAddressInput, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerAddressData>>

- Defined in sdk-full/customer-repository.ts:417
Creates a new customer address

Parameters
- addressInput: CreateCustomerAddressInput
  
  The input data for creating a new address
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerAddressData>>

editAddress

editAddress(addressId: string, addressInput: UpdateCustomerAddressInput, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerAddressData>>

- Defined in sdk-full/customer-repository.ts:440
Edit a customer address

Parameters
- addressId: string
  
  The address ID
- addressInput: UpdateCustomerAddressInput
  
  The input data for update a address
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerAddressData>>

emailChange

emailChange(newEmail: string, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerEmailChangeData>>

- Defined in sdk-full/customer-repository.ts:263
Changes the email of a customer

Parameters
- newEmail: string
  
  The new email address for the customer
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerEmailChangeData>>

get

get(customerAccessToken?: string): Promise<GraphqlResponse<CustomerData>>

- Defined in sdk-full/customer-repository.ts:79
Fetches customer data

Parameters
- Optional customerAccessToken: string
  
  The access token for the customer
Returns Promise<GraphqlResponse<CustomerData>>

impersonate

impersonate(input: string, masterCustomerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerImpersonateData>>

- Defined in sdk-full/customer-repository.ts:485
Impersonates a customer

Parameters
- input: string
  
  The e-mail of the customer
- Optional masterCustomerAccessToken: string
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerImpersonateData>>

passwordChange

passwordChange(currentPassword: string, newPassword: string, newPasswordConfirmation: string, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerPasswordChangeData>>

- Defined in sdk-full/customer-repository.ts:283
Changes the password of a customer

Parameters
- currentPassword: string
  
  The current password of the customer
- newPassword: string
  
  The new password for the customer
- newPasswordConfirmation: string
  
  Confirmation for the new password
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerPasswordChangeData>>

passwordChangeByRecovery

passwordChangeByRecovery(key: string, newPassword: string, newPasswordConfirmation: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerPasswordRecoveryData>>

- Defined in sdk-full/customer-repository.ts:326
Changes the password of a customer by recovery

Parameters
- key: string
  
  The customer verification code to change password
- newPassword: string
  
  The new password for the customer
- newPasswordConfirmation: string
  
  Confirmation of the customer's new password
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerPasswordRecoveryData>>

passwordRecovery

passwordRecovery(email: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerPasswordRecoveryData>>

- Defined in sdk-full/customer-repository.ts:308
Initiates a password recovery process for a customer

Parameters
- email: string
  
  The email address of the customer
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerPasswordRecoveryData>>

removeAddress

removeAddress(addressId: string, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerAddressRemoveData>>

- Defined in sdk-full/customer-repository.ts:464
Remove a customer address

Parameters
- addressId: string
  
  The address ID
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerAddressRemoveData>>

sendAccessKeyEmail

sendAccessKeyEmail(email: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerSendAccessKeyEmailData>>

- Defined in sdk-full/customer-repository.ts:650
Sends the email with an access key to authenticate a customer

Parameters
- email: string
  
  The email of the customer
- Optional recaptchaToken: string
  
  The recaptcha token
Returns Promise<GraphqlResponse<CustomerSendAccessKeyEmailData>>

simpleLoginStart

simpleLoginStart(input: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerSimpleLoginStartData>>

- Defined in sdk-full/customer-repository.ts:120
Starts the simple login process for a customer

Parameters
- input: string
  
  The email or cpf of the customer
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerSimpleLoginStartData>>

simpleLoginVerifyAnswer

simpleLoginVerifyAnswer(input: string, questionId: string, answerId: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerSimpleLoginVerifyAnswerData>>

- Defined in sdk-full/customer-repository.ts:145
Verifies the answer for a simple login question

Parameters
- input: string
  
  Additional input if required
- questionId: string
  
  The ID of the question being answered
- answerId: string
  
  The ID of the selected answer
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerSimpleLoginVerifyAnswerData>>

socialLoginFacebook

socialLoginFacebook(facebookAccessToken: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerSocialLoginFacebookData>>

- Defined in sdk-full/customer-repository.ts:178
Log in using a Facebook access token

Parameters
- facebookAccessToken: string
  
  The access token provided by Facebook
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerSocialLoginFacebookData>>

socialLoginGoogle

socialLoginGoogle(userCredential: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerSocialLoginGoogleData>>

- Defined in sdk-full/customer-repository.ts:204
Log in using Google credentials

Parameters
- userCredential: string
  
  The user credential provided by Google
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerSocialLoginGoogleData>>

subscriptionAdressChange

subscriptionAdressChange(addressId: string, subscriptionId: string, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerSubscriptionAddressChangeData>>

- Defined in sdk-full/customer-repository.ts:548
Changes the address selected for a subscription

Parameters
- addressId: string
  
  The address ID
- subscriptionId: string
  
  The subscription to change
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
  
  The recaptcha token
Returns Promise<GraphqlResponse<CustomerSubscriptionAddressChangeData>>

subscriptionProductAdd

subscriptionProductAdd(products: CustomerSubscriptionProductAddInput[], subscriptionId: string, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerSubscriptionProductData>>

- Defined in sdk-full/customer-repository.ts:600
Adds a product to a subscription

Parameters
- products: CustomerSubscriptionProductAddInput[]
  
  The status enum
- subscriptionId: string
  
  The subscription to change
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
  
  The recaptcha token
Returns Promise<GraphqlResponse<CustomerSubscriptionProductData>>

subscriptionProductRemove

subscriptionProductRemove(products: CustomerSubscriptionProductRemoveInput[], subscriptionId: string, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerSubscriptionProductData>>

- Defined in sdk-full/customer-repository.ts:626
Adds a product to a subscription

Parameters
- products: CustomerSubscriptionProductRemoveInput[]
  
  The status enum
- subscriptionId: string
  
  The subscription to change
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
  
  The recaptcha token
Returns Promise<GraphqlResponse<CustomerSubscriptionProductData>>

subscriptionUpdateStatus

subscriptionUpdateStatus(status: string, subscriptionId: string, customerAccessToken?: string, recaptchaToken?: string): Promise<GraphqlResponse<CustomerSubscriptionUpdateStatusData>>

- Defined in sdk-full/customer-repository.ts:574
Updates a subcription status

Parameters
- status: string
  
  The status enum
- subscriptionId: string
  
  The subscription to change
- Optional customerAccessToken: string
  
  The customer access token
- Optional recaptchaToken: string
  
  The recaptcha token
Returns Promise<GraphqlResponse<CustomerSubscriptionUpdateStatusData>>

update

update(customerAccessToken: string, input: CustomerUpdateInput, recaptchaToken?: string): Promise<GraphqlResponse<CustomerUpdateData>>

- Defined in sdk-full/customer-repository.ts:402
Updates an existing customer

Parameters
- customerAccessToken: string
  
  The customer access token
- input: CustomerUpdateInput
  
  The input data to update an existing customer
- Optional recaptchaToken: string
Returns Promise<GraphqlResponse<CustomerUpdateData>>

Hierarchy

Index

Methods

Methods

accessTokenDetails

Parameters

Optional customerAccessToken: string

Returns Promise<GraphqlResponse<CustomerAccessTokenDetailsData>>

accessTokenRenew

Parameters

Optional customerAccessToken: string

Returns Promise<GraphqlResponse<CustomerAccessTokenRenewData>>

authenticate

Parameters

input: string

password: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CustomerAuthenticatedLoginData>>

authenticateAccessKey

Parameters

email: string

accessKey: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CustomerAuthenticateAccessKeyData>>

completeRegistration

Parameters

input: CustomerSimpleCreateInputGraphInput

Optional customerAccessToken: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CustomerCompletePartialRegistrationData>>

create

Parameters

input: CustomerCreateInput

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CustomerCreateData>>

createAddress

Parameters

addressInput: CreateCustomerAddressInput

Optional customerAccessToken: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CustomerAddressData>>

editAddress

Parameters

addressId: string

addressInput: UpdateCustomerAddressInput

Optional customerAccessToken: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CustomerAddressData>>

emailChange

Parameters

newEmail: string

Optional customerAccessToken: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CustomerEmailChangeData>>

get

Parameters

Optional customerAccessToken: string

Returns Promise<GraphqlResponse<CustomerData>>

impersonate

Parameters

input: string

Optional masterCustomerAccessToken: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CustomerImpersonateData>>

passwordChange

Parameters

currentPassword: string

newPassword: string

newPasswordConfirmation: string

Optional customerAccessToken: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CustomerPasswordChangeData>>

passwordChangeByRecovery

Parameters

key: string

newPassword: string

newPasswordConfirmation: string

Optional recaptchaToken: string

Returns Promise<GraphqlResponse<CustomerPasswordRecoveryData>>

passwordRecovery