@lob/lob-typescript-sdk
Version:
Lob API wrapper
76 lines (75 loc) • 3.1 kB
TypeScript
/**
* Lob
* The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
*
* The version of the OpenAPI document: 1.3.0
* Contact: lob-openapi@lob.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/**
*
* @export
* @class UsVerificationsWritable
*/
export declare class UsVerificationsWritable {
constructor(input?: any);
/**
* The entire address in one string (e.g., \"210 King Street 94107\"). _Does not support a recipient and will error when other payload parameters are provided._
* @type {string}
* @memberof UsVerificationsWritable
*/
"address"?: string;
/**
* The intended recipient, typically a person\'s or firm\'s name.
* @type {string}
* @memberof UsVerificationsWritable
*/
"recipient"?: string | null;
/**
* The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
* @type {string}
* @memberof UsVerificationsWritable
*/
"primary_line"?: string;
/**
* The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
* @type {string}
* @memberof UsVerificationsWritable
*/
"secondary_line"?: string;
/**
* Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.
* @type {string}
* @memberof UsVerificationsWritable
*/
"urbanization"?: string;
/**
*
* @type {string}
* @memberof UsVerificationsWritable
*/
"city"?: string;
/**
* The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed.
* @type {string}
* @memberof UsVerificationsWritable
*/
"state"?: string;
/**
* Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`).
* @type {string}
* @memberof UsVerificationsWritable
*/
private "_zip_code"?;
get zip_code(): string;
set zip_code(newValue: string);
toJSON(): {};
}
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/