@ringer-tel/ivy/models/AddressUserProvided.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';
/**
 * Address information provided by the user during sign-up.
 * @export
 * @interface AddressUserProvided
 */
export interface AddressUserProvided {
    /**
     * Primary contact email address for the account.
     * @type {string}
     * @memberof AddressUserProvided
     */
    email: string;
    /**
     * Street name and number, including suite or apartment if applicable.
     * @type {string}
     * @memberof AddressUserProvided
     */
    streetAddress: string;
    /**
     * Two-letter ISO 3166-1 alpha-2 country code (e.g., US, GB, CA).
     * @type {string}
     * @memberof AddressUserProvided
     */
    country: string;
    /**
     * City name.
     * @type {string}
     * @memberof AddressUserProvided
     */
    city: string;
    /**
     * State or province name or code, as applicable for the country.
     * @type {string}
     * @memberof AddressUserProvided
     */
    stateProvince?: string;
    /**
     * Postal or ZIP code.
     * @type {string}
     * @memberof AddressUserProvided
     */
    postalCode: string;
    /**
     * Primary contact phone number, preferably in E.164 format.
     * @type {string}
     * @memberof AddressUserProvided
     */
    contactNumber: string;
}

/**
 * Check if a given object implements the AddressUserProvided interface.
 */
export function instanceOfAddressUserProvided(value: object): value is AddressUserProvided {
    if (!('email' in value) || value['email'] === undefined) return false;
    if (!('streetAddress' in value) || value['streetAddress'] === undefined) return false;
    if (!('country' in value) || value['country'] === undefined) return false;
    if (!('city' in value) || value['city'] === undefined) return false;
    if (!('postalCode' in value) || value['postalCode'] === undefined) return false;
    if (!('contactNumber' in value) || value['contactNumber'] === undefined) return false;
    return true;
}

export function AddressUserProvidedFromJSON(json: any): AddressUserProvided {
    return AddressUserProvidedFromJSONTyped(json, false);
}

export function AddressUserProvidedFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddressUserProvided {
    if (json == null) {
        return json;
    }
    return {
        
        'email': json['email'],
        'streetAddress': json['street_address'],
        'country': json['country'],
        'city': json['city'],
        'stateProvince': json['state_province'] == null ? undefined : json['state_province'],
        'postalCode': json['postal_code'],
        'contactNumber': json['contact_number'],
    };
}

export function AddressUserProvidedToJSON(json: any): AddressUserProvided {
    return AddressUserProvidedToJSONTyped(json, false);
}

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

    return {
        
        'email': value['email'],
        'street_address': value['streetAddress'],
        'country': value['country'],
        'city': value['city'],
        'state_province': value['stateProvince'],
        'postal_code': value['postalCode'],
        'contact_number': value['contactNumber'],
    };
}