Returns a single User by its ID. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.users.show({
bearer_token: '7381273269536713689562374856'
id: '1'
})
Creates a new User and returns its attributes. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.users.create({
bearer_token: '7381273269536713689562374856',
user: {
email: 'string',
first_name: 'string',
last_name: 'string',
password: 'string',
password_confirmation: 'string',
ship_address_id: 'string',
bill_address_id: 'string',
public_metadata: {},
private_metadata: {}
}
})
Update selected User. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.users.update({
bearer_token: '7381273269536713689562374856',
id: '1',
user: {
email: 'string',
first_name: 'string',
last_name: 'string',
password: 'string',
password_confirmation: 'string',
ship_address_id: 'string',
bill_address_id: 'string',
public_metadata: {},
private_metadata: {}
}
})
This endpoint removes the specified User. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example:
const response = await client.users.remove({
bearer_token: '7381273269536713689562374856',
id: '1'
})
Protected
spreeOptional
tokens: ITokenOptional
params: anyOptional
responseParsing: ResponseParsingProtected
classifyProtected
processProtected
processProtected
spreeGenerated using TypeDoc
Returns a list of Users. See api docs.
Required token: Bearer token
Success response schema: Success schema
Failure response schema: Error schema
Example: