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

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 +47 -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 +1 -1
  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
package/resources/postcards.d.ts CHANGED
@@ -12,19 +12,48 @@ export declare class Postcards extends APIResource {
12
12
  * - A URL or file for a 2 page PDF where the first page is the front of the
13
13
  * postcard and the second page is the back
14
14
  * - Upload the aforementioned PDF file via a multipart form upload request
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * const postcard = await client.postcards.create({
19
+ * backHTML: '<html>Back</html>',
20
+ * frontHTML: '<html>Front</html>',
21
+ * size: '6x4',
22
+ * to: 'contact_456',
23
+ * from: 'contact_123',
24
+ * });
25
+ * ```
15
26
  */
16
27
  create(body: PostcardCreateParams, options?: Core.RequestOptions): Core.APIPromise<Postcard>;
17
28
  /**
18
29
  * Retrieve a postcard by ID.
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * const postcard = await client.postcards.retrieve('id');
34
+ * ```
19
35
  */
20
36
  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Postcard>;
21
37
  /**
22
38
  * Get a list of postcards.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * // Automatically fetches more pages as needed.
43
+ * for await (const postcard of client.postcards.list()) {
44
+ * // ...
45
+ * }
46
+ * ```
23
47
  */
24
48
  list(query?: PostcardListParams, options?: Core.RequestOptions): Core.PagePromise<PostcardsList, Postcard>;
25
49
  list(options?: Core.RequestOptions): Core.PagePromise<PostcardsList, Postcard>;
26
50
  /**
27
51
  * Cancel a postcard by ID. Note that this operation cannot be undone.
52
+ *
53
+ * @example
54
+ * ```ts
55
+ * const postcard = await client.postcards.delete('id');
56
+ * ```
28
57
  */
29
58
  delete(id: string, options?: Core.RequestOptions): Core.APIPromise<Postcard>;
30
59
  /**
@@ -34,6 +63,11 @@ export declare class Postcards extends APIResource {
34
63
  * offers document generation and hosting capabilities. This endpoint has a much
35
64
  * higher rate limit than the regular order retrieval endpoint, so it is suitable
36
65
  * for customer-facing use-cases.
66
+ *
67
+ * @example
68
+ * ```ts
69
+ * const response = await client.postcards.url('id');
70
+ * ```
37
71
  */
38
72
  url(id: string, options?: Core.RequestOptions): Core.APIPromise<PostcardURLResponse>;
39
73
  }
@@ -119,11 +153,15 @@ export interface Postcard {
119
153
  * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
120
154
  * PDFs uploaded with the order.
121
155
  */
122
- mergeVariables?: Record<string, unknown>;
156
+ mergeVariables?: {
157
+ [key: string]: unknown;
158
+ };
123
159
  /**
124
160
  * See the section on Metadata.
125
161
  */
126
- metadata?: Record<string, unknown>;
162
+ metadata?: {
163
+ [key: string]: unknown;
164
+ };
127
165
  /**
128
166
  * The tracking number of this order. Populated after an express/certified order
129
167
  * has been processed for delivery.
@@ -206,11 +244,15 @@ export declare namespace PostcardCreateParams {
206
244
  * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
207
245
  * PDFs uploaded with the order.
208
246
  */
209
- mergeVariables?: Record<string, unknown>;
247
+ mergeVariables?: {
248
+ [key: string]: unknown;
249
+ };
210
250
  /**
211
251
  * See the section on Metadata.
212
252
  */
213
- metadata?: Record<string, unknown>;
253
+ metadata?: {
254
+ [key: string]: unknown;
255
+ };
214
256
  /**
215
257
  * This order will transition from `ready` to `printing` on the day after this
216
258
  * date. You can use this parameter to schedule orders for a future date.
@@ -268,11 +310,15 @@ export declare namespace PostcardCreateParams {
268
310
  * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
269
311
  * PDFs uploaded with the order.
270
312
  */
271
- mergeVariables?: Record<string, unknown>;
313
+ mergeVariables?: {
314
+ [key: string]: unknown;
315
+ };
272
316
  /**
273
317
  * See the section on Metadata.
274
318
  */
275
- metadata?: Record<string, unknown>;
319
+ metadata?: {
320
+ [key: string]: unknown;
321
+ };
276
322
  /**
277
323
  * This order will transition from `ready` to `printing` on the day after this
278
324
  * date. You can use this parameter to schedule orders for a future date.
@@ -318,11 +364,15 @@ export declare namespace PostcardCreateParams {
318
364
  * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
319
365
  * PDFs uploaded with the order.
320
366
  */
321
- mergeVariables?: Record<string, unknown>;
367
+ mergeVariables?: {
368
+ [key: string]: unknown;
369
+ };
322
370
  /**
323
371
  * See the section on Metadata.
324
372
  */
325
- metadata?: Record<string, unknown>;
373
+ metadata?: {
374
+ [key: string]: unknown;
375
+ };
326
376
  /**
327
377
  * This order will transition from `ready` to `printing` on the day after this
328
378
  * date. You can use this parameter to schedule orders for a future date.
package/resources/postcards.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"postcards.d.ts","sourceRoot":"","sources":["../src/resources/postcards.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;IAI5F;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;IAI9E;;OAEG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,QAAQ,CAAC;IAC1G,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,QAAQ,CAAC;IAW9E;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;IAI5E;;;;;;;OAOG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGrF;AAED,qBAAa,aAAc,SAAQ,IAAI,CAAC,QAAQ,CAAC;CAAG;AAEpD,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEtB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,oBAAoB,GAC5B,oBAAoB,CAAC,sBAAsB,GAC3C,oBAAoB,CAAC,0BAA0B,GAC/C,oBAAoB,CAAC,wBAAwB,GAC7C,oBAAoB,CAAC,yBAAyB,CAAC;AAEnD,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,UAAiB,sBAAsB;QACrC;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAExF;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,0BAA0B;QACzC;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAExF;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,yBAAyB;QACxC;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAExF;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzC;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEnC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,aAAa,IAAI,aAAa,EAC9B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
1
+ {"version":3,"file":"postcards.d.ts","sourceRoot":"","sources":["../src/resources/postcards.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAChC,OAAO,KAAK,WAAW,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAC;AAEtD,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;IAI5F;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;IAI9E;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,QAAQ,CAAC;IAC1G,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,QAAQ,CAAC;IAW9E;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;IAI5E;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;CAGrF;AAED,qBAAa,aAAc,SAAQ,IAAI,CAAC,QAAQ,CAAC;CAAG;AAEpD,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;;OAGG;IACH,YAAY,EACR,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;IAE3B;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,UAAU,GAAG,wBAAwB,GAAG,WAAW,GAAG,WAAW,CAAC;IAEpF;;;OAGG;IACH,EAAE,EAAE,WAAW,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,YAAY,CAAC;IAEnC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9E;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,cAAc,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;;;OASG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEtB,KAAK,EAAE,MAAM,CAAC;IAEd,MAAM,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE,MAAM,CAAC;IAEb,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,oBAAoB,GAC5B,oBAAoB,CAAC,sBAAsB,GAC3C,oBAAoB,CAAC,0BAA0B,GAC/C,oBAAoB,CAAC,wBAAwB,GAC7C,oBAAoB,CAAC,yBAAyB,CAAC;AAEnD,MAAM,CAAC,OAAO,WAAW,oBAAoB,CAAC;IAC5C,UAAiB,sBAAsB;QACrC;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAExF;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,0BAA0B;QACzC;;;WAGG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,wBAAwB;QACvC;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAExF;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,yBAAyB;QACxC;;;WAGG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;QAE7B;;;;;WAKG;QACH,EAAE,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAErF;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,0BAA0B,GAAG,MAAM,CAAC,4BAA4B,GAAG,MAAM,CAAC;QAExF;;;WAGG;QACH,YAAY,CAAC,EACT,aAAa,GACb,gBAAgB,GAChB,SAAS,GACT,WAAW,GACX,0BAA0B,GAC1B,YAAY,GACZ,kBAAkB,GAClB,qBAAqB,GACrB,WAAW,GACX,oBAAoB,GACpB,oBAAoB,GACpB,4BAA4B,GAC5B,2CAA2C,GAC3C,6BAA6B,GAC7B,2CAA2C,GAC3C,8BAA8B,GAC9B,6CAA6C,GAC7C,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,GAC5B,uBAAuB,GACvB,mBAAmB,GACnB,mBAAmB,GACnB,wBAAwB,GACxB,yBAAyB,GACzB,sBAAsB,CAAC;QAE3B;;;;;WAKG;QACH,cAAc,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE5C;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAEtC;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,aAAa,IAAI,aAAa,EAC9B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
package/resources/postcards.js CHANGED
@@ -14,12 +14,28 @@ class Postcards extends resource_1.APIResource {
14
14
  * - A URL or file for a 2 page PDF where the first page is the front of the
15
15
  * postcard and the second page is the back
16
16
  * - Upload the aforementioned PDF file via a multipart form upload request
17
+ *
18
+ * @example
19
+ * ```ts
20
+ * const postcard = await client.postcards.create({
21
+ * backHTML: '<html>Back</html>',
22
+ * frontHTML: '<html>Front</html>',
23
+ * size: '6x4',
24
+ * to: 'contact_456',
25
+ * from: 'contact_123',
26
+ * });
27
+ * ```
17
28
  */
18
29
  create(body, options) {
19
30
  return this._client.post('/postcards', { body, ...options });
20
31
  }
21
32
  /**
22
33
  * Retrieve a postcard by ID.
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * const postcard = await client.postcards.retrieve('id');
38
+ * ```
23
39
  */
24
40
  retrieve(id, options) {
25
41
  return this._client.get(`/postcards/${id}`, options);
@@ -32,6 +48,11 @@ class Postcards extends resource_1.APIResource {
32
48
  }
33
49
  /**
34
50
  * Cancel a postcard by ID. Note that this operation cannot be undone.
51
+ *
52
+ * @example
53
+ * ```ts
54
+ * const postcard = await client.postcards.delete('id');
55
+ * ```
35
56
  */
36
57
  delete(id, options) {
37
58
  return this._client.delete(`/postcards/${id}`, options);
@@ -43,6 +64,11 @@ class Postcards extends resource_1.APIResource {
43
64
  * offers document generation and hosting capabilities. This endpoint has a much
44
65
  * higher rate limit than the regular order retrieval endpoint, so it is suitable
45
66
  * for customer-facing use-cases.
67
+ *
68
+ * @example
69
+ * ```ts
70
+ * const response = await client.postcards.url('id');
71
+ * ```
46
72
  */
47
73
  url(id, options) {
48
74
  return this._client.get(`/postcards/${id}/url`, options);
package/resources/postcards.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"postcards.js","sourceRoot":"","sources":["../src/resources/postcards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAI3C,iDAAsD;AAEtD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAOD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAA6B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAtDD,8BAsDC;AAED,MAAa,aAAc,SAAQ,iBAAc;CAAG;AAApD,sCAAoD;AAudpD,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC"}
1
+ {"version":3,"file":"postcards.js","sourceRoot":"","sources":["../src/resources/postcards.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAC1C,qCAA2C;AAI3C,iDAAsD;AAEtD,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAeD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAU,EAAE,OAA6B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAxFD,8BAwFC;AAED,MAAa,aAAc,SAAQ,iBAAc;CAAG;AAApD,sCAAoD;AAudpD,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC"}
package/resources/postcards.mjs CHANGED
@@ -11,12 +11,28 @@ export class Postcards extends APIResource {
11
11
  * - A URL or file for a 2 page PDF where the first page is the front of the
12
12
  * postcard and the second page is the back
13
13
  * - Upload the aforementioned PDF file via a multipart form upload request
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * const postcard = await client.postcards.create({
18
+ * backHTML: '<html>Back</html>',
19
+ * frontHTML: '<html>Front</html>',
20
+ * size: '6x4',
21
+ * to: 'contact_456',
22
+ * from: 'contact_123',
23
+ * });
24
+ * ```
14
25
  */
15
26
  create(body, options) {
16
27
  return this._client.post('/postcards', { body, ...options });
17
28
  }
18
29
  /**
19
30
  * Retrieve a postcard by ID.
31
+ *
32
+ * @example
33
+ * ```ts
34
+ * const postcard = await client.postcards.retrieve('id');
35
+ * ```
20
36
  */
21
37
  retrieve(id, options) {
22
38
  return this._client.get(`/postcards/${id}`, options);
@@ -29,6 +45,11 @@ export class Postcards extends APIResource {
29
45
  }
30
46
  /**
31
47
  * Cancel a postcard by ID. Note that this operation cannot be undone.
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * const postcard = await client.postcards.delete('id');
52
+ * ```
32
53
  */
33
54
  delete(id, options) {
34
55
  return this._client.delete(`/postcards/${id}`, options);
@@ -40,6 +61,11 @@ export class Postcards extends APIResource {
40
61
  * offers document generation and hosting capabilities. This endpoint has a much
41
62
  * higher rate limit than the regular order retrieval endpoint, so it is suitable
42
63
  * for customer-facing use-cases.
64
+ *
65
+ * @example
66
+ * ```ts
67
+ * const response = await client.postcards.url('id');
68
+ * ```
43
69
  */
44
70
  url(id, options) {
45
71
  return this._client.get(`/postcards/${id}/url`, options);
package/resources/postcards.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"postcards.mjs","sourceRoot":"","sources":["../src/resources/postcards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;OAQG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAOD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,EAAU,EAAE,OAA6B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,IAAc;CAAG;AAudpD,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC"}
1
+ {"version":3,"file":"postcards.mjs","sourceRoot":"","sources":["../src/resources/postcards.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAIpB,EAAE,IAAI,EAAmB;AAEhC,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAA6B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC;IAeD,IAAI,CACF,QAAkD,EAAE,EACpD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,EAAU,EAAE,OAA6B;QAC9C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAU,EAAE,OAA6B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3D,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,IAAc;CAAG;AAudpD,SAAS,CAAC,aAAa,GAAG,aAAa,CAAC"}
package/resources/reports/exports.d.ts CHANGED
@@ -6,17 +6,44 @@ export declare class Exports extends APIResource {
6
6
  * asynchronously and generates a downloadable CSV file with the full results. Your
7
7
  * queries can run for up to 13 minutes the resulting file can be up to 100mb
8
8
  * large.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const _export = await client.reports.exports.create(
13
+ * 'reportID',
14
+ * {
15
+ * description: 'October Orders Export',
16
+ * params: ['2023-10-01T00:00:00Z'],
17
+ * },
18
+ * );
19
+ * ```
9
20
  */
10
21
  create(reportId: string, body: ExportCreateParams, options?: Core.RequestOptions): Core.APIPromise<ExportCreateResponse>;
11
22
  /**
12
23
  * Retrieve the status and details of a specific report export job. Check the
13
24
  * `outputURL` property for the download link once generation is complete.
25
+ *
26
+ * @example
27
+ * ```ts
28
+ * const _export = await client.reports.exports.retrieve(
29
+ * 'reportID',
30
+ * 'exportID',
31
+ * );
32
+ * ```
14
33
  */
15
34
  retrieve(reportId: string, exportId: string, options?: Core.RequestOptions): Core.APIPromise<ExportRetrieveResponse>;
16
35
  /**
17
36
  * Delete a completed or failed report export job and its associated output file
18
37
  * (if any). This action cannot be undone. You cannot delete an export that is
19
38
  * still generating.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * const _export = await client.reports.exports.delete(
43
+ * 'reportID',
44
+ * 'exportID',
45
+ * );
46
+ * ```
20
47
  */
21
48
  delete(reportId: string, exportId: string, options?: Core.RequestOptions): Core.APIPromise<ExportDeleteResponse>;
22
49
  }
@@ -59,7 +86,9 @@ export interface ExportCreateResponse {
59
86
  /**
60
87
  * Optional key-value metadata associated with the export.
61
88
  */
62
- metadata?: Record<string, string>;
89
+ metadata?: {
90
+ [key: string]: string;
91
+ };
63
92
  /**
64
93
  * A signed URL to download the exported data (CSV format). Available when
65
94
  * generation is complete and successful.
@@ -136,7 +165,9 @@ export interface ExportRetrieveResponse {
136
165
  /**
137
166
  * Optional key-value metadata associated with the export.
138
167
  */
139
- metadata?: Record<string, string>;
168
+ metadata?: {
169
+ [key: string]: string;
170
+ };
140
171
  /**
141
172
  * A signed URL to download the exported data (CSV format). Available when
142
173
  * generation is complete and successful.
@@ -195,7 +226,9 @@ export interface ExportCreateParams {
195
226
  /**
196
227
  * Optional key-value metadata associated with the export.
197
228
  */
198
- metadata?: Record<string, string>;
229
+ metadata?: {
230
+ [key: string]: string;
231
+ };
199
232
  /**
200
233
  * Optional parameters to bind to the SQL query of the associated report.
201
234
  */
package/resources/reports/exports.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../src/resources/reports/exports.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;OAKG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAIxC;;;OAGG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1C;;;;OAIG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAGzC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC,MAAM,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAElC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAEtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAElC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAElC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
1
+ {"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../src/resources/reports/exports.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAIxC;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1C;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;CAGzC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC,MAAM,CAAC;IAEpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC,MAAM,CAAC;IAEtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
package/resources/reports/exports.js CHANGED
@@ -9,6 +9,17 @@ class Exports extends resource_1.APIResource {
9
9
  * asynchronously and generates a downloadable CSV file with the full results. Your
10
10
  * queries can run for up to 13 minutes the resulting file can be up to 100mb
11
11
  * large.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const _export = await client.reports.exports.create(
16
+ * 'reportID',
17
+ * {
18
+ * description: 'October Orders Export',
19
+ * params: ['2023-10-01T00:00:00Z'],
20
+ * },
21
+ * );
22
+ * ```
12
23
  */
13
24
  create(reportId, body, options) {
14
25
  return this._client.post(`/reports/${reportId}/exports`, { body, ...options });
@@ -16,6 +27,14 @@ class Exports extends resource_1.APIResource {
16
27
  /**
17
28
  * Retrieve the status and details of a specific report export job. Check the
18
29
  * `outputURL` property for the download link once generation is complete.
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * const _export = await client.reports.exports.retrieve(
34
+ * 'reportID',
35
+ * 'exportID',
36
+ * );
37
+ * ```
19
38
  */
20
39
  retrieve(reportId, exportId, options) {
21
40
  return this._client.get(`/reports/${reportId}/exports/${exportId}`, options);
@@ -24,6 +43,14 @@ class Exports extends resource_1.APIResource {
24
43
  * Delete a completed or failed report export job and its associated output file
25
44
  * (if any). This action cannot be undone. You cannot delete an export that is
26
45
  * still generating.
46
+ *
47
+ * @example
48
+ * ```ts
49
+ * const _export = await client.reports.exports.delete(
50
+ * 'reportID',
51
+ * 'exportID',
52
+ * );
53
+ * ```
27
54
  */
28
55
  delete(reportId, exportId, options) {
29
56
  return this._client.delete(`/reports/${reportId}/exports/${exportId}`, options);
package/resources/reports/exports.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"exports.js","sourceRoot":"","sources":["../../src/resources/reports/exports.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;OAKG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;OAGG;IACH,QAAQ,CACN,QAAgB,EAChB,QAAgB,EAChB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,QAAgB,EAChB,QAAgB,EAChB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,QAAQ,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;CACF;AAvCD,0BAuCC"}
1
+ {"version":3,"file":"exports.js","sourceRoot":"","sources":["../../src/resources/reports/exports.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAG7C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,QAAgB,EAChB,QAAgB,EAChB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,QAAgB,EAChB,QAAgB,EAChB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,QAAQ,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;CACF;AAlED,0BAkEC"}
package/resources/reports/exports.mjs CHANGED
@@ -6,6 +6,17 @@ export class Exports extends APIResource {
6
6
  * asynchronously and generates a downloadable CSV file with the full results. Your
7
7
  * queries can run for up to 13 minutes the resulting file can be up to 100mb
8
8
  * large.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const _export = await client.reports.exports.create(
13
+ * 'reportID',
14
+ * {
15
+ * description: 'October Orders Export',
16
+ * params: ['2023-10-01T00:00:00Z'],
17
+ * },
18
+ * );
19
+ * ```
9
20
  */
10
21
  create(reportId, body, options) {
11
22
  return this._client.post(`/reports/${reportId}/exports`, { body, ...options });
@@ -13,6 +24,14 @@ export class Exports extends APIResource {
13
24
  /**
14
25
  * Retrieve the status and details of a specific report export job. Check the
15
26
  * `outputURL` property for the download link once generation is complete.
27
+ *
28
+ * @example
29
+ * ```ts
30
+ * const _export = await client.reports.exports.retrieve(
31
+ * 'reportID',
32
+ * 'exportID',
33
+ * );
34
+ * ```
16
35
  */
17
36
  retrieve(reportId, exportId, options) {
18
37
  return this._client.get(`/reports/${reportId}/exports/${exportId}`, options);
@@ -21,6 +40,14 @@ export class Exports extends APIResource {
21
40
  * Delete a completed or failed report export job and its associated output file
22
41
  * (if any). This action cannot be undone. You cannot delete an export that is
23
42
  * still generating.
43
+ *
44
+ * @example
45
+ * ```ts
46
+ * const _export = await client.reports.exports.delete(
47
+ * 'reportID',
48
+ * 'exportID',
49
+ * );
50
+ * ```
24
51
  */
25
52
  delete(reportId, exportId, options) {
26
53
  return this._client.delete(`/reports/${reportId}/exports/${exportId}`, options);
package/resources/reports/exports.mjs.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"exports.mjs","sourceRoot":"","sources":["../../src/resources/reports/exports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;OAKG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;OAGG;IACH,QAAQ,CACN,QAAgB,EAChB,QAAgB,EAChB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,QAAgB,EAChB,QAAgB,EAChB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,QAAQ,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;CACF"}
1
+ {"version":3,"file":"exports.mjs","sourceRoot":"","sources":["../../src/resources/reports/exports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,QAAgB,EAChB,IAAwB,EACxB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,QAAQ,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACN,QAAgB,EAChB,QAAgB,EAChB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,QAAgB,EAChB,QAAgB,EAChB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,QAAQ,YAAY,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;CACF"}
package/resources/reports/reports.d.ts CHANGED
@@ -11,31 +11,75 @@ export declare class Reports extends APIResource {
11
11
  *
12
12
  * If you just want to do ad-hoc queries, you should use the `/reports/samples`
13
13
  * endpoint.
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * const report = await client.reports.create({
18
+ * sqlQuery:
19
+ * 'SELECT id, status FROM orders WHERE created_at > ?',
20
+ * description: 'Recent Orders',
21
+ * metadata: { team: 'Sales' },
22
+ * });
23
+ * ```
14
24
  */
15
25
  create(body: ReportCreateParams, options?: Core.RequestOptions): Core.APIPromise<ReportCreateResponse>;
16
26
  /**
17
27
  * Retrieve the details of a specific saved report by its ID.
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * const report = await client.reports.retrieve('id');
32
+ * ```
18
33
  */
19
34
  retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ReportRetrieveResponse>;
20
35
  /**
21
36
  * Update an existing saved report definition. You can change the query,
22
37
  * description, or metadata.
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * const report = await client.reports.update('id', {
42
+ * description: 'Recent Orders (Updated)',
43
+ * });
44
+ * ```
23
45
  */
24
46
  update(id: string, body: ReportUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ReportUpdateResponse>;
25
47
  /**
26
48
  * Retrieve a list of saved reports for your organization.
49
+ *
50
+ * @example
51
+ * ```ts
52
+ * // Automatically fetches more pages as needed.
53
+ * for await (const reportListResponse of client.reports.list()) {
54
+ * // ...
55
+ * }
56
+ * ```
27
57
  */
28
58
  list(query?: ReportListParams, options?: Core.RequestOptions): Core.PagePromise<ReportListResponsesList, ReportListResponse>;
29
59
  list(options?: Core.RequestOptions): Core.PagePromise<ReportListResponsesList, ReportListResponse>;
30
60
  /**
31
61
  * Delete a saved report definition. This action cannot be undone. Associated
32
62
  * exports are not automatically deleted.
63
+ *
64
+ * @example
65
+ * ```ts
66
+ * const report = await client.reports.delete('id');
67
+ * ```
33
68
  */
34
69
  delete(id: string, options?: Core.RequestOptions): Core.APIPromise<ReportDeleteResponse>;
35
70
  /**
36
71
  * Run an ad-hoc SQL query against your data lake and get a sample of the results.
37
72
  * This is useful for quickly testing queries without saving them as a report. The
38
73
  * query execution time and result size are limited.
74
+ *
75
+ * @example
76
+ * ```ts
77
+ * const response = await client.reports.runAdHocQuery({
78
+ * sqlQuery: 'SELECT id FROM contacts LIMIT 5',
79
+ * limit: 5,
80
+ * params: [],
81
+ * });
82
+ * ```
39
83
  */
40
84
  runAdHocQuery(body: ReportRunAdHocQueryParams, options?: Core.RequestOptions): Core.APIPromise<ReportRunAdHocQueryResponse>;
41
85
  /**
@@ -43,6 +87,14 @@ export declare class Reports extends APIResource {
43
87
  * This allows getting up to 1000 rows of resutls but the runtime of the query is
44
88
  * limited to 30 seconds. If you need more rows or longer runtime, you should
45
89
  * create an export from this report.
90
+ *
91
+ * @example
92
+ * ```ts
93
+ * const response = await client.reports.sample('id', {
94
+ * limit: 10,
95
+ * params: ['2023-10-01T00:00:00Z'],
96
+ * });
97
+ * ```
46
98
  */
47
99
  sample(id: string, body: ReportSampleParams, options?: Core.RequestOptions): Core.APIPromise<ReportSampleResponse>;
48
100
  }
@@ -83,7 +135,9 @@ export interface ReportCreateResponse {
83
135
  /**
84
136
  * Optional key-value metadata associated with the report.
85
137
  */
86
- metadata?: Record<string, string>;
138
+ metadata?: {
139
+ [key: string]: string;
140
+ };
87
141
  }
88
142
  /**
89
143
  * Represents a saved Report definition.
@@ -120,7 +174,9 @@ export interface ReportRetrieveResponse {
120
174
  /**
121
175
  * Optional key-value metadata associated with the report.
122
176
  */
123
- metadata?: Record<string, string>;
177
+ metadata?: {
178
+ [key: string]: string;
179
+ };
124
180
  }
125
181
  /**
126
182
  * Represents a saved Report definition.
@@ -157,7 +213,9 @@ export interface ReportUpdateResponse {
157
213
  /**
158
214
  * Optional key-value metadata associated with the report.
159
215
  */
160
- metadata?: Record<string, string>;
216
+ metadata?: {
217
+ [key: string]: string;
218
+ };
161
219
  }
162
220
  /**
163
221
  * Represents a saved Report definition.
@@ -194,7 +252,9 @@ export interface ReportListResponse {
194
252
  /**
195
253
  * Optional key-value metadata associated with the report.
196
254
  */
197
- metadata?: Record<string, string>;
255
+ metadata?: {
256
+ [key: string]: string;
257
+ };
198
258
  }
199
259
  /**
200
260
  * Generic response for delete operations.
@@ -220,7 +280,9 @@ export interface ReportRunAdHocQueryResponse {
220
280
  /**
221
281
  * The actual data records returned by the sample query.
222
282
  */
223
- records: Array<Record<string, unknown>>;
283
+ records: Array<{
284
+ [key: string]: unknown;
285
+ }>;
224
286
  /**
225
287
  * The ID of the report this sample was generated from, or null for ad-hoc samples.
226
288
  */
@@ -237,7 +299,9 @@ export interface ReportSampleResponse {
237
299
  /**
238
300
  * The actual data records returned by the sample query.
239
301
  */
240
- records: Array<Record<string, unknown>>;
302
+ records: Array<{
303
+ [key: string]: unknown;
304
+ }>;
241
305
  /**
242
306
  * The ID of the report this sample was generated from, or null for ad-hoc samples.
243
307
  */
@@ -255,7 +319,9 @@ export interface ReportCreateParams {
255
319
  /**
256
320
  * Optional key-value metadata associated with the report.
257
321
  */
258
- metadata?: Record<string, string>;
322
+ metadata?: {
323
+ [key: string]: string;
324
+ };
259
325
  }
260
326
  export interface ReportUpdateParams {
261
327
  /**
@@ -265,7 +331,9 @@ export interface ReportUpdateParams {
265
331
  /**
266
332
  * Optional key-value metadata associated with the report. Set to null to remove.
267
333
  */
268
- metadata?: Record<string, string> | null;
334
+ metadata?: {
335
+ [key: string]: string;
336
+ } | null;
269
337
  /**
270
338
  * The SQL query defining the report.
271
339
  */