postgrid-node 0.1.0-alpha.3 → 0.1.0-alpha.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (238) hide show
  1. package/CHANGELOG.md +56 -0
  2. package/README.md +25 -39
  3. package/core.d.ts +7 -4
  4. package/core.d.ts.map +1 -1
  5. package/core.js +16 -9
  6. package/core.js.map +1 -1
  7. package/core.mjs +16 -9
  8. package/core.mjs.map +1 -1
  9. package/index.d.mts +21 -8
  10. package/index.d.ts +21 -8
  11. package/index.d.ts.map +1 -1
  12. package/index.js +28 -5
  13. package/index.js.map +1 -1
  14. package/index.mjs +28 -5
  15. package/index.mjs.map +1 -1
  16. package/internal/qs/formats.d.ts +6 -0
  17. package/internal/qs/formats.d.ts.map +1 -0
  18. package/internal/qs/formats.js +11 -0
  19. package/internal/qs/formats.js.map +1 -0
  20. package/internal/qs/formats.mjs +8 -0
  21. package/internal/qs/formats.mjs.map +1 -0
  22. package/internal/qs/index.d.ts +10 -0
  23. package/internal/qs/index.d.ts.map +1 -0
  24. package/internal/qs/index.js +14 -0
  25. package/internal/qs/index.js.map +1 -0
  26. package/internal/qs/index.mjs +10 -0
  27. package/internal/qs/index.mjs.map +1 -0
  28. package/internal/qs/stringify.d.ts +3 -0
  29. package/internal/qs/stringify.d.ts.map +1 -0
  30. package/internal/qs/stringify.js +280 -0
  31. package/internal/qs/stringify.js.map +1 -0
  32. package/internal/qs/stringify.mjs +276 -0
  33. package/internal/qs/stringify.mjs.map +1 -0
  34. package/internal/qs/types.d.ts +57 -0
  35. package/internal/qs/types.d.ts.map +1 -0
  36. package/internal/qs/types.js +3 -0
  37. package/internal/qs/types.js.map +1 -0
  38. package/internal/qs/types.mjs +2 -0
  39. package/internal/qs/types.mjs.map +1 -0
  40. package/internal/qs/utils.d.ts +14 -0
  41. package/internal/qs/utils.d.ts.map +1 -0
  42. package/internal/qs/utils.js +229 -0
  43. package/internal/qs/utils.js.map +1 -0
  44. package/internal/qs/utils.mjs +217 -0
  45. package/internal/qs/utils.mjs.map +1 -0
  46. package/package.json +4 -5
  47. package/pagination.d.ts +2 -0
  48. package/pagination.d.ts.map +1 -1
  49. package/pagination.js +2 -1
  50. package/pagination.js.map +1 -1
  51. package/pagination.mjs +2 -1
  52. package/pagination.mjs.map +1 -1
  53. package/resource.d.ts +1 -1
  54. package/resource.d.ts.map +1 -1
  55. package/resource.js.map +1 -1
  56. package/resource.mjs.map +1 -1
  57. package/resources/bank-accounts.d.ts +61 -4
  58. package/resources/bank-accounts.d.ts.map +1 -1
  59. package/resources/bank-accounts.js +25 -0
  60. package/resources/bank-accounts.js.map +1 -1
  61. package/resources/bank-accounts.mjs +25 -0
  62. package/resources/bank-accounts.mjs.map +1 -1
  63. package/resources/boxes.d.ts +80 -15
  64. package/resources/boxes.d.ts.map +1 -1
  65. package/resources/boxes.js +27 -0
  66. package/resources/boxes.js.map +1 -1
  67. package/resources/boxes.mjs +27 -0
  68. package/resources/boxes.mjs.map +1 -1
  69. package/resources/campaigns.d.ts +21 -7
  70. package/resources/campaigns.d.ts.map +1 -1
  71. package/resources/cheques/cheques.d.ts +43 -4
  72. package/resources/cheques/cheques.d.ts.map +1 -1
  73. package/resources/cheques/cheques.js +23 -0
  74. package/resources/cheques/cheques.js.map +1 -1
  75. package/resources/cheques/cheques.mjs +23 -0
  76. package/resources/cheques/cheques.mjs.map +1 -1
  77. package/resources/cheques/url.d.ts +5 -0
  78. package/resources/cheques/url.d.ts.map +1 -1
  79. package/resources/cheques/url.js +5 -0
  80. package/resources/cheques/url.js.map +1 -1
  81. package/resources/cheques/url.mjs +5 -0
  82. package/resources/cheques/url.mjs.map +1 -1
  83. package/resources/cheques/with-deposit-ready-pdf.d.ts +6 -0
  84. package/resources/cheques/with-deposit-ready-pdf.d.ts.map +1 -1
  85. package/resources/cheques/with-deposit-ready-pdf.js +6 -0
  86. package/resources/cheques/with-deposit-ready-pdf.js.map +1 -1
  87. package/resources/cheques/with-deposit-ready-pdf.mjs +6 -0
  88. package/resources/cheques/with-deposit-ready-pdf.mjs.map +1 -1
  89. package/resources/contacts.d.ts +37 -3
  90. package/resources/contacts.d.ts.map +1 -1
  91. package/resources/contacts.js +20 -0
  92. package/resources/contacts.js.map +1 -1
  93. package/resources/contacts.mjs +20 -0
  94. package/resources/contacts.mjs.map +1 -1
  95. package/resources/index.d.ts +5 -1
  96. package/resources/index.d.ts.map +1 -1
  97. package/resources/index.js +12 -1
  98. package/resources/index.js.map +1 -1
  99. package/resources/index.mjs +4 -0
  100. package/resources/index.mjs.map +1 -1
  101. package/resources/letters.d.ts +50 -6
  102. package/resources/letters.d.ts.map +1 -1
  103. package/resources/letters.js +24 -0
  104. package/resources/letters.js.map +1 -1
  105. package/resources/letters.mjs +24 -0
  106. package/resources/letters.mjs.map +1 -1
  107. package/resources/mailing-list-imports.d.ts +919 -0
  108. package/resources/mailing-list-imports.d.ts.map +1 -0
  109. package/resources/mailing-list-imports.js +95 -0
  110. package/resources/mailing-list-imports.js.map +1 -0
  111. package/resources/mailing-list-imports.mjs +90 -0
  112. package/resources/mailing-list-imports.mjs.map +1 -0
  113. package/resources/mailing-lists.d.ts +398 -0
  114. package/resources/mailing-lists.d.ts.map +1 -0
  115. package/resources/mailing-lists.js +101 -0
  116. package/resources/mailing-lists.js.map +1 -0
  117. package/resources/mailing-lists.mjs +96 -0
  118. package/resources/mailing-lists.mjs.map +1 -0
  119. package/resources/order-profiles/cheques.d.ts +588 -0
  120. package/resources/order-profiles/cheques.d.ts.map +1 -0
  121. package/resources/order-profiles/cheques.js +74 -0
  122. package/resources/order-profiles/cheques.js.map +1 -0
  123. package/resources/order-profiles/cheques.mjs +69 -0
  124. package/resources/order-profiles/cheques.mjs.map +1 -0
  125. package/resources/order-profiles/index.d.ts +6 -0
  126. package/resources/order-profiles/index.d.ts.map +1 -0
  127. package/resources/order-profiles/index.js +19 -0
  128. package/resources/order-profiles/index.js.map +1 -0
  129. package/resources/order-profiles/index.mjs +7 -0
  130. package/resources/order-profiles/index.mjs.map +1 -0
  131. package/resources/order-profiles/letters.d.ts +647 -0
  132. package/resources/order-profiles/letters.d.ts.map +1 -0
  133. package/resources/order-profiles/letters.js +80 -0
  134. package/resources/order-profiles/letters.js.map +1 -0
  135. package/resources/order-profiles/letters.mjs +75 -0
  136. package/resources/order-profiles/letters.mjs.map +1 -0
  137. package/resources/order-profiles/order-profiles.d.ts +22 -0
  138. package/resources/order-profiles/order-profiles.d.ts.map +1 -0
  139. package/resources/order-profiles/order-profiles.js +55 -0
  140. package/resources/order-profiles/order-profiles.js.map +1 -0
  141. package/resources/order-profiles/order-profiles.mjs +28 -0
  142. package/resources/order-profiles/order-profiles.mjs.map +1 -0
  143. package/resources/order-profiles/postcards.d.ts +423 -0
  144. package/resources/order-profiles/postcards.d.ts.map +1 -0
  145. package/resources/order-profiles/postcards.js +73 -0
  146. package/resources/order-profiles/postcards.js.map +1 -0
  147. package/resources/order-profiles/postcards.mjs +68 -0
  148. package/resources/order-profiles/postcards.mjs.map +1 -0
  149. package/resources/order-profiles/self-mailers.d.ts +435 -0
  150. package/resources/order-profiles/self-mailers.d.ts.map +1 -0
  151. package/resources/order-profiles/self-mailers.js +75 -0
  152. package/resources/order-profiles/self-mailers.js.map +1 -0
  153. package/resources/order-profiles/self-mailers.mjs +70 -0
  154. package/resources/order-profiles/self-mailers.mjs.map +1 -0
  155. package/resources/order-profiles.d.ts +2 -0
  156. package/resources/order-profiles.d.ts.map +1 -0
  157. package/resources/order-profiles.js +19 -0
  158. package/resources/order-profiles.js.map +1 -0
  159. package/resources/order-profiles.mjs +3 -0
  160. package/resources/order-profiles.mjs.map +1 -0
  161. package/resources/postcards.d.ts +58 -8
  162. package/resources/postcards.d.ts.map +1 -1
  163. package/resources/postcards.js +26 -0
  164. package/resources/postcards.js.map +1 -1
  165. package/resources/postcards.mjs +26 -0
  166. package/resources/postcards.mjs.map +1 -1
  167. package/resources/reports/exports.d.ts +36 -3
  168. package/resources/reports/exports.d.ts.map +1 -1
  169. package/resources/reports/exports.js +27 -0
  170. package/resources/reports/exports.js.map +1 -1
  171. package/resources/reports/exports.mjs +27 -0
  172. package/resources/reports/exports.mjs.map +1 -1
  173. package/resources/reports/reports.d.ts +76 -8
  174. package/resources/reports/reports.d.ts.map +1 -1
  175. package/resources/reports/reports.js +44 -0
  176. package/resources/reports/reports.js.map +1 -1
  177. package/resources/reports/reports.mjs +44 -0
  178. package/resources/reports/reports.mjs.map +1 -1
  179. package/resources/self-mailers.d.ts +99 -15
  180. package/resources/self-mailers.d.ts.map +1 -1
  181. package/resources/self-mailers.js +38 -0
  182. package/resources/self-mailers.js.map +1 -1
  183. package/resources/self-mailers.mjs +38 -0
  184. package/resources/self-mailers.mjs.map +1 -1
  185. package/resources/shared.d.ts +6 -2
  186. package/resources/shared.d.ts.map +1 -1
  187. package/resources/sub-organizations.d.ts +394 -0
  188. package/resources/sub-organizations.d.ts.map +1 -0
  189. package/resources/sub-organizations.js +63 -0
  190. package/resources/sub-organizations.js.map +1 -0
  191. package/resources/sub-organizations.mjs +58 -0
  192. package/resources/sub-organizations.mjs.map +1 -0
  193. package/resources/templates.d.ts +43 -3
  194. package/resources/templates.d.ts.map +1 -1
  195. package/resources/templates.js +26 -0
  196. package/resources/templates.js.map +1 -1
  197. package/resources/templates.mjs +26 -0
  198. package/resources/templates.mjs.map +1 -1
  199. package/src/core.ts +17 -8
  200. package/src/index.ts +112 -11
  201. package/src/internal/qs/LICENSE.md +13 -0
  202. package/src/internal/qs/README.md +3 -0
  203. package/src/internal/qs/formats.ts +9 -0
  204. package/src/internal/qs/index.ts +13 -0
  205. package/src/internal/qs/stringify.ts +388 -0
  206. package/src/internal/qs/types.ts +71 -0
  207. package/src/internal/qs/utils.ts +265 -0
  208. package/src/pagination.ts +6 -1
  209. package/src/resource.ts +1 -1
  210. package/src/resources/bank-accounts.ts +57 -4
  211. package/src/resources/boxes.ts +50 -15
  212. package/src/resources/campaigns.ts +7 -7
  213. package/src/resources/cheques/cheques.ts +35 -4
  214. package/src/resources/cheques/url.ts +5 -0
  215. package/src/resources/cheques/with-deposit-ready-pdf.ts +6 -0
  216. package/src/resources/contacts.ts +31 -3
  217. package/src/resources/index.ts +39 -0
  218. package/src/resources/letters.ts +38 -6
  219. package/src/resources/mailing-list-imports.ts +1076 -0
  220. package/src/resources/mailing-lists.ts +511 -0
  221. package/src/resources/order-profiles/cheques.ts +888 -0
  222. package/src/resources/order-profiles/index.ts +55 -0
  223. package/src/resources/order-profiles/letters.ts +956 -0
  224. package/src/resources/order-profiles/order-profiles.ts +133 -0
  225. package/src/resources/order-profiles/postcards.ts +694 -0
  226. package/src/resources/order-profiles/self-mailers.ts +707 -0
  227. package/src/resources/order-profiles.ts +3 -0
  228. package/src/resources/postcards.ts +42 -8
  229. package/src/resources/reports/exports.ts +30 -3
  230. package/src/resources/reports/reports.ts +60 -8
  231. package/src/resources/self-mailers.ts +80 -14
  232. package/src/resources/shared.ts +2 -2
  233. package/src/resources/sub-organizations.ts +518 -0
  234. package/src/resources/templates.ts +37 -3
  235. package/src/version.ts +1 -1
  236. package/version.d.ts +1 -1
  237. package/version.js +1 -1
  238. package/version.mjs +1 -1
