shipstation-client/models/address-validation-result.ts

ShipStation V2 SDK

/* tslint:disable */
/* eslint-disable */
/**
 * ShipStation API v2
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 2.0.0
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


// May contain unused imports in some cases
// @ts-ignore
import type { Address } from './address';
// May contain unused imports in some cases
// @ts-ignore
import type { AddressValidationStatus } from './address-validation-status';
// May contain unused imports in some cases
// @ts-ignore
import type { ResponseMessage } from './response-message';

/**
 * An address validation result
 * @export
 * @interface AddressValidationResult
 */
export interface AddressValidationResult {
    [key: string]: any;

    /**
     * 
     * @type {AddressValidationStatus}
     * @memberof AddressValidationResult
     */
    'status': AddressValidationStatus;
    /**
     * The original address that was sent for validation
     * @type {Address}
     * @memberof AddressValidationResult
     */
    'original_address': Address;
    /**
     * The matched address found by the ShipStation API
     * @type {Address}
     * @memberof AddressValidationResult
     */
    'matched_address': Address | null;
    /**
     * The list of messages that were generated during the address validation request.
     * @type {Array<ResponseMessage>}
     * @memberof AddressValidationResult
     */
    'messages': Array<ResponseMessage>;
}