@ringer-tel/ivy/src/models/UserRequest.ts

TypeScript SDK for Ringer APIs

/* tslint:disable */
/* eslint-disable */
/**
 * Ringer Business API
 * This API provides comprehensive endpoints for the Ringer Business system. It includes functionality for managing customer accounts, addresses, sites, phone numbers, payments, users, and other business resources.  Operations typically require authentication and appropriate permissions. 
 *
 * The version of the OpenAPI document: 1.0.6
 * Contact: support@ringer.tel
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { mapValues } from '../runtime';
import type { UserFeatureRequestFeatures } from './UserFeatureRequestFeatures';
import {
    UserFeatureRequestFeaturesFromJSON,
    UserFeatureRequestFeaturesFromJSONTyped,
    UserFeatureRequestFeaturesToJSON,
    UserFeatureRequestFeaturesToJSONTyped,
} from './UserFeatureRequestFeatures';

/**
 * Information needed to create a new user.
 * @export
 * @interface UserRequest
 */
export interface UserRequest {
    /**
     * The user's first name.
     * @type {string}
     * @memberof UserRequest
     */
    firstName: string;
    /**
     * The user's last name.
     * @type {string}
     * @memberof UserRequest
     */
    lastName: string;
    /**
     * The user's unique email address, used for login and notifications.
     * @type {string}
     * @memberof UserRequest
     */
    email: string;
    /**
     * The role assigned to the user within the account (e.g., administrator, user).
     * @type {string}
     * @memberof UserRequest
     */
    role: string;
    /**
     * Indicates whether the user's account is active and can be used to log in.
     * @type {boolean}
     * @memberof UserRequest
     */
    active: boolean;
    /**
     * The user's preferred language and regional settings (e.g., "en-US").
     * @type {string}
     * @memberof UserRequest
     */
    locale: string;
    /**
     * 
     * @type {UserFeatureRequestFeatures}
     * @memberof UserRequest
     */
    features?: UserFeatureRequestFeatures;
    /**
     * The identifier of the site to which this user belongs. If not specified, the user is created without a site association.
     * @type {number}
     * @memberof UserRequest
     */
    siteId?: number | null;
    /**
     * Optional identifier of a template to apply to this user. If not specified, the user is created without a template.
     * @type {number}
     * @memberof UserRequest
     */
    templateId?: number | null;
}

/**
 * Check if a given object implements the UserRequest interface.
 */
export function instanceOfUserRequest(value: object): value is UserRequest {
    if (!('firstName' in value) || value['firstName'] === undefined) return false;
    if (!('lastName' in value) || value['lastName'] === undefined) return false;
    if (!('email' in value) || value['email'] === undefined) return false;
    if (!('role' in value) || value['role'] === undefined) return false;
    if (!('active' in value) || value['active'] === undefined) return false;
    if (!('locale' in value) || value['locale'] === undefined) return false;
    return true;
}

export function UserRequestFromJSON(json: any): UserRequest {
    return UserRequestFromJSONTyped(json, false);
}

export function UserRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserRequest {
    if (json == null) {
        return json;
    }
    return {
        
        'firstName': json['first_name'],
        'lastName': json['last_name'],
        'email': json['email'],
        'role': json['role'],
        'active': json['active'],
        'locale': json['locale'],
        'features': json['features'] == null ? undefined : UserFeatureRequestFeaturesFromJSON(json['features']),
        'siteId': json['site_id'] == null ? undefined : json['site_id'],
        'templateId': json['template_id'] == null ? undefined : json['template_id'],
    };
}

export function UserRequestToJSON(json: any): UserRequest {
    return UserRequestToJSONTyped(json, false);
}

export function UserRequestToJSONTyped(value?: UserRequest | null, ignoreDiscriminator: boolean = false): any {
    if (value == null) {
        return value;
    }

    return {
        
        'first_name': value['firstName'],
        'last_name': value['lastName'],
        'email': value['email'],
        'role': value['role'],
        'active': value['active'],
        'locale': value['locale'],
        'features': UserFeatureRequestFeaturesToJSON(value['features']),
        'site_id': value['siteId'],
        'template_id': value['templateId'],
    };
}