wallee/dist/models/RestAddressFormat.d.ts

TypeScript/JavaScript client for wallee

import type { RestAddressFormatField } from './RestAddressFormatField';
/**
 *
 * @export
 * @interface RestAddressFormat
 */
export interface RestAddressFormat {
    /**
     * A list of sample post codes.
     * @type {Array<string>}
     * @memberof RestAddressFormat
     */
    readonly postCodeExamples?: Array<string>;
    /**
     * The fields that are required in the address format.
     * @type {Set<RestAddressFormatField>}
     * @memberof RestAddressFormat
     */
    readonly requiredFields?: Set<RestAddressFormatField>;
    /**
     * The fields that are used in the address format.
     * @type {Set<RestAddressFormatField>}
     * @memberof RestAddressFormat
     */
    readonly usedFields?: Set<RestAddressFormatField>;
    /**
     * The regular expression to validate post codes.
     * @type {string}
     * @memberof RestAddressFormat
     */
    readonly postCodeRegex?: string;
}
/**
 * Check if a given object implements the RestAddressFormat interface.
 */
export declare function instanceOfRestAddressFormat(value: object): value is RestAddressFormat;
export declare function RestAddressFormatFromJSON(json: any): RestAddressFormat;
export declare function RestAddressFormatFromJSONTyped(json: any, ignoreDiscriminator: boolean): RestAddressFormat;
export declare function RestAddressFormatToJSON(json: any): RestAddressFormat;
export declare function RestAddressFormatToJSONTyped(value?: Omit<RestAddressFormat, 'postCodeExamples' | 'requiredFields' | 'usedFields' | 'postCodeRegex'> | null, ignoreDiscriminator?: boolean): any;