wallee/dist/models/Address.d.ts

TypeScript/JavaScript client for wallee

import type { Gender } from './Gender';
import type { LegalOrganizationForm } from './LegalOrganizationForm';
/**
 *
 * @export
 * @interface Address
 */
export interface Address {
    /**
     * The two-letter country code (ISO 3166 format).
     * @type {string}
     * @memberof Address
     */
    readonly country?: string;
    /**
     * The phone number of a mobile phone.
     * @type {string}
     * @memberof Address
     */
    readonly mobilePhoneNumber?: string;
    /**
     *
     * @type {Gender}
     * @memberof Address
     */
    gender?: Gender;
    /**
     * The organization's name.
     * @type {string}
     * @memberof Address
     */
    readonly organizationName?: string;
    /**
     * The city, town or village.
     * @type {string}
     * @memberof Address
     */
    readonly city?: string;
    /**
     * The commercial registration number of the organization.
     * @type {string}
     * @memberof Address
     */
    readonly commercialRegisterNumber?: string;
    /**
     * The social security number.
     * @type {string}
     * @memberof Address
     */
    readonly socialSecurityNumber?: string;
    /**
     * The given or first name.
     * @type {string}
     * @memberof Address
     */
    readonly givenName?: string;
    /**
     * The postal code, also known as ZIP, postcode, etc.
     * @type {string}
     * @memberof Address
     */
    readonly postcode?: string;
    /**
     *
     * @type {LegalOrganizationForm}
     * @memberof Address
     */
    legalOrganizationForm?: LegalOrganizationForm;
    /**
     * The sales tax number of the organization.
     * @type {string}
     * @memberof Address
     */
    readonly salesTaxNumber?: string;
    /**
     * The date of birth.
     * @type {Date}
     * @memberof Address
     */
    readonly dateOfBirth?: Date;
    /**
     * The dependent locality which is a sub-division of the state.
     * @type {string}
     * @memberof Address
     */
    readonly dependentLocality?: string;
    /**
     * The email address.
     * @type {string}
     * @memberof Address
     */
    readonly emailAddress?: string;
    /**
     * The phone number.
     * @type {string}
     * @memberof Address
     */
    readonly phoneNumber?: string;
    /**
     * The sorting code identifying the post office where the PO Box is located.
     * @type {string}
     * @memberof Address
     */
    readonly sortingCode?: string;
    /**
     * The street or PO Box.
     * @type {string}
     * @memberof Address
     */
    readonly street?: string;
    /**
     * The family or last name.
     * @type {string}
     * @memberof Address
     */
    readonly familyName?: string;
    /**
     * The name of the region, typically a state, county, province or prefecture.
     * @type {string}
     * @memberof Address
     */
    readonly postalState?: string;
    /**
     * The salutation e.g. Mrs, Mr, Dr.
     * @type {string}
     * @memberof Address
     */
    readonly salutation?: string;
}
/**
 * Check if a given object implements the Address interface.
 */
export declare function instanceOfAddress(value: object): value is Address;
export declare function AddressFromJSON(json: any): Address;
export declare function AddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): Address;
export declare function AddressToJSON(json: any): Address;
export declare function AddressToJSONTyped(value?: Omit<Address, 'country' | 'mobilePhoneNumber' | 'organizationName' | 'city' | 'commercialRegisterNumber' | 'socialSecurityNumber' | 'givenName' | 'postcode' | 'salesTaxNumber' | 'dateOfBirth' | 'dependentLocality' | 'emailAddress' | 'phoneNumber' | 'sortingCode' | 'street' | 'familyName' | 'postalState' | 'salutation'> | null, ignoreDiscriminator?: boolean): any;