@ringer-tel/ivy/models/AddressUpdateRequest.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';
/**
 * All fields required to update an existing address. For PUT, typically all fields are provided.
 * @export
 * @interface AddressUpdateRequest
 */
export interface AddressUpdateRequest {
    /**
     * Contact email address associated with this address record.
     * @type {string}
     * @memberof AddressUpdateRequest
     */
    email: string;
    /**
     * Full street address, including building number, street name, and suite/apartment if applicable.
     * @type {string}
     * @memberof AddressUpdateRequest
     */
    streetAddress: string;
    /**
     * Two-letter ISO 3166-1 alpha-2 country code (e.g., US, GB, CA).
     * @type {string}
     * @memberof AddressUpdateRequest
     */
    country: string;
    /**
     * City name.
     * @type {string}
     * @memberof AddressUpdateRequest
     */
    city: string;
    /**
     * State, province, or region, as applicable for the country.
     * @type {string}
     * @memberof AddressUpdateRequest
     */
    stateProvince?: string;
    /**
     * Postal or ZIP code.
     * @type {string}
     * @memberof AddressUpdateRequest
     */
    postalCode: string;
    /**
     * A contact phone number associated with this address, preferably in E.164 format.
     * @type {string}
     * @memberof AddressUpdateRequest
     */
    contactNumber: string;
}

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

export function AddressUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): AddressUpdateRequest {
    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 AddressUpdateRequestToJSON(json: any): AddressUpdateRequest {
    return AddressUpdateRequestToJSONTyped(json, false);
}

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