UNPKG

2.29 kBTypeScriptView Raw
1/**
2 * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
3 */
4export interface Metadata {
5 [name: string]: string;
6}
7
8/**
9 * Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
10 * While you can send values as numbers, they will be returned as strings.
11 */
12export interface MetadataParam {
13 [name: string]: string | number | null;
14}
15
16/**
17 * The Address object.
18 */
19export interface Address {
20 /**
21 * City/District/Suburb/Town/Village.
22 */
23 city: string | null;
24
25 /**
26 * 2-letter country code.
27 */
28 country: string | null;
29
30 /**
31 * Address line 1 (Street address/PO Box/Company name).
32 */
33 line1: string | null;
34
35 /**
36 * Address line 2 (Apartment/Suite/Unit/Building).
37 */
38 line2: string | null;
39
40 /**
41 * ZIP or postal code.
42 */
43 postal_code: string | null;
44
45 /**
46 * State/County/Province/Region.
47 */
48 state: string | null;
49}
50
51export interface AccountAddressParam {
52 /**
53 * City, district, suburb, town, or village.
54 */
55 city?: string;
56
57 /**
58 * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
59 */
60 country?: string;
61
62 /**
63 * Address line 1 (e.g., street, PO Box, or company name).
64 */
65 line1?: string;
66
67 /**
68 * Address line 2 (e.g., apartment, suite, unit, or building).
69 */
70 line2?: string;
71
72 /**
73 * ZIP or postal code.
74 */
75 postal_code?: string;
76
77 /**
78 * State, county, province, or region.
79 */
80 state?: string;
81}
82
83export interface AddressParam extends AccountAddressParam {
84 /**
85 * Address line 1 (e.g., street, PO Box, or company name).
86 */
87 line1: string;
88}
89
90export interface JapanAddressParam {
91 /**
92 * City or ward.
93 */
94 city?: string;
95
96 /**
97 * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
98 */
99 country?: string;
100
101 /**
102 * Block or building number.
103 */
104 line1?: string;
105
106 /**
107 * Building details.
108 */
109 line2?: string;
110
111 /**
112 * Postal code.
113 */
114 postal_code?: string;
115
116 /**
117 * Prefecture.
118 */
119 state?: string;
120
121 /**
122 * Town or cho-me.
123 */
124 town?: string;
125}