magicbell
Version:
MagicBell API wrapper
91 lines • 2.89 kB
JavaScript
// This file is generated. Do not update manually!
import { Resource } from '../client/resource.js';
import { UsersNotifications } from './users/notifications.js';
import { UsersPushSubscriptions } from './users/push-subscriptions.js';
export class Users extends Resource {
path = 'users';
entity = 'user';
notifications = new UsersNotifications(this.client);
pushSubscriptions = new UsersPushSubscriptions(this.client);
create(dataOrOptions, options) {
return this.request({
method: 'POST',
}, dataOrOptions, options);
}
list(dataOrOptions, options) {
return this.request({
method: 'GET',
paged: true,
}, dataOrOptions, options);
}
/**
* Fetch a user by id, for the project identified by the auth keys.
*
* @param userId - The user id is the MagicBell user id. Accepts a UUID
* @param options - override client request options.
* @returns
**/
get(userId, options) {
return this.request({
method: 'GET',
path: '{user_id}',
}, userId, options);
}
update(userId, dataOrOptions, options) {
return this.request({
method: 'PUT',
path: '{user_id}',
}, userId, dataOrOptions, options);
}
updateByEmail(userEmail, dataOrOptions, options) {
return this.request({
method: 'PUT',
path: 'email:{user_email}',
}, userEmail, dataOrOptions, options);
}
updateByExternalId(externalId, dataOrOptions, options) {
return this.request({
method: 'PUT',
path: 'external_id:{external_id}',
}, externalId, dataOrOptions, options);
}
/**
* Immediately deletes a user.
*
* @param userId - The user id is the MagicBell user id. Alternatively, provide an
* id like `email:theusersemail@example.com` or `external_id:theusersexternalid` as
* the user id.
* @param options - override client request options.
**/
delete(userId, options) {
return this.request({
method: 'DELETE',
path: '{user_id}',
}, userId, options);
}
/**
* Immediately deletes a user.
*
* @param userEmail
* @param options - override client request options.
**/
deleteByEmail(userEmail, options) {
return this.request({
method: 'DELETE',
path: 'email:{user_email}',
}, userEmail, options);
}
/**
* Immediately deletes a user.
*
* @param externalId
* @param options - override client request options.
**/
deleteByExternalId(externalId, options) {
return this.request({
method: 'DELETE',
path: 'external_id:{external_id}',
}, externalId, options);
}
}
//# sourceMappingURL=users.js.map