@ringer-tel/ivy/src/models/ForgotPasswordResponse.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 { Link } from './Link';
import {
    LinkFromJSON,
    LinkFromJSONTyped,
    LinkToJSON,
    LinkToJSONTyped,
} from './Link';

/**
 * Response after a password reset has been initiated.
 * @export
 * @interface ForgotPasswordResponse
 */
export interface ForgotPasswordResponse {
    /**
     * The password reset token. This is often NOT returned directly for security reasons; instead, it is emailed to the user.
     * @type {string}
     * @memberof ForgotPasswordResponse
     */
    resetPasswordToken?: string | null;
    /**
     * 
     * @type {Array<Link>}
     * @memberof ForgotPasswordResponse
     */
    links?: Array<Link>;
}

/**
 * Check if a given object implements the ForgotPasswordResponse interface.
 */
export function instanceOfForgotPasswordResponse(value: object): value is ForgotPasswordResponse {
    return true;
}

export function ForgotPasswordResponseFromJSON(json: any): ForgotPasswordResponse {
    return ForgotPasswordResponseFromJSONTyped(json, false);
}

export function ForgotPasswordResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ForgotPasswordResponse {
    if (json == null) {
        return json;
    }
    return {
        
        'resetPasswordToken': json['reset_password_token'] == null ? undefined : json['reset_password_token'],
        'links': json['links'] == null ? undefined : ((json['links'] as Array<any>).map(LinkFromJSON)),
    };
}

export function ForgotPasswordResponseToJSON(json: any): ForgotPasswordResponse {
    return ForgotPasswordResponseToJSONTyped(json, false);
}

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

    return {
        
        'reset_password_token': value['resetPasswordToken'],
        'links': value['links'] == null ? undefined : ((value['links'] as Array<any>).map(LinkToJSON)),
    };
}