Search
Preparing search index...
The search index is not available
storefront-sdk
Options
All
Public
Public/Protected
All
Inherited
Menu
storefront-sdk
sdk-full/models/customer
Module sdk-full/models/customer
Index
Type aliases
Create
Customer
Address
Input
Customer
Access
Token
Details
Data
Customer
Access
Token
Renew
Data
Customer
Address
Data
Customer
Address
Remove
Data
Customer
Authenticate
Access
Key
Data
Customer
Authenticated
Login
Data
Customer
Complete
Partial
Registration
Data
Customer
Create
Data
Customer
Create
Input
Customer
Data
Customer
Email
Change
Data
Customer
Impersonate
Data
Customer
Password
Change
Data
Customer
Password
Recovery
Data
Customer
Send
Access
Key
Email
Data
Customer
Simple
Create
Input
Graph
Input
Customer
Simple
Login
Start
Data
Customer
Simple
Login
Verify
Answer
Data
Customer
Social
Login
Facebook
Data
Customer
Social
Login
Google
Data
Customer
Subscription
Address
Change
Data
Customer
Subscription
Product
Add
Input
Customer
Subscription
Product
Data
Customer
Subscription
Product
Remove
Input
Customer
Subscription
Update
Status
Data
Customer
Update
Data
Customer
Update
Input
Update
Customer
Address
Input
Type aliases
Create
Customer
Address
Input
Create
Customer
Address
Input
:
{
addressDetails
:
string
;
addressNumber
:
string
;
cep
:
string
;
city
:
string
;
name
:
string
;
neighborhood
:
string
;
receiverName
:
string
;
referencePoint
:
string
;
state
:
string
;
street
:
string
}
Type declaration
address
Details
:
string
address
Number
:
string
cep
:
string
city
:
string
name
:
string
neighborhood
:
string
receiver
Name
:
string
reference
Point
:
string
state
:
string
street
:
string
Customer
Access
Token
Details
Data
Customer
Access
Token
Details
Data
:
{
accessKey
:
boolean
;
customerId
:
number
;
identifier
:
string
;
isMaster
:
boolean
;
origin
:
string
;
type
:
string
;
validUntil
:
string
}
Type declaration
access
Key
:
boolean
customer
Id
:
number
identifier
:
string
is
Master
:
boolean
origin
:
string
type
:
string
valid
Until
:
string
Customer
Access
Token
Renew
Data
Customer
Access
Token
Renew
Data
:
{
token
:
string
;
validUntil
:
string
}
Type declaration
token
:
string
valid
Until
:
string
Customer
Address
Data
Customer
Address
Data
:
{
addressDetails
:
string
;
addressNumber
:
string
;
cep
:
string
;
city
:
string
;
id
:
string
;
name
:
string
;
neighborhood
:
string
;
receiverName
:
string
;
referencePoint
:
string
;
state
:
string
;
street
:
string
}
Type declaration
address
Details
:
string
address
Number
:
string
cep
:
string
city
:
string
id
:
string
name
:
string
neighborhood
:
string
receiver
Name
:
string
reference
Point
:
string
state
:
string
street
:
string
Customer
Address
Remove
Data
Customer
Address
Remove
Data
:
{
isSuccess
:
boolean
}
Type declaration
is
Success
:
boolean
Customer
Authenticate
Access
Key
Data
Customer
Authenticate
Access
Key
Data
:
{
token
:
string
;
validUntil
:
string
}
Type declaration
token
:
string
valid
Until
:
string
Customer
Authenticated
Login
Data
Customer
Authenticated
Login
Data
:
{
isMaster
:
boolean
;
token
:
string
;
validUntil
:
string
}
Type declaration
is
Master
:
boolean
token
:
string
valid
Until
:
string
Customer
Complete
Partial
Registration
Data
Customer
Complete
Partial
Registration
Data
:
{
isMaster
:
boolean
;
token
:
string
;
type
:
string
;
validUntil
:
string
}
Type declaration
is
Master
:
boolean
token
:
string
type
:
string
valid
Until
:
string
Customer
Create
Data
Customer
Create
Data
:
{
customerId
:
string
;
customerName
:
string
;
customerType
:
string
;
email
:
string
}
Type declaration
customer
Id
:
string
customer
Name
:
string
customer
Type
:
string
email
:
string
Customer
Create
Input
Customer
Create
Input
:
{
address
?:
string
;
address2
?:
string
;
addressComplement
?:
string
;
addressNumber
?:
string
;
birthDate
?:
string
;
cep
?:
string
;
city
?:
string
;
cnpj
?:
string
;
corporateName
?:
string
;
country
?:
string
;
cpf
?:
string
;
customerType
:
string
;
email
:
string
;
fullName
:
string
;
gender
?:
string
;
informationGroupValues
?:
{
id
:
string
;
value
:
string
}
[]
;
isStateRegistrationExempt
?:
boolean
;
neighborhood
?:
string
;
newsletter
?:
boolean
;
password
:
string
;
passwordConfirmation
:
string
;
primaryPhoneAreaCode
?:
string
;
primaryPhoneNumber
?:
string
;
receiverName
?:
string
;
reference
?:
string
;
reseller
?:
boolean
;
secondaryPhoneAreaCode
?:
string
;
secondaryPhoneNumber
?:
string
;
state
?:
string
;
stateRegistration
?:
string
}
Type declaration
Optional
address
?:
string
Optional
address2
?:
string
Optional
address
Complement
?:
string
Optional
address
Number
?:
string
Optional
birth
Date
?:
string
Optional
cep
?:
string
Optional
city
?:
string
Optional
cnpj
?:
string
Optional
corporate
Name
?:
string
Optional
country
?:
string
Optional
cpf
?:
string
customer
Type
:
string
email
:
string
full
Name
:
string
Optional
gender
?:
string
Optional
information
Group
Values
?:
{
id
:
string
;
value
:
string
}
[]
Optional
is
State
Registration
Exempt
?:
boolean
Optional
neighborhood
?:
string
Optional
newsletter
?:
boolean
password
:
string
password
Confirmation
:
string
Optional
primary
Phone
Area
Code
?:
string
Optional
primary
Phone
Number
?:
string
Optional
receiver
Name
?:
string
Optional
reference
?:
string
Optional
reseller
?:
boolean
Optional
secondary
Phone
Area
Code
?:
string
Optional
secondary
Phone
Number
?:
string
Optional
state
?:
string
Optional
state
Registration
?:
string
Customer
Data
Customer
Data
:
{
cnpj
?:
string
;
companyName
?:
string
;
cpf
?:
string
;
customerName
:
string
;
customerType
:
string
;
email
:
string
;
id
:
string
;
phoneNumber
?:
string
}
Type declaration
Optional
cnpj
?:
string
Optional
company
Name
?:
string
Optional
cpf
?:
string
customer
Name
:
string
customer
Type
:
string
email
:
string
id
:
string
Optional
phone
Number
?:
string
Customer
Email
Change
Data
Customer
Email
Change
Data
:
{
isSuccess
:
boolean
}
Type declaration
is
Success
:
boolean
Customer
Impersonate
Data
Customer
Impersonate
Data
:
{
token
:
string
;
validUntil
:
string
}
Type declaration
token
:
string
valid
Until
:
string
Customer
Password
Change
Data
Customer
Password
Change
Data
:
{
isSuccess
:
boolean
}
Type declaration
is
Success
:
boolean
Customer
Password
Recovery
Data
Customer
Password
Recovery
Data
:
{
isSuccess
:
boolean
}
Type declaration
is
Success
:
boolean
Customer
Send
Access
Key
Email
Data
Customer
Send
Access
Key
Email
Data
:
{
isSuccess
:
boolean
}
Type declaration
is
Success
:
boolean
Customer
Simple
Create
Input
Graph
Input
Customer
Simple
Create
Input
Graph
Input
:
{
birthDate
?:
string
;
cnpj
?:
string
;
corporateName
?:
string
;
cpf
?:
string
;
customerType
:
string
;
email
:
string
;
fullName
:
string
;
isStateRegistrationExempt
?:
boolean
;
primaryPhoneAreaCode
:
string
;
primaryPhoneNumber
:
string
;
stateRegistration
?:
string
}
Type declaration
Optional
birth
Date
?:
string
Optional
cnpj
?:
string
Optional
corporate
Name
?:
string
Optional
cpf
?:
string
customer
Type
:
string
email
:
string
full
Name
:
string
Optional
is
State
Registration
Exempt
?:
boolean
primary
Phone
Area
Code
:
string
primary
Phone
Number
:
string
Optional
state
Registration
?:
string
Customer
Simple
Login
Start
Data
Customer
Simple
Login
Start
Data
:
{
customerAccessToken
:
{
token
:
string
;
type
:
string
;
validUntil
:
string
}
;
question
:
{
answers
:
{
id
:
string
;
value
:
string
}
[]
;
question
:
string
;
questionId
:
string
}
;
type
:
string
}
Type declaration
customer
Access
Token
:
{
token
:
string
;
type
:
string
;
validUntil
:
string
}
token
:
string
type
:
string
valid
Until
:
string
question
:
{
answers
:
{
id
:
string
;
value
:
string
}
[]
;
question
:
string
;
questionId
:
string
}
answers
:
{
id
:
string
;
value
:
string
}
[]
question
:
string
question
Id
:
string
type
:
string
Customer
Simple
Login
Verify
Answer
Data
Customer
Simple
Login
Verify
Answer
Data
:
{
customerAccessToken
:
{
isMaster
:
boolean
;
token
:
string
;
type
:
string
;
validUntil
:
string
}
;
question
:
{
answers
:
{
id
:
string
;
value
:
string
}
[]
;
question
:
string
;
questionId
:
string
}
;
type
:
string
}
Type declaration
customer
Access
Token
:
{
isMaster
:
boolean
;
token
:
string
;
type
:
string
;
validUntil
:
string
}
is
Master
:
boolean
token
:
string
type
:
string
valid
Until
:
string
question
:
{
answers
:
{
id
:
string
;
value
:
string
}
[]
;
question
:
string
;
questionId
:
string
}
answers
:
{
id
:
string
;
value
:
string
}
[]
question
:
string
question
Id
:
string
type
:
string
Customer
Social
Login
Facebook
Data
Customer
Social
Login
Facebook
Data
:
{
isMaster
:
boolean
;
token
:
string
;
type
:
string
;
validUntil
:
string
}
Type declaration
is
Master
:
boolean
token
:
string
type
:
string
valid
Until
:
string
Customer
Social
Login
Google
Data
Customer
Social
Login
Google
Data
:
{
isMaster
:
boolean
;
token
:
string
;
type
:
string
;
validUntil
:
string
}
Type declaration
is
Master
:
boolean
token
:
string
type
:
string
valid
Until
:
string
Customer
Subscription
Address
Change
Data
Customer
Subscription
Address
Change
Data
:
{
address
:
{
address
:
string
;
addressDetails
:
string
;
addressNumber
:
string
;
cep
:
string
;
city
:
string
;
country
:
string
;
id
:
string
;
neighborhood
:
string
;
state
:
string
}
}
Type declaration
address
:
{
address
:
string
;
addressDetails
:
string
;
addressNumber
:
string
;
cep
:
string
;
city
:
string
;
country
:
string
;
id
:
string
;
neighborhood
:
string
;
state
:
string
}
address
:
string
address
Details
:
string
address
Number
:
string
cep
:
string
city
:
string
country
:
string
id
:
string
neighborhood
:
string
state
:
string
Customer
Subscription
Product
Add
Input
Customer
Subscription
Product
Add
Input
:
{
productVariantId
:
number
;
quantity
:
number
}
Type declaration
product
Variant
Id
:
number
quantity
:
number
Customer
Subscription
Product
Data
Customer
Subscription
Product
Data
:
{
subscriptions
:
{
subscriptionId
:
number
}
[]
}
Type declaration
subscriptions
:
{
subscriptionId
:
number
}
[]
Customer
Subscription
Product
Remove
Input
Customer
Subscription
Product
Remove
Input
:
{
subscriptionProductId
:
number
}
Type declaration
subscription
Product
Id
:
number
Customer
Subscription
Update
Status
Data
Customer
Subscription
Update
Status
Data
:
{
subscriptions
:
{
status
:
string
;
subscriptionId
:
number
}
[]
}
Type declaration
subscriptions
:
{
status
:
string
;
subscriptionId
:
number
}
[]
Customer
Update
Data
Customer
Update
Data
:
{
customerId
:
string
;
customerName
:
string
;
customerType
:
string
;
email
:
string
}
Type declaration
customer
Id
:
string
customer
Name
:
string
customer
Type
:
string
email
:
string
Customer
Update
Input
Customer
Update
Input
:
{
birthDate
?:
string
;
corporateName
?:
string
;
fullName
?:
string
;
gender
?:
string
;
informationGroupValues
?:
{
id
:
string
;
value
:
string
}
[]
;
isStateRegistrationExempt
?:
boolean
;
primaryPhoneNumber
?:
string
;
primaryPhoneNumberInternational
?:
string
;
rg
?:
string
;
secondaryPhoneNumber
?:
string
;
secondaryPhoneNumberInternational
?:
string
;
stateRegistration
?:
string
}
Type declaration
Optional
birth
Date
?:
string
Optional
corporate
Name
?:
string
Optional
full
Name
?:
string
Optional
gender
?:
string
Optional
information
Group
Values
?:
{
id
:
string
;
value
:
string
}
[]
Optional
is
State
Registration
Exempt
?:
boolean
Optional
primary
Phone
Number
?:
string
Optional
primary
Phone
Number
International
?:
string
Optional
rg
?:
string
Optional
secondary
Phone
Number
?:
string
Optional
secondary
Phone
Number
International
?:
string
Optional
state
Registration
?:
string
Update
Customer
Address
Input
Update
Customer
Address
Input
:
{
addressDetails
:
string
;
addressNumber
:
string
;
cep
:
string
;
city
:
string
;
name
:
string
;
neighborhood
:
string
;
receiverName
:
string
;
referencePoint
:
string
;
state
:
string
;
street
:
string
}
Type declaration
address
Details
:
string
address
Number
:
string
cep
:
string
city
:
string
name
:
string
neighborhood
:
string
receiver
Name
:
string
reference
Point
:
string
state
:
string
street
:
string
Modules
base/cookie
base/event
base/generic-
form-
repository
base/graphql-
client
base/models/graphql-
response
base/models/partner
base/models/shop-
setting
base/newsletter-
repository
base/partner-
repository
base/product-
repository
base/snippet
base/wishlist-
repository
sdk-
full/checkout-
repository
sdk-
full/customer-
repository
sdk-
full/models/checkout
sdk-
full/models/customer
sdk-
full/models/order
sdk-
full/order-
repository
sdk-
full/storefront-
client
Create
Customer
Address
Input
Customer
Access
Token
Details
Data
Customer
Access
Token
Renew
Data
Customer
Address
Data
Customer
Address
Remove
Data
Customer
Authenticate
Access
Key
Data
Customer
Authenticated
Login
Data
Customer
Complete
Partial
Registration
Data
Customer
Create
Data
Customer
Create
Input
Customer
Data
Customer
Email
Change
Data
Customer
Impersonate
Data
Customer
Password
Change
Data
Customer
Password
Recovery
Data
Customer
Send
Access
Key
Email
Data
Customer
Simple
Create
Input
Graph
Input
Customer
Simple
Login
Start
Data
Customer
Simple
Login
Verify
Answer
Data
Customer
Social
Login
Facebook
Data
Customer
Social
Login
Google
Data
Customer
Subscription
Address
Change
Data
Customer
Subscription
Product
Add
Input
Customer
Subscription
Product
Data
Customer
Subscription
Product
Remove
Input
Customer
Subscription
Update
Status
Data
Customer
Update
Data
Customer
Update
Input
Update
Customer
Address
Input
Generated using
TypeDoc