magicbell/dist/commonjs/project-resources/users.js

MagicBell API wrapper

"use strict";
// This file is generated. Do not update manually!
Object.defineProperty(exports, "__esModule", { value: true });
exports.Users = void 0;
const resource_js_1 = require("../client/resource.js");
const notifications_js_1 = require("./users/notifications.js");
const push_subscriptions_js_1 = require("./users/push-subscriptions.js");
class Users extends resource_js_1.Resource {
    path = 'users';
    entity = 'user';
    notifications = new notifications_js_1.UsersNotifications(this.client);
    pushSubscriptions = new push_subscriptions_js_1.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);
    }
}
exports.Users = Users;
//# sourceMappingURL=users.js.map