@@ -0,0 +1,888 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../resource';
4
+ import { isRequestOptions } from '../../core';
5
+ import * as Core from '../../core';
6
+ import * as ContactsAPI from '../contacts';
7
+ import { List, type ListParams } from '../../pagination';
8
+
9
+ export class Cheques extends APIResource {
10
+ /**
11
+ * Creates a new Cheque Profile. Requires a `bankAccount` ID. Can optionally
12
+ * include an attached letter via `letterHTML`, `letterTemplate`, or `letterPDF`.
13
+ * If providing `letterPDF` or `logo` (if logo needs upload, though schema suggests
14
+ * URL), use `multipart/form-data`.
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * const cheque = await client.orderProfiles.cheques.create({
19
+ * bankAccount: 'bankAccount',
20
+ * size: 'us_letter',
21
+ * });
22
+ * ```
23
+ */
24
+ create(params: ChequeCreateParams, options?: Core.RequestOptions): Core.APIPromise<ChequeCreateResponse> {
25
+ const { expand, ...body } = params;
26
+ return this._client.post('/order_profiles/cheques', { query: { expand }, body, ...options });
27
+ }
28
+
29
+ /**
30
+ * Retrieves the details of a specific Cheque Profile.
31
+ *
32
+ * @example
33
+ * ```ts
34
+ * const cheque = await client.orderProfiles.cheques.retrieve(
35
+ * 'id',
36
+ * );
37
+ * ```
38
+ */
39
+ retrieve(
40
+ id: string,
41
+ query?: ChequeRetrieveParams,
42
+ options?: Core.RequestOptions,
43
+ ): Core.APIPromise<ChequeRetrieveResponse>;
44
+ retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ChequeRetrieveResponse>;
45
+ retrieve(
46
+ id: string,
47
+ query: ChequeRetrieveParams | Core.RequestOptions = {},
48
+ options?: Core.RequestOptions,
49
+ ): Core.APIPromise<ChequeRetrieveResponse> {
50
+ if (isRequestOptions(query)) {
51
+ return this.retrieve(id, {}, query);
52
+ }
53
+ return this._client.get(`/order_profiles/cheques/${id}`, { query, ...options });
54
+ }
55
+
56
+ /**
57
+ * Updates specific fields of an existing Cheque Profile. If providing `letterPDF`
58
+ * or `logo`, use `multipart/form-data`.
59
+ *
60
+ * @example
61
+ * ```ts
62
+ * const cheque = await client.orderProfiles.cheques.update(
63
+ * 'id',
64
+ * { bankAccount: 'bankAccount', size: 'us_letter' },
65
+ * );
66
+ * ```
67
+ */
68
+ update(
69
+ id: string,
70
+ params: ChequeUpdateParams,
71
+ options?: Core.RequestOptions,
72
+ ): Core.APIPromise<ChequeUpdateResponse> {
73
+ const { expand, ...body } = params;
74
+ return this._client.post(`/order_profiles/cheques/${id}`, { query: { expand }, body, ...options });
75
+ }
76
+
77
+ /**
78
+ * Retrieves a list of Cheque Profiles.
79
+ *
80
+ * @example
81
+ * ```ts
82
+ * // Automatically fetches more pages as needed.
83
+ * for await (const chequeListResponse of client.orderProfiles.cheques.list()) {
84
+ * // ...
85
+ * }
86
+ * ```
87
+ */
88
+ list(
89
+ query?: ChequeListParams,
90
+ options?: Core.RequestOptions,
91
+ ): Core.PagePromise<ChequeListResponsesList, ChequeListResponse>;
92
+ list(options?: Core.RequestOptions): Core.PagePromise<ChequeListResponsesList, ChequeListResponse>;
93
+ list(
94
+ query: ChequeListParams | Core.RequestOptions = {},
95
+ options?: Core.RequestOptions,
96
+ ): Core.PagePromise<ChequeListResponsesList, ChequeListResponse> {
97
+ if (isRequestOptions(query)) {
98
+ return this.list({}, query);
99
+ }
100
+ return this._client.getAPIList('/order_profiles/cheques', ChequeListResponsesList, { query, ...options });
101
+ }
102
+
103
+ /**
104
+ * Deletes a Cheque Profile.
105
+ *
106
+ * @example
107
+ * ```ts
108
+ * const cheque = await client.orderProfiles.cheques.delete(
109
+ * 'id',
110
+ * );
111
+ * ```
112
+ */
113
+ delete(id: string, options?: Core.RequestOptions): Core.APIPromise<ChequeDeleteResponse> {
114
+ return this._client.delete(`/order_profiles/cheques/${id}`, options);
115
+ }
116
+ }
117
+
118
+ export class ChequeListResponsesList extends List<ChequeListResponse> {}
119
+
120
+ export interface ChequeCreateResponse {
121
+ /**
122
+ * Unique identifier for the order profile.
123
+ */
124
+ id: string;
125
+
126
+ /**
127
+ * ID of the bank account to use for the cheque. Required for creation.
128
+ */
129
+ bankAccount: string;
130
+
131
+ /**
132
+ * Timestamp when the profile was created.
133
+ */
134
+ createdAt: string;
135
+
136
+ /**
137
+ * Enum representing the supported currency codes.
138
+ */
139
+ currencyCode: 'CAD' | 'USD';
140
+
141
+ /**
142
+ * Indicates if the profile is associated with the live or test environment.
143
+ */
144
+ live: boolean;
145
+
146
+ /**
147
+ * Always `cheque_profile`.
148
+ */
149
+ object: 'cheque_profile';
150
+
151
+ /**
152
+ * Enum representing the supported cheque sizes.
153
+ */
154
+ size: 'us_letter' | 'us_legal';
155
+
156
+ /**
157
+ * Timestamp when the profile was last updated.
158
+ */
159
+ updatedAt: string;
160
+
161
+ /**
162
+ * An optional description for the profile. Set to `null` to remove during update.
163
+ */
164
+ description?: string | null;
165
+
166
+ /**
167
+ * HTML content for an optional attached letter. Cannot be used with
168
+ * `letterTemplate` or `letterPDF`.
169
+ */
170
+ letterHTML?: string;
171
+
172
+ /**
173
+ * ID of a template for an optional attached letter. Cannot be used with
174
+ * `letterHTML` or `letterPDF`.
175
+ */
176
+ letterTemplate?: string;
177
+
178
+ /**
179
+ * A temporary, signed URL to view the attached letter PDF, if any. Output only.
180
+ */
181
+ letterUploadedPDF?: string;
182
+
183
+ /**
184
+ * A publicly accessible URL for the logo to print on the cheque. Set to `null` to
185
+ * remove during update.
186
+ */
187
+ logo?: string | null;
188
+
189
+ /**
190
+ * Mailing class. Generally must be first class (or equivalent for destination
191
+ * country) for cheques.
192
+ */
193
+ mailingClass?:
194
+ | 'first_class'
195
+ | 'standard_class'
196
+ | 'express'
197
+ | 'certified'
198
+ | 'certified_return_receipt'
199
+ | 'registered'
200
+ | 'usps_first_class'
201
+ | 'usps_standard_class'
202
+ | 'usps_eddm'
203
+ | 'usps_express_2_day'
204
+ | 'usps_express_3_day'
205
+ | 'usps_first_class_certified'
206
+ | 'usps_first_class_certified_return_receipt'
207
+ | 'usps_first_class_registered'
208
+ | 'usps_express_3_day_signature_confirmation'
209
+ | 'usps_express_3_day_certified'
210
+ | 'usps_express_3_day_certified_return_receipt'
211
+ | 'ca_post_lettermail'
212
+ | 'ca_post_personalized'
213
+ | 'ca_post_neighbourhood_mail'
214
+ | 'ups_express_overnight'
215
+ | 'ups_express_2_day'
216
+ | 'ups_express_3_day'
217
+ | 'royal_mail_first_class'
218
+ | 'royal_mail_second_class'
219
+ | 'au_post_second_class';
220
+
221
+ /**
222
+ * Memo line text for the cheque. Set to `null` to remove during update.
223
+ */
224
+ memo?: string | null;
225
+
226
+ /**
227
+ * Default merge variables for orders created using this profile.
228
+ */
229
+ mergeVariables?: { [key: string]: unknown } | null;
230
+
231
+ /**
232
+ * Message included on the cheque stub. Set to `null` to remove during update.
233
+ */
234
+ message?: string | null;
235
+
236
+ /**
237
+ * Optional key-value metadata.
238
+ */
239
+ metadata?: { [key: string]: string } | null;
240
+
241
+ /**
242
+ * Contact details for redirection (output).
243
+ */
244
+ redirectTo?: ContactsAPI.Contact;
245
+ }
246
+
247
+ export interface ChequeRetrieveResponse {
248
+ /**
249
+ * Unique identifier for the order profile.
250
+ */
251
+ id: string;
252
+
253
+ /**
254
+ * ID of the bank account to use for the cheque. Required for creation.
255
+ */
256
+ bankAccount: string;
257
+
258
+ /**
259
+ * Timestamp when the profile was created.
260
+ */
261
+ createdAt: string;
262
+
263
+ /**
264
+ * Enum representing the supported currency codes.
265
+ */
266
+ currencyCode: 'CAD' | 'USD';
267
+
268
+ /**
269
+ * Indicates if the profile is associated with the live or test environment.
270
+ */
271
+ live: boolean;
272
+
273
+ /**
274
+ * Always `cheque_profile`.
275
+ */
276
+ object: 'cheque_profile';
277
+
278
+ /**
279
+ * Enum representing the supported cheque sizes.
280
+ */
281
+ size: 'us_letter' | 'us_legal';
282
+
283
+ /**
284
+ * Timestamp when the profile was last updated.
285
+ */
286
+ updatedAt: string;
287
+
288
+ /**
289
+ * An optional description for the profile. Set to `null` to remove during update.
290
+ */
291
+ description?: string | null;
292
+
293
+ /**
294
+ * HTML content for an optional attached letter. Cannot be used with
295
+ * `letterTemplate` or `letterPDF`.
296
+ */
297
+ letterHTML?: string;
298
+
299
+ /**
300
+ * ID of a template for an optional attached letter. Cannot be used with
301
+ * `letterHTML` or `letterPDF`.
302
+ */
303
+ letterTemplate?: string;
304
+
305
+ /**
306
+ * A temporary, signed URL to view the attached letter PDF, if any. Output only.
307
+ */
308
+ letterUploadedPDF?: string;
309
+
310
+ /**
311
+ * A publicly accessible URL for the logo to print on the cheque. Set to `null` to
312
+ * remove during update.
313
+ */
314
+ logo?: string | null;
315
+
316
+ /**
317
+ * Mailing class. Generally must be first class (or equivalent for destination
318
+ * country) for cheques.
319
+ */
320
+ mailingClass?:
321
+ | 'first_class'
322
+ | 'standard_class'
323
+ | 'express'
324
+ | 'certified'
325
+ | 'certified_return_receipt'
326
+ | 'registered'
327
+ | 'usps_first_class'
328
+ | 'usps_standard_class'
329
+ | 'usps_eddm'
330
+ | 'usps_express_2_day'
331
+ | 'usps_express_3_day'
332
+ | 'usps_first_class_certified'
333
+ | 'usps_first_class_certified_return_receipt'
334
+ | 'usps_first_class_registered'
335
+ | 'usps_express_3_day_signature_confirmation'
336
+ | 'usps_express_3_day_certified'
337
+ | 'usps_express_3_day_certified_return_receipt'
338
+ | 'ca_post_lettermail'
339
+ | 'ca_post_personalized'
340
+ | 'ca_post_neighbourhood_mail'
341
+ | 'ups_express_overnight'
342
+ | 'ups_express_2_day'
343
+ | 'ups_express_3_day'
344
+ | 'royal_mail_first_class'
345
+ | 'royal_mail_second_class'
346
+ | 'au_post_second_class';
347
+
348
+ /**
349
+ * Memo line text for the cheque. Set to `null` to remove during update.
350
+ */
351
+ memo?: string | null;
352
+
353
+ /**
354
+ * Default merge variables for orders created using this profile.
355
+ */
356
+ mergeVariables?: { [key: string]: unknown } | null;
357
+
358
+ /**
359
+ * Message included on the cheque stub. Set to `null` to remove during update.
360
+ */
361
+ message?: string | null;
362
+
363
+ /**
364
+ * Optional key-value metadata.
365
+ */
366
+ metadata?: { [key: string]: string } | null;
367
+
368
+ /**
369
+ * Contact details for redirection (output).
370
+ */
371
+ redirectTo?: ContactsAPI.Contact;
372
+ }
373
+
374
+ export interface ChequeUpdateResponse {
375
+ /**
376
+ * Unique identifier for the order profile.
377
+ */
378
+ id: string;
379
+
380
+ /**
381
+ * ID of the bank account to use for the cheque. Required for creation.
382
+ */
383
+ bankAccount: string;
384
+
385
+ /**
386
+ * Timestamp when the profile was created.
387
+ */
388
+ createdAt: string;
389
+
390
+ /**
391
+ * Enum representing the supported currency codes.
392
+ */
393
+ currencyCode: 'CAD' | 'USD';
394
+
395
+ /**
396
+ * Indicates if the profile is associated with the live or test environment.
397
+ */
398
+ live: boolean;
399
+
400
+ /**
401
+ * Always `cheque_profile`.
402
+ */
403
+ object: 'cheque_profile';
404
+
405
+ /**
406
+ * Enum representing the supported cheque sizes.
407
+ */
408
+ size: 'us_letter' | 'us_legal';
409
+
410
+ /**
411
+ * Timestamp when the profile was last updated.
412
+ */
413
+ updatedAt: string;
414
+
415
+ /**
416
+ * An optional description for the profile. Set to `null` to remove during update.
417
+ */
418
+ description?: string | null;
419
+
420
+ /**
421
+ * HTML content for an optional attached letter. Cannot be used with
422
+ * `letterTemplate` or `letterPDF`.
423
+ */
424
+ letterHTML?: string;
425
+
426
+ /**
427
+ * ID of a template for an optional attached letter. Cannot be used with
428
+ * `letterHTML` or `letterPDF`.
429
+ */
430
+ letterTemplate?: string;
431
+
432
+ /**
433
+ * A temporary, signed URL to view the attached letter PDF, if any. Output only.
434
+ */
435
+ letterUploadedPDF?: string;
436
+
437
+ /**
438
+ * A publicly accessible URL for the logo to print on the cheque. Set to `null` to
439
+ * remove during update.
440
+ */
441
+ logo?: string | null;
442
+
443
+ /**
444
+ * Mailing class. Generally must be first class (or equivalent for destination
445
+ * country) for cheques.
446
+ */
447
+ mailingClass?:
448
+ | 'first_class'
449
+ | 'standard_class'
450
+ | 'express'
451
+ | 'certified'
452
+ | 'certified_return_receipt'
453
+ | 'registered'
454
+ | 'usps_first_class'
455
+ | 'usps_standard_class'
456
+ | 'usps_eddm'
457
+ | 'usps_express_2_day'
458
+ | 'usps_express_3_day'
459
+ | 'usps_first_class_certified'
460
+ | 'usps_first_class_certified_return_receipt'
461
+ | 'usps_first_class_registered'
462
+ | 'usps_express_3_day_signature_confirmation'
463
+ | 'usps_express_3_day_certified'
464
+ | 'usps_express_3_day_certified_return_receipt'
465
+ | 'ca_post_lettermail'
466
+ | 'ca_post_personalized'
467
+ | 'ca_post_neighbourhood_mail'
468
+ | 'ups_express_overnight'
469
+ | 'ups_express_2_day'
470
+ | 'ups_express_3_day'
471
+ | 'royal_mail_first_class'
472
+ | 'royal_mail_second_class'
473
+ | 'au_post_second_class';
474
+
475
+ /**
476
+ * Memo line text for the cheque. Set to `null` to remove during update.
477
+ */
478
+ memo?: string | null;
479
+
480
+ /**
481
+ * Default merge variables for orders created using this profile.
482
+ */
483
+ mergeVariables?: { [key: string]: unknown } | null;
484
+
485
+ /**
486
+ * Message included on the cheque stub. Set to `null` to remove during update.
487
+ */
488
+ message?: string | null;
489
+
490
+ /**
491
+ * Optional key-value metadata.
492
+ */
493
+ metadata?: { [key: string]: string } | null;
494
+
495
+ /**
496
+ * Contact details for redirection (output).
497
+ */
498
+ redirectTo?: ContactsAPI.Contact;
499
+ }
500
+
501
+ export interface ChequeListResponse {
502
+ /**
503
+ * Unique identifier for the order profile.
504
+ */
505
+ id: string;
506
+
507
+ /**
508
+ * ID of the bank account to use for the cheque. Required for creation.
509
+ */
510
+ bankAccount: string;
511
+
512
+ /**
513
+ * Timestamp when the profile was created.
514
+ */
515
+ createdAt: string;
516
+
517
+ /**
518
+ * Indicates if the profile is associated with the live or test environment.
519
+ */
520
+ live: boolean;
521
+
522
+ /**
523
+ * Always `cheque_profile`.
524
+ */
525
+ object: 'cheque_profile';
526
+
527
+ /**
528
+ * Enum representing the supported cheque sizes.
529
+ */
530
+ size: 'us_letter' | 'us_legal';
531
+
532
+ /**
533
+ * Timestamp when the profile was last updated.
534
+ */
535
+ updatedAt: string;
536
+
537
+ /**
538
+ * An optional description for the profile. Set to `null` to remove during update.
539
+ */
540
+ description?: string | null;
541
+
542
+ /**
543
+ * HTML content for an optional attached letter. Cannot be used with
544
+ * `letterTemplate` or `letterPDF`.
545
+ */
546
+ letterHTML?: string;
547
+
548
+ /**
549
+ * ID of a template for an optional attached letter. Cannot be used with
550
+ * `letterHTML` or `letterPDF`.
551
+ */
552
+ letterTemplate?: string;
553
+
554
+ /**
555
+ * A temporary, signed URL to view the attached letter PDF, if any. Output only.
556
+ */
557
+ letterUploadedPDF?: string;
558
+
559
+ /**
560
+ * A publicly accessible URL for the logo to print on the cheque. Set to `null` to
561
+ * remove during update.
562
+ */
563
+ logo?: string | null;
564
+
565
+ /**
566
+ * Mailing class. Generally must be first class (or equivalent for destination
567
+ * country) for cheques.
568
+ */
569
+ mailingClass?:
570
+ | 'first_class'
571
+ | 'standard_class'
572
+ | 'express'
573
+ | 'certified'
574
+ | 'certified_return_receipt'
575
+ | 'registered'
576
+ | 'usps_first_class'
577
+ | 'usps_standard_class'
578
+ | 'usps_eddm'
579
+ | 'usps_express_2_day'
580
+ | 'usps_express_3_day'
581
+ | 'usps_first_class_certified'
582
+ | 'usps_first_class_certified_return_receipt'
583
+ | 'usps_first_class_registered'
584
+ | 'usps_express_3_day_signature_confirmation'
585
+ | 'usps_express_3_day_certified'
586
+ | 'usps_express_3_day_certified_return_receipt'
587
+ | 'ca_post_lettermail'
588
+ | 'ca_post_personalized'
589
+ | 'ca_post_neighbourhood_mail'
590
+ | 'ups_express_overnight'
591
+ | 'ups_express_2_day'
592
+ | 'ups_express_3_day'
593
+ | 'royal_mail_first_class'
594
+ | 'royal_mail_second_class'
595
+ | 'au_post_second_class';
596
+
597
+ /**
598
+ * Memo line text for the cheque. Set to `null` to remove during update.
599
+ */
600
+ memo?: string | null;
601
+
602
+ /**
603
+ * Default merge variables for orders created using this profile.
604
+ */
605
+ mergeVariables?: { [key: string]: unknown } | null;
606
+
607
+ /**
608
+ * Message included on the cheque stub. Set to `null` to remove during update.
609
+ */
610
+ message?: string | null;
611
+
612
+ /**
613
+ * Optional key-value metadata.
614
+ */
615
+ metadata?: { [key: string]: string } | null;
616
+
617
+ /**
618
+ * Contact details for redirection (output).
619
+ */
620
+ redirectTo?: ContactsAPI.Contact;
621
+ }
622
+
623
+ export interface ChequeDeleteResponse {
624
+ /**
625
+ * Unique identifier for the order profile.
626
+ */
627
+ id: string;
628
+
629
+ deleted: true;
630
+
631
+ /**
632
+ * Always `cheque_profile`.
633
+ */
634
+ object: 'cheque_profile';
635
+ }
636
+
637
+ export interface ChequeCreateParams {
638
+ /**
639
+ * Body param: ID of the bank account to use for the cheque. Required for creation.
640
+ */
641
+ bankAccount: string;
642
+
643
+ /**
644
+ * Body param: Enum representing the supported cheque sizes.
645
+ */
646
+ size: 'us_letter' | 'us_legal';
647
+
648
+ /**
649
+ * Query param: Optional list of related resources to expand in the response.
650
+ */
651
+ expand?: Array<string>;
652
+
653
+ /**
654
+ * Body param: Enum representing the supported currency codes.
655
+ */
656
+ currencyCode?: 'CAD' | 'USD';
657
+
658
+ /**
659
+ * Body param: An optional description for the profile. Set to `null` to remove
660
+ * during update.
661
+ */
662
+ description?: string | null;
663
+
664
+ /**
665
+ * Body param: HTML content for an optional attached letter. Cannot be used with
666
+ * `letterTemplate` or `letterPDF`.
667
+ */
668
+ letterHTML?: string;
669
+
670
+ /**
671
+ * Body param: PDF file for an optional attached letter. Cannot be used with
672
+ * `letterHTML` or `letterTemplate`. Input only.
673
+ */
674
+ letterPDF?: string;
675
+
676
+ /**
677
+ * Body param: ID of a template for an optional attached letter. Cannot be used
678
+ * with `letterHTML` or `letterPDF`.
679
+ */
680
+ letterTemplate?: string;
681
+
682
+ /**
683
+ * Body param: A publicly accessible URL for the logo to print on the cheque. Set
684
+ * to `null` to remove during update.
685
+ */
686
+ logo?: string | null;
687
+
688
+ /**
689
+ * Body param: Mailing class. Generally must be first class (or equivalent for
690
+ * destination country) for cheques.
691
+ */
692
+ mailingClass?:
693
+ | 'first_class'
694
+ | 'standard_class'
695
+ | 'express'
696
+ | 'certified'
697
+ | 'certified_return_receipt'
698
+ | 'registered'
699
+ | 'usps_first_class'
700
+ | 'usps_standard_class'
701
+ | 'usps_eddm'
702
+ | 'usps_express_2_day'
703
+ | 'usps_express_3_day'
704
+ | 'usps_first_class_certified'
705
+ | 'usps_first_class_certified_return_receipt'
706
+ | 'usps_first_class_registered'
707
+ | 'usps_express_3_day_signature_confirmation'
708
+ | 'usps_express_3_day_certified'
709
+ | 'usps_express_3_day_certified_return_receipt'
710
+ | 'ca_post_lettermail'
711
+ | 'ca_post_personalized'
712
+ | 'ca_post_neighbourhood_mail'
713
+ | 'ups_express_overnight'
714
+ | 'ups_express_2_day'
715
+ | 'ups_express_3_day'
716
+ | 'royal_mail_first_class'
717
+ | 'royal_mail_second_class'
718
+ | 'au_post_second_class';
719
+
720
+ /**
721
+ * Body param: Memo line text for the cheque. Set to `null` to remove during
722
+ * update.
723
+ */
724
+ memo?: string | null;
725
+
726
+ /**
727
+ * Body param: Default merge variables for orders created using this profile.
728
+ */
729
+ mergeVariables?: { [key: string]: unknown } | null;
730
+
731
+ /**
732
+ * Body param: Message included on the cheque stub. Set to `null` to remove during
733
+ * update.
734
+ */
735
+ message?: string | null;
736
+
737
+ /**
738
+ * Body param: Optional key-value metadata.
739
+ */
740
+ metadata?: { [key: string]: string } | null;
741
+ }
742
+
743
+ export interface ChequeRetrieveParams {
744
+ /**
745
+ * Optional list of related resources to expand in the response.
746
+ */
747
+ expand?: Array<string>;
748
+ }
749
+
750
+ export interface ChequeUpdateParams {
751
+ /**
752
+ * Body param: ID of the bank account to use for the cheque. Required for creation.
753
+ */
754
+ bankAccount: string;
755
+
756
+ /**
757
+ * Body param: Enum representing the supported cheque sizes.
758
+ */
759
+ size: 'us_letter' | 'us_legal';
760
+
761
+ /**
762
+ * Query param: Optional list of related resources to expand in the response.
763
+ */
764
+ expand?: Array<string>;
765
+
766
+ /**
767
+ * Body param: Enum representing the supported currency codes.
768
+ */
769
+ currencyCode?: 'CAD' | 'USD';
770
+
771
+ /**
772
+ * Body param: An optional description for the profile. Set to `null` to remove
773
+ * during update.
774
+ */
775
+ description?: string | null;
776
+
777
+ /**
778
+ * Body param: Set explicitly to `null` during an update operation to remove the
779
+ * attached letter.
780
+ */
781
+ letter?: unknown;
782
+
783
+ /**
784
+ * Body param: HTML content for an optional attached letter. Cannot be used with
785
+ * `letterTemplate` or `letterPDF`.
786
+ */
787
+ letterHTML?: string;
788
+
789
+ /**
790
+ * Body param: PDF file for an optional attached letter. Cannot be used with
791
+ * `letterHTML` or `letterTemplate`. Input only.
792
+ */
793
+ letterPDF?: string;
794
+
795
+ /**
796
+ * Body param: ID of a template for an optional attached letter. Cannot be used
797
+ * with `letterHTML` or `letterPDF`.
798
+ */
799
+ letterTemplate?: string;
800
+
801
+ /**
802
+ * Body param: A publicly accessible URL for the logo to print on the cheque. Set
803
+ * to `null` to remove during update.
804
+ */
805
+ logo?: string | null;
806
+
807
+ /**
808
+ * Body param: Mailing class. Generally must be first class (or equivalent for
809
+ * destination country) for cheques.
810
+ */
811
+ mailingClass?:
812
+ | 'first_class'
813
+ | 'standard_class'
814
+ | 'express'
815
+ | 'certified'
816
+ | 'certified_return_receipt'
817
+ | 'registered'
818
+ | 'usps_first_class'
819
+ | 'usps_standard_class'
820
+ | 'usps_eddm'
821
+ | 'usps_express_2_day'
822
+ | 'usps_express_3_day'
823
+ | 'usps_first_class_certified'
824
+ | 'usps_first_class_certified_return_receipt'
825
+ | 'usps_first_class_registered'
826
+ | 'usps_express_3_day_signature_confirmation'
827
+ | 'usps_express_3_day_certified'
828
+ | 'usps_express_3_day_certified_return_receipt'
829
+ | 'ca_post_lettermail'
830
+ | 'ca_post_personalized'
831
+ | 'ca_post_neighbourhood_mail'
832
+ | 'ups_express_overnight'
833
+ | 'ups_express_2_day'
834
+ | 'ups_express_3_day'
835
+ | 'royal_mail_first_class'
836
+ | 'royal_mail_second_class'
837
+ | 'au_post_second_class';
838
+
839
+ /**
840
+ * Body param: Memo line text for the cheque. Set to `null` to remove during
841
+ * update.
842
+ */
843
+ memo?: string | null;
844
+
845
+ /**
846
+ * Body param: Default merge variables for orders created using this profile.
847
+ */
848
+ mergeVariables?: { [key: string]: unknown } | null;
849
+
850
+ /**
851
+ * Body param: Message included on the cheque stub. Set to `null` to remove during
852
+ * update.
853
+ */
854
+ message?: string | null;
855
+
856
+ /**
857
+ * Body param: Optional key-value metadata.
858
+ */
859
+ metadata?: { [key: string]: string } | null;
860
+ }
861
+
862
+ export interface ChequeListParams extends ListParams {
863
+ /**
864
+ * You can supply any string to help narrow down the list of resources. For
865
+ * example, if you pass `"New York"` (quoted), it will return resources that have
866
+ * that string present somewhere in their response. Alternatively, you can supply a
867
+ * structured search query. See the documentation on `StructuredSearchQuery` for
868
+ * more details.
869
+ */
870
+ search?: string;
871
+ }
872
+
873
+ Cheques.ChequeListResponsesList = ChequeListResponsesList;
874
+
875
+ export declare namespace Cheques {
876
+ export {
877
+ type ChequeCreateResponse as ChequeCreateResponse,
878
+ type ChequeRetrieveResponse as ChequeRetrieveResponse,
879
+ type ChequeUpdateResponse as ChequeUpdateResponse,
880
+ type ChequeListResponse as ChequeListResponse,
881
+ type ChequeDeleteResponse as ChequeDeleteResponse,
882
+ ChequeListResponsesList as ChequeListResponsesList,
883
+ type ChequeCreateParams as ChequeCreateParams,
884
+ type ChequeRetrieveParams as ChequeRetrieveParams,
885
+ type ChequeUpdateParams as ChequeUpdateParams,
886
+ type ChequeListParams as ChequeListParams,
887
+ };
888
+ }