User
IMPORTANTE
Para mais detalhes sobre os dados de entrada e saída consulte a documentação da API.
#
Get User DetailEste método retorna detalhes de um usuário específico.
Recebe o argumento
params
que é um objeto com os campos:storeId
: (obrigatório) id da loja -string
.userId
: (obrigatório) id da loja -string
.
Retorna um objeto com os métodos:
- identifier:
string
. - email:
string
. - name:
string
. - phone:
string
. - document:
string
. - causesList:
array
.
- identifier:
#
Get User ImpactEste método retorna o impacto causado pelo usuário.
- Recebe o argumento
params
que é um objeto com os campos:storeId
: (obrigatório) id da loja -string
.userId
: (obrigatório) id do usuário -string
.
- Retorna um objeto:
- userId:
string
. - email:
string
. - name:
string
. - phone:
string
. - document:
string
. - causeList:
array
.
- userId:
#
Get User ListEste método retorna uma lista de usuários.
Recebe o argumento
params
que é um objeto com os campos:page
: (opcional) número de uma página especifica -number
.pageSize
: (opcional) quantidade de items por página (por padrão tem o valor 20) -number
.storeId
: (obrigatório) id da loja -string
.
Retorna um objeto:
- results:
array
. - pageNumber:
number
. - nextPage:
string
.
- results:
#
Update UserEste método atualiza dados de um usuário.
Recebe o argumento
params
que é um objeto com os campos:storeId
: (obrigatório) id da loja -string
.
Recebe o argumento
body
que é um objeto com os campos:userId
: (obrigatório) id do usuário -string
.email
: (opciona) email do usuário -string
.name
: (obrigatório) nome do usuário -string
.phone
: (opcional) telefone do usuário -string
.document
: (opcional) documento de identificação (rg, cpf, cnpj) -string
.gender
: (opcional) genero do usuário -string
.birthdate
: (opcional) data de nascimento do usuário -string
.city
: (opcional) cidade do usuário -string
.state
: (opcional) estado do usuário -string
.country
: (opcional) país do usuário -string
.verified
: (opcional) para verificações adicionais -boolean
.optIn
: (opcional) verifica se deve enviar um email ao usuário -boolean
.createAt
: (opcional) data da requisição -string
.
Retorna um objeto:
- identifier:
string
. - email:
string
. - name:
string
. - phone:
string
. - document:
string
. - causesList:
array
.
- identifier:
#
Create UserEste método adiciona um novo usuário.
Recebe o argumento
params
que é um obejto com os campos:storeId
: (obrigatório) id da loja -string
.
Recebe o argumento
body
que é um objeto com os campos:causeList
: (opcional) lista de causas que serão apoiadas -array
.userId
: (obrigatório) id do usuário -string
.email
: (opciona) email do usuário -string
.name
: (obrigatório) nome do usuário -string
.phone
: (opcional) telefone do usuário -string
.document
: (opcional) documento de identificação (rg, cpf, cnpj) -string
.gender
: (opcional) genero do usuário -string
.birthdate
: (opcional) data de nascimento do usuário -string
.city
: (opcional) cidade do usuário -string
.state
: (opcional) estado do usuário -string
.country
: (opcional) país do usuário -string
.verified
: (opcional) para verificações adicionais -boolean
.optIn
: (opcional) verifica se deve enviar um email ao usuário -boolean
.createAt
: (opcional) data da requisição -string
.
Retorna um objeto:
- identifier:
string
. - email:
string
. - name:
string
. - phone:
string
. - document:
string
. - causesList:
array
.
- identifier:
#
Add User CauseEste método associa/desassocia causas a um usuário.
Recebe o argumento
params
que é um objeto com os campos:storeId
: (obrigatório) id da loja -string
.userId
: (obrigatório) id do usuário -string
.
Recebe o argumento
body
que é um objeto com os campos:addCauseList
: (opcional) causas que deseja adicionar -array
.disableCausesList
: (obrigatório) causas que deseja remover -array
.
Retorna um objeto:
- apiKey:
string
. - apiToken:
string
. - storeId:
string
. - storeUrl:
string
. - childStoreId:
array
. - email:
string
. - name:
string
. - phone:
string
. - document:
string
. - causesList:
array
. - logo:
string
. - domain:
string
. - active:
boolean
- test:
boolean
- totalDonated:
number
- totalBackers:
number
- errorCode:
number
- apiKey: