@ringer-tel/ivy/models/UserCreateRequest.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.5
 * 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';
/**
 * Information needed to create a new user.
 * @export
 * @interface UserCreateRequest
 */
export interface UserCreateRequest {
    /**
     * The user's first name.
     * @type {string}
     * @memberof UserCreateRequest
     */
    firstName: string;
    /**
     * The user's last name.
     * @type {string}
     * @memberof UserCreateRequest
     */
    lastName: string;
    /**
     * The user's unique email address, used for login and notifications.
     * @type {string}
     * @memberof UserCreateRequest
     */
    email: string;
    /**
     * The role assigned to the user within the account (e.g., administrator, user).
     * @type {string}
     * @memberof UserCreateRequest
     */
    role: string;
    /**
     * Indicates whether the user's account is active and can be used to log in.
     * @type {boolean}
     * @memberof UserCreateRequest
     */
    active: boolean;
    /**
     * The user's preferred language and regional settings (e.g., "en-US").
     * @type {string}
     * @memberof UserCreateRequest
     */
    locale: string;
}

/**
 * Check if a given object implements the UserCreateRequest interface.
 */
export function instanceOfUserCreateRequest(value: object): value is UserCreateRequest {
    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 UserCreateRequestFromJSON(json: any): UserCreateRequest {
    return UserCreateRequestFromJSONTyped(json, false);
}

export function UserCreateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserCreateRequest {
    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'],
    };
}

export function UserCreateRequestToJSON(json: any): UserCreateRequest {
    return UserCreateRequestToJSONTyped(json, false);
}

export function UserCreateRequestToJSONTyped(value?: UserCreateRequest | 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'],
    };
}