@llamaindex/llama-cloud 2.3.0 → 2.4.1

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 (155) hide show
  1. package/CHANGELOG.md +34 -0
  2. package/client.d.mts +2 -2
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +2 -2
  5. package/client.d.ts.map +1 -1
  6. package/client.js.map +1 -1
  7. package/client.mjs.map +1 -1
  8. package/internal/utils/env.js +2 -2
  9. package/internal/utils/env.js.map +1 -1
  10. package/internal/utils/env.mjs +2 -2
  11. package/internal/utils/env.mjs.map +1 -1
  12. package/package.json +1 -1
  13. package/resources/beta/agent-data.d.mts +82 -19
  14. package/resources/beta/agent-data.d.mts.map +1 -1
  15. package/resources/beta/agent-data.d.ts +82 -19
  16. package/resources/beta/agent-data.d.ts.map +1 -1
  17. package/resources/beta/agent-data.js +76 -11
  18. package/resources/beta/agent-data.js.map +1 -1
  19. package/resources/beta/agent-data.mjs +76 -11
  20. package/resources/beta/agent-data.mjs.map +1 -1
  21. package/resources/beta/batch/batch.d.mts +27 -0
  22. package/resources/beta/batch/batch.d.mts.map +1 -1
  23. package/resources/beta/batch/batch.d.ts +27 -0
  24. package/resources/beta/batch/batch.d.ts.map +1 -1
  25. package/resources/beta/batch/batch.js +27 -0
  26. package/resources/beta/batch/batch.js.map +1 -1
  27. package/resources/beta/batch/batch.mjs +27 -0
  28. package/resources/beta/batch/batch.mjs.map +1 -1
  29. package/resources/beta/batch/job-items.d.mts +18 -0
  30. package/resources/beta/batch/job-items.d.mts.map +1 -1
  31. package/resources/beta/batch/job-items.d.ts +18 -0
  32. package/resources/beta/batch/job-items.d.ts.map +1 -1
  33. package/resources/beta/batch/job-items.js +18 -0
  34. package/resources/beta/batch/job-items.js.map +1 -1
  35. package/resources/beta/batch/job-items.mjs +18 -0
  36. package/resources/beta/batch/job-items.mjs.map +1 -1
  37. package/resources/beta/beta.d.mts +2 -2
  38. package/resources/beta/beta.d.mts.map +1 -1
  39. package/resources/beta/beta.d.ts +2 -2
  40. package/resources/beta/beta.d.ts.map +1 -1
  41. package/resources/beta/directories/directories.d.mts +34 -0
  42. package/resources/beta/directories/directories.d.mts.map +1 -1
  43. package/resources/beta/directories/directories.d.ts +34 -0
  44. package/resources/beta/directories/directories.d.ts.map +1 -1
  45. package/resources/beta/directories/directories.js +34 -0
  46. package/resources/beta/directories/directories.js.map +1 -1
  47. package/resources/beta/directories/directories.mjs +34 -0
  48. package/resources/beta/directories/directories.mjs.map +1 -1
  49. package/resources/beta/directories/files.d.mts +93 -0
  50. package/resources/beta/directories/files.d.mts.map +1 -1
  51. package/resources/beta/directories/files.d.ts +93 -0
  52. package/resources/beta/directories/files.d.ts.map +1 -1
  53. package/resources/beta/directories/files.js +50 -0
  54. package/resources/beta/directories/files.js.map +1 -1
  55. package/resources/beta/directories/files.mjs +50 -0
  56. package/resources/beta/directories/files.mjs.map +1 -1
  57. package/resources/beta/index.d.mts +1 -1
  58. package/resources/beta/index.d.mts.map +1 -1
  59. package/resources/beta/index.d.ts +1 -1
  60. package/resources/beta/index.d.ts.map +1 -1
  61. package/resources/beta/sheets.d.mts +38 -0
  62. package/resources/beta/sheets.d.mts.map +1 -1
  63. package/resources/beta/sheets.d.ts +38 -0
  64. package/resources/beta/sheets.d.ts.map +1 -1
  65. package/resources/beta/sheets.js +38 -0
  66. package/resources/beta/sheets.js.map +1 -1
  67. package/resources/beta/sheets.mjs +38 -0
  68. package/resources/beta/sheets.mjs.map +1 -1
  69. package/resources/beta/split.d.mts +25 -10
  70. package/resources/beta/split.d.mts.map +1 -1
  71. package/resources/beta/split.d.ts +25 -10
  72. package/resources/beta/split.d.ts.map +1 -1
  73. package/resources/beta/split.js +21 -6
  74. package/resources/beta/split.js.map +1 -1
  75. package/resources/beta/split.mjs +21 -6
  76. package/resources/beta/split.mjs.map +1 -1
  77. package/resources/classify.d.mts +70 -0
  78. package/resources/classify.d.mts.map +1 -1
  79. package/resources/classify.d.ts +70 -0
  80. package/resources/classify.d.ts.map +1 -1
  81. package/resources/classify.js +113 -0
  82. package/resources/classify.js.map +1 -1
  83. package/resources/classify.mjs +113 -0
  84. package/resources/classify.mjs.map +1 -1
  85. package/resources/configurations.d.mts +214 -13
  86. package/resources/configurations.d.mts.map +1 -1
  87. package/resources/configurations.d.ts +214 -13
  88. package/resources/configurations.d.ts.map +1 -1
  89. package/resources/extract.d.mts +16 -6
  90. package/resources/extract.d.mts.map +1 -1
  91. package/resources/extract.d.ts +16 -6
  92. package/resources/extract.d.ts.map +1 -1
  93. package/resources/extract.js +14 -1
  94. package/resources/extract.js.map +1 -1
  95. package/resources/extract.mjs +14 -1
  96. package/resources/extract.mjs.map +1 -1
  97. package/resources/index.d.mts +1 -1
  98. package/resources/index.d.mts.map +1 -1
  99. package/resources/index.d.ts +1 -1
  100. package/resources/index.d.ts.map +1 -1
  101. package/resources/index.js.map +1 -1
  102. package/resources/index.mjs.map +1 -1
  103. package/resources/parsing.d.mts +5 -4
  104. package/resources/parsing.d.mts.map +1 -1
  105. package/resources/parsing.d.ts +5 -4
  106. package/resources/parsing.d.ts.map +1 -1
  107. package/resources/pipelines/documents.d.mts +0 -3
  108. package/resources/pipelines/documents.d.mts.map +1 -1
  109. package/resources/pipelines/documents.d.ts +0 -3
  110. package/resources/pipelines/documents.d.ts.map +1 -1
  111. package/resources/pipelines/pipelines.d.mts +0 -7
  112. package/resources/pipelines/pipelines.d.mts.map +1 -1
  113. package/resources/pipelines/pipelines.d.ts +0 -7
  114. package/resources/pipelines/pipelines.d.ts.map +1 -1
  115. package/resources/pipelines/pipelines.js.map +1 -1
  116. package/resources/pipelines/pipelines.mjs.map +1 -1
  117. package/resources/retrievers/index.d.mts +1 -1
  118. package/resources/retrievers/index.d.mts.map +1 -1
  119. package/resources/retrievers/index.d.ts +1 -1
  120. package/resources/retrievers/index.d.ts.map +1 -1
  121. package/resources/retrievers/index.js.map +1 -1
  122. package/resources/retrievers/index.mjs.map +1 -1
  123. package/resources/retrievers/retrievers.d.mts +17 -5
  124. package/resources/retrievers/retrievers.d.mts.map +1 -1
  125. package/resources/retrievers/retrievers.d.ts +17 -5
  126. package/resources/retrievers/retrievers.d.ts.map +1 -1
  127. package/resources/retrievers/retrievers.js +10 -3
  128. package/resources/retrievers/retrievers.js.map +1 -1
  129. package/resources/retrievers/retrievers.mjs +10 -3
  130. package/resources/retrievers/retrievers.mjs.map +1 -1
  131. package/src/client.ts +2 -0
  132. package/src/internal/utils/env.ts +2 -2
  133. package/src/resources/beta/agent-data.ts +94 -28
  134. package/src/resources/beta/batch/batch.ts +27 -0
  135. package/src/resources/beta/batch/job-items.ts +18 -0
  136. package/src/resources/beta/beta.ts +2 -2
  137. package/src/resources/beta/directories/directories.ts +34 -0
  138. package/src/resources/beta/directories/files.ts +86 -0
  139. package/src/resources/beta/index.ts +1 -1
  140. package/src/resources/beta/sheets.ts +38 -0
  141. package/src/resources/beta/split.ts +25 -10
  142. package/src/resources/classify.ts +130 -0
  143. package/src/resources/configurations.ts +256 -8
  144. package/src/resources/extract.ts +16 -7
  145. package/src/resources/index.ts +1 -0
  146. package/src/resources/parsing.ts +9 -2
  147. package/src/resources/pipelines/documents.ts +0 -3
  148. package/src/resources/pipelines/pipelines.ts +0 -7
  149. package/src/resources/retrievers/index.ts +1 -0
  150. package/src/resources/retrievers/retrievers.ts +37 -5
  151. package/src/version.ts +1 -1
  152. package/version.d.mts +1 -1
  153. package/version.d.ts +1 -1
  154. package/version.js +1 -1
  155. package/version.mjs +1 -1
@@ -9,17 +9,39 @@ export declare class Sheets extends APIResource {
9
9
  /**
10
10
  * Create a spreadsheet parsing job. Experimental: This endpoint is not yet ready
11
11
  * for production use and is subject to change at any time.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const sheetsJob = await client.beta.sheets.create({
16
+ * file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
17
+ * });
18
+ * ```
12
19
  */
13
20
  create(params: SheetCreateParams, options?: RequestOptions): APIPromise<SheetsJob>;
14
21
  /**
15
22
  * List spreadsheet parsing jobs. Experimental: This endpoint is not yet ready for
16
23
  * production use and is subject to change at any time.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * // Automatically fetches more pages as needed.
28
+ * for await (const sheetsJob of client.beta.sheets.list()) {
29
+ * // ...
30
+ * }
31
+ * ```
17
32
  */
18
33
  list(query?: SheetListParams | null | undefined, options?: RequestOptions): PagePromise<SheetsJobsPaginatedCursor, SheetsJob>;
19
34
  /**
20
35
  * Delete a spreadsheet parsing job and its associated data. Experimental: This
21
36
  * endpoint is not yet ready for production use and is subject to change at any
22
37
  * time.
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * const response = await client.beta.sheets.deleteJob(
42
+ * 'spreadsheet_job_id',
43
+ * );
44
+ * ```
23
45
  */
24
46
  deleteJob(spreadsheetJobID: string, params?: SheetDeleteJobParams | null | undefined, options?: RequestOptions): APIPromise<unknown>;
25
47
  /**
@@ -31,12 +53,28 @@ export declare class Sheets extends APIResource {
31
53
  *
32
54
  * Experimental: This endpoint is not yet ready for production use and is subject
33
55
  * to change at any time.
56
+ *
57
+ * @example
58
+ * ```ts
59
+ * const sheetsJob = await client.beta.sheets.get(
60
+ * 'spreadsheet_job_id',
61
+ * );
62
+ * ```
34
63
  */
35
64
  get(spreadsheetJobID: string, query?: SheetGetParams | null | undefined, options?: RequestOptions): APIPromise<SheetsJob>;
36
65
  /**
37
66
  * Generate a presigned URL to download a specific extracted region. Experimental:
38
67
  * This endpoint is not yet ready for production use and is subject to change at
39
68
  * any time.
69
+ *
70
+ * @example
71
+ * ```ts
72
+ * const presignedURL =
73
+ * await client.beta.sheets.getResultTable('table', {
74
+ * spreadsheet_job_id: 'spreadsheet_job_id',
75
+ * region_id: 'region_id',
76
+ * });
77
+ * ```
40
78
  */
41
79
  getResultTable(regionType: 'table' | 'extra' | 'cell_metadata', params: SheetGetResultTableParams, options?: RequestOptions): APIPromise<FilesAPI.PresignedURL>;
42
80
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"sheets.d.mts","sourceRoot":"","sources":["../../src/resources/beta/sheets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;OAElB,EAAqB,cAAc,EAAmB;AAE7D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IASlF;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,SAAS,CAAC;IAOpD;;;;OAIG;IACH,SAAS,CACP,gBAAgB,EAAE,MAAM,EACxB,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAQtB;;;;;;;;;OASG;IACH,GAAG,CACD,gBAAgB,EAAE,MAAM,EACxB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,SAAS,CAAC;IAIxB;;;;OAIG;IACH,cAAc,CACZ,UAAU,EAAE,OAAO,GAAG,OAAO,GAAG,eAAe,EAC/C,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IAQpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC;IAwBnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,iBAAiB,CACrB,gBAAgB,EAAE,MAAM,EACxB,MAAM,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;CA2BtB;AAED,MAAM,MAAM,yBAAyB,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;CACzD;AAED,yBAAiB,SAAS,CAAC;IACzB;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAEtC;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAE5C;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACvC;AAED,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED,MAAM,WAAW,eAAgB,SAAQ,qBAAqB;IAC5D;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,cAAc;CAAG;AAE9E,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"sheets.d.mts","sourceRoot":"","sources":["../../src/resources/beta/sheets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;OAElB,EAAqB,cAAc,EAAmB;AAE7D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IASlF;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,SAAS,CAAC;IAOpD;;;;;;;;;;;OAWG;IACH,SAAS,CACP,gBAAgB,EAAE,MAAM,EACxB,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAQtB;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,CACD,gBAAgB,EAAE,MAAM,EACxB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,SAAS,CAAC;IAIxB;;;;;;;;;;;;;OAaG;IACH,cAAc,CACZ,UAAU,EAAE,OAAO,GAAG,OAAO,GAAG,eAAe,EAC/C,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IAQpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC;IAwBnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,iBAAiB,CACrB,gBAAgB,EAAE,MAAM,EACxB,MAAM,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;CA2BtB;AAED,MAAM,MAAM,yBAAyB,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;CACzD;AAED,yBAAiB,SAAS,CAAC;IACzB;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAEtC;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAE5C;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACvC;AAED,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED,MAAM,WAAW,eAAgB,SAAQ,qBAAqB;IAC5D;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,cAAc;CAAG;AAE9E,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
@@ -9,17 +9,39 @@ export declare class Sheets extends APIResource {
9
9
  /**
10
10
  * Create a spreadsheet parsing job. Experimental: This endpoint is not yet ready
11
11
  * for production use and is subject to change at any time.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const sheetsJob = await client.beta.sheets.create({
16
+ * file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
17
+ * });
18
+ * ```
12
19
  */
13
20
  create(params: SheetCreateParams, options?: RequestOptions): APIPromise<SheetsJob>;
14
21
  /**
15
22
  * List spreadsheet parsing jobs. Experimental: This endpoint is not yet ready for
16
23
  * production use and is subject to change at any time.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * // Automatically fetches more pages as needed.
28
+ * for await (const sheetsJob of client.beta.sheets.list()) {
29
+ * // ...
30
+ * }
31
+ * ```
17
32
  */
18
33
  list(query?: SheetListParams | null | undefined, options?: RequestOptions): PagePromise<SheetsJobsPaginatedCursor, SheetsJob>;
19
34
  /**
20
35
  * Delete a spreadsheet parsing job and its associated data. Experimental: This
21
36
  * endpoint is not yet ready for production use and is subject to change at any
22
37
  * time.
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * const response = await client.beta.sheets.deleteJob(
42
+ * 'spreadsheet_job_id',
43
+ * );
44
+ * ```
23
45
  */
24
46
  deleteJob(spreadsheetJobID: string, params?: SheetDeleteJobParams | null | undefined, options?: RequestOptions): APIPromise<unknown>;
25
47
  /**
@@ -31,12 +53,28 @@ export declare class Sheets extends APIResource {
31
53
  *
32
54
  * Experimental: This endpoint is not yet ready for production use and is subject
33
55
  * to change at any time.
56
+ *
57
+ * @example
58
+ * ```ts
59
+ * const sheetsJob = await client.beta.sheets.get(
60
+ * 'spreadsheet_job_id',
61
+ * );
62
+ * ```
34
63
  */
35
64
  get(spreadsheetJobID: string, query?: SheetGetParams | null | undefined, options?: RequestOptions): APIPromise<SheetsJob>;
36
65
  /**
37
66
  * Generate a presigned URL to download a specific extracted region. Experimental:
38
67
  * This endpoint is not yet ready for production use and is subject to change at
39
68
  * any time.
69
+ *
70
+ * @example
71
+ * ```ts
72
+ * const presignedURL =
73
+ * await client.beta.sheets.getResultTable('table', {
74
+ * spreadsheet_job_id: 'spreadsheet_job_id',
75
+ * region_id: 'region_id',
76
+ * });
77
+ * ```
40
78
  */
41
79
  getResultTable(regionType: 'table' | 'extra' | 'cell_metadata', params: SheetGetResultTableParams, options?: RequestOptions): APIPromise<FilesAPI.PresignedURL>;
42
80
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"sheets.d.ts","sourceRoot":"","sources":["../../src/resources/beta/sheets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;OAElB,EAAqB,cAAc,EAAmB;AAE7D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IASlF;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,SAAS,CAAC;IAOpD;;;;OAIG;IACH,SAAS,CACP,gBAAgB,EAAE,MAAM,EACxB,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAQtB;;;;;;;;;OASG;IACH,GAAG,CACD,gBAAgB,EAAE,MAAM,EACxB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,SAAS,CAAC;IAIxB;;;;OAIG;IACH,cAAc,CACZ,UAAU,EAAE,OAAO,GAAG,OAAO,GAAG,eAAe,EAC/C,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IAQpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC;IAwBnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,iBAAiB,CACrB,gBAAgB,EAAE,MAAM,EACxB,MAAM,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;CA2BtB;AAED,MAAM,MAAM,yBAAyB,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;CACzD;AAED,yBAAiB,SAAS,CAAC;IACzB;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAEtC;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAE5C;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACvC;AAED,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED,MAAM,WAAW,eAAgB,SAAQ,qBAAqB;IAC5D;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,cAAc;CAAG;AAE9E,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"sheets.d.ts","sourceRoot":"","sources":["../../src/resources/beta/sheets.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;OAElB,EAAqB,cAAc,EAAmB;AAE7D,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC;IASlF;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,SAAS,CAAC;IAOpD;;;;;;;;;;;OAWG;IACH,SAAS,CACP,gBAAgB,EAAE,MAAM,EACxB,MAAM,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAQtB;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,CACD,gBAAgB,EAAE,MAAM,EACxB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,SAAS,CAAC;IAIxB;;;;;;;;;;;;;OAaG;IACH,cAAc,CACZ,UAAU,EAAE,OAAO,GAAG,OAAO,GAAG,eAAe,EAC/C,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC;IAQpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC;IAwBnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,iBAAiB,CACrB,gBAAgB,EAAE,MAAM,EACxB,MAAM,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;CA2BtB;AAED,MAAM,MAAM,yBAAyB,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAElC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;CACzD;AAED,yBAAiB,SAAS,CAAC;IACzB;;OAEG;IACH,UAAiB,MAAM;QACrB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;OAGG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAEtC;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAE5C;;OAEG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACvC;AAED,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;CAC9B;AAED,MAAM,WAAW,eAAgB,SAAQ,qBAAqB;IAC5D;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,cAAc;CAAG;AAE9E,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
@@ -10,6 +10,13 @@ class Sheets extends resource_1.APIResource {
10
10
  /**
11
11
  * Create a spreadsheet parsing job. Experimental: This endpoint is not yet ready
12
12
  * for production use and is subject to change at any time.
13
+ *
14
+ * @example
15
+ * ```ts
16
+ * const sheetsJob = await client.beta.sheets.create({
17
+ * file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
18
+ * });
19
+ * ```
13
20
  */
14
21
  create(params, options) {
15
22
  const { organization_id, project_id, ...body } = params;
@@ -22,6 +29,14 @@ class Sheets extends resource_1.APIResource {
22
29
  /**
23
30
  * List spreadsheet parsing jobs. Experimental: This endpoint is not yet ready for
24
31
  * production use and is subject to change at any time.
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * // Automatically fetches more pages as needed.
36
+ * for await (const sheetsJob of client.beta.sheets.list()) {
37
+ * // ...
38
+ * }
39
+ * ```
25
40
  */
26
41
  list(query = {}, options) {
27
42
  return this._client.getAPIList('/api/v1/beta/sheets/jobs', (pagination_1.PaginatedCursor), {
@@ -33,6 +48,13 @@ class Sheets extends resource_1.APIResource {
33
48
  * Delete a spreadsheet parsing job and its associated data. Experimental: This
34
49
  * endpoint is not yet ready for production use and is subject to change at any
35
50
  * time.
51
+ *
52
+ * @example
53
+ * ```ts
54
+ * const response = await client.beta.sheets.deleteJob(
55
+ * 'spreadsheet_job_id',
56
+ * );
57
+ * ```
36
58
  */
37
59
  deleteJob(spreadsheetJobID, params = {}, options) {
38
60
  const { organization_id, project_id } = params ?? {};
@@ -50,6 +72,13 @@ class Sheets extends resource_1.APIResource {
50
72
  *
51
73
  * Experimental: This endpoint is not yet ready for production use and is subject
52
74
  * to change at any time.
75
+ *
76
+ * @example
77
+ * ```ts
78
+ * const sheetsJob = await client.beta.sheets.get(
79
+ * 'spreadsheet_job_id',
80
+ * );
81
+ * ```
53
82
  */
54
83
  get(spreadsheetJobID, query = {}, options) {
55
84
  return this._client.get((0, path_1.path) `/api/v1/beta/sheets/jobs/${spreadsheetJobID}`, { query, ...options });
@@ -58,6 +87,15 @@ class Sheets extends resource_1.APIResource {
58
87
  * Generate a presigned URL to download a specific extracted region. Experimental:
59
88
  * This endpoint is not yet ready for production use and is subject to change at
60
89
  * any time.
90
+ *
91
+ * @example
92
+ * ```ts
93
+ * const presignedURL =
94
+ * await client.beta.sheets.getResultTable('table', {
95
+ * spreadsheet_job_id: 'spreadsheet_job_id',
96
+ * region_id: 'region_id',
97
+ * });
98
+ * ```
61
99
  */
62
100
  getResultTable(regionType, params, options) {
63
101
  const { spreadsheet_job_id, region_id, ...query } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"sheets.js","sourceRoot":"","sources":["../../src/resources/beta/sheets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,yDAAiG;AAEjG,uDAAiD;AACjD,mDAAwF;AAExF,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,0BAA0B,EAAE,CAAA,4BAA0B,CAAA,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,SAAS,CACP,gBAAwB,EACxB,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,gBAAgB,EAAE,EAAE;YAC7E,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CACD,gBAAwB,EACxB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,4BAA4B,gBAAgB,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;OAIG;IACH,cAAc,CACZ,UAA+C,EAC/C,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,WAAI,EAAA,4BAA4B,kBAAkB,YAAY,SAAS,WAAW,UAAU,EAAE,EAC9F,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,KAAK,CAAC,MAAwB,EAAE,OAAwB;QAC5D,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;QAE5F,iBAAiB;QACjB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAErD,sBAAsB;QACtB,MAAM,cAAc,GAAoC,EAAE,GAAG,OAAO,EAAE,CAAC;QACvE,IAAI,eAAe,KAAK,SAAS;YAAE,cAAc,CAAC,eAAe,GAAG,eAAe,CAAC;QACpF,IAAI,WAAW,KAAK,SAAS;YAAE,cAAc,CAAC,WAAW,GAAG,WAAW,CAAC;QACxE,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAE5D,8DAA8D;QAC9D,MAAM,UAAU,GAAiC;YAC/C,GAAG,cAAc;SAClB,CAAC;QACF,IAAI,YAAY,CAAC,eAAe,KAAK,SAAS;YAAE,UAAU,CAAC,eAAe,GAAG,YAAY,CAAC,eAAe,CAAC;QAC1G,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS;YAAE,UAAU,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAE3F,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,iBAAiB,CACrB,gBAAwB,EACxB,SAA0D,EAAE,EAC5D,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAEjG,MAAM,cAAc,GAAmB;YACrC,eAAe,EAAE,eAAe,IAAI,GAAG;YACvC,WAAW,EAAE,WAAW,IAAI,GAAG;YAC/B,OAAO,EAAE,OAAO,IAAI,yBAAe;YACnC,OAAO,EAAE,OAAO,IAAI,QAAQ;YAC5B,OAAO,EAAE,OAAO,IAAI,KAAK;SAC1B,CAAC;QAEF,OAAO,IAAA,2BAAiB,EACtB,KAAK,IAAI,EAAE;YACT,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;QACxF,CAAC,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,iBAAiB,EACrE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,OAAO,IAAI,GAAG,CAAC,MAAM,KAAK,WAAW,EAC7D,CAAC,GAAG,EAAE,EAAE;YACN,MAAM,UAAU,GAAG,CAAC,OAAO,gBAAgB,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACjF,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,WAAW,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACtD,CAAC;YACD,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,EACD,cAAc,CACf,CAAC;IACJ,CAAC;CACF;AAvMD,wBAuMC"}
1
+ {"version":3,"file":"sheets.js","sourceRoot":"","sources":["../../src/resources/beta/sheets.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,yDAAiG;AAEjG,uDAAiD;AACjD,mDAAwF;AAExF,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,0BAA0B,EAAE,CAAA,4BAA0B,CAAA,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,SAAS,CACP,gBAAwB,EACxB,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,gBAAgB,EAAE,EAAE;YAC7E,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,CACD,gBAAwB,EACxB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,4BAA4B,gBAAgB,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,cAAc,CACZ,UAA+C,EAC/C,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAA,WAAI,EAAA,4BAA4B,kBAAkB,YAAY,SAAS,WAAW,UAAU,EAAE,EAC9F,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,KAAK,CAAC,MAAwB,EAAE,OAAwB;QAC5D,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;QAE5F,iBAAiB;QACjB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAErD,sBAAsB;QACtB,MAAM,cAAc,GAAoC,EAAE,GAAG,OAAO,EAAE,CAAC;QACvE,IAAI,eAAe,KAAK,SAAS;YAAE,cAAc,CAAC,eAAe,GAAG,eAAe,CAAC;QACpF,IAAI,WAAW,KAAK,SAAS;YAAE,cAAc,CAAC,WAAW,GAAG,WAAW,CAAC;QACxE,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAE5D,8DAA8D;QAC9D,MAAM,UAAU,GAAiC;YAC/C,GAAG,cAAc;SAClB,CAAC;QACF,IAAI,YAAY,CAAC,eAAe,KAAK,SAAS;YAAE,UAAU,CAAC,eAAe,GAAG,YAAY,CAAC,eAAe,CAAC;QAC1G,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS;YAAE,UAAU,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAE3F,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,iBAAiB,CACrB,gBAAwB,EACxB,SAA0D,EAAE,EAC5D,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAEjG,MAAM,cAAc,GAAmB;YACrC,eAAe,EAAE,eAAe,IAAI,GAAG;YACvC,WAAW,EAAE,WAAW,IAAI,GAAG;YAC/B,OAAO,EAAE,OAAO,IAAI,yBAAe;YACnC,OAAO,EAAE,OAAO,IAAI,QAAQ;YAC5B,OAAO,EAAE,OAAO,IAAI,KAAK;SAC1B,CAAC;QAEF,OAAO,IAAA,2BAAiB,EACtB,KAAK,IAAI,EAAE;YACT,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;QACxF,CAAC,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,iBAAiB,EACrE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,OAAO,IAAI,GAAG,CAAC,MAAM,KAAK,WAAW,EAC7D,CAAC,GAAG,EAAE,EAAE;YACN,MAAM,UAAU,GAAG,CAAC,OAAO,gBAAgB,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACjF,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,WAAW,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACtD,CAAC;YACD,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,EACD,cAAc,CACf,CAAC;IACJ,CAAC;CACF;AA7OD,wBA6OC"}
@@ -7,6 +7,13 @@ export class Sheets extends APIResource {
7
7
  /**
8
8
  * Create a spreadsheet parsing job. Experimental: This endpoint is not yet ready
9
9
  * for production use and is subject to change at any time.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const sheetsJob = await client.beta.sheets.create({
14
+ * file_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
15
+ * });
16
+ * ```
10
17
  */
11
18
  create(params, options) {
12
19
  const { organization_id, project_id, ...body } = params;
@@ -19,6 +26,14 @@ export class Sheets extends APIResource {
19
26
  /**
20
27
  * List spreadsheet parsing jobs. Experimental: This endpoint is not yet ready for
21
28
  * production use and is subject to change at any time.
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * // Automatically fetches more pages as needed.
33
+ * for await (const sheetsJob of client.beta.sheets.list()) {
34
+ * // ...
35
+ * }
36
+ * ```
22
37
  */
23
38
  list(query = {}, options) {
24
39
  return this._client.getAPIList('/api/v1/beta/sheets/jobs', (PaginatedCursor), {
@@ -30,6 +45,13 @@ export class Sheets extends APIResource {
30
45
  * Delete a spreadsheet parsing job and its associated data. Experimental: This
31
46
  * endpoint is not yet ready for production use and is subject to change at any
32
47
  * time.
48
+ *
49
+ * @example
50
+ * ```ts
51
+ * const response = await client.beta.sheets.deleteJob(
52
+ * 'spreadsheet_job_id',
53
+ * );
54
+ * ```
33
55
  */
34
56
  deleteJob(spreadsheetJobID, params = {}, options) {
35
57
  const { organization_id, project_id } = params ?? {};
@@ -47,6 +69,13 @@ export class Sheets extends APIResource {
47
69
  *
48
70
  * Experimental: This endpoint is not yet ready for production use and is subject
49
71
  * to change at any time.
72
+ *
73
+ * @example
74
+ * ```ts
75
+ * const sheetsJob = await client.beta.sheets.get(
76
+ * 'spreadsheet_job_id',
77
+ * );
78
+ * ```
50
79
  */
51
80
  get(spreadsheetJobID, query = {}, options) {
52
81
  return this._client.get(path `/api/v1/beta/sheets/jobs/${spreadsheetJobID}`, { query, ...options });
@@ -55,6 +84,15 @@ export class Sheets extends APIResource {
55
84
  * Generate a presigned URL to download a specific extracted region. Experimental:
56
85
  * This endpoint is not yet ready for production use and is subject to change at
57
86
  * any time.
87
+ *
88
+ * @example
89
+ * ```ts
90
+ * const presignedURL =
91
+ * await client.beta.sheets.getResultTable('table', {
92
+ * spreadsheet_job_id: 'spreadsheet_job_id',
93
+ * region_id: 'region_id',
94
+ * });
95
+ * ```
58
96
  */
59
97
  getResultTable(regionType, params, options) {
60
98
  const { spreadsheet_job_id, region_id, ...query } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"sheets.mjs","sourceRoot":"","sources":["../../src/resources/beta/sheets.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAe,eAAe,EAA8B;OAE5D,EAAE,IAAI,EAAE;OACR,EAAE,iBAAiB,EAAkB,eAAe,EAAE;AAE7D,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;OAGG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,0BAA0B,EAAE,CAAA,eAA0B,CAAA,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,SAAS,CACP,gBAAwB,EACxB,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,4BAA4B,gBAAgB,EAAE,EAAE;YAC7E,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CACD,gBAAwB,EACxB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,4BAA4B,gBAAgB,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;OAIG;IACH,cAAc,CACZ,UAA+C,EAC/C,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAI,CAAA,4BAA4B,kBAAkB,YAAY,SAAS,WAAW,UAAU,EAAE,EAC9F,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,KAAK,CAAC,MAAwB,EAAE,OAAwB;QAC5D,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;QAE5F,iBAAiB;QACjB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAErD,sBAAsB;QACtB,MAAM,cAAc,GAAoC,EAAE,GAAG,OAAO,EAAE,CAAC;QACvE,IAAI,eAAe,KAAK,SAAS;YAAE,cAAc,CAAC,eAAe,GAAG,eAAe,CAAC;QACpF,IAAI,WAAW,KAAK,SAAS;YAAE,cAAc,CAAC,WAAW,GAAG,WAAW,CAAC;QACxE,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAE5D,8DAA8D;QAC9D,MAAM,UAAU,GAAiC;YAC/C,GAAG,cAAc;SAClB,CAAC;QACF,IAAI,YAAY,CAAC,eAAe,KAAK,SAAS;YAAE,UAAU,CAAC,eAAe,GAAG,YAAY,CAAC,eAAe,CAAC;QAC1G,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS;YAAE,UAAU,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAE3F,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,iBAAiB,CACrB,gBAAwB,EACxB,SAA0D,EAAE,EAC5D,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAEjG,MAAM,cAAc,GAAmB;YACrC,eAAe,EAAE,eAAe,IAAI,GAAG;YACvC,WAAW,EAAE,WAAW,IAAI,GAAG;YAC/B,OAAO,EAAE,OAAO,IAAI,eAAe;YACnC,OAAO,EAAE,OAAO,IAAI,QAAQ;YAC5B,OAAO,EAAE,OAAO,IAAI,KAAK;SAC1B,CAAC;QAEF,OAAO,iBAAiB,CACtB,KAAK,IAAI,EAAE;YACT,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;QACxF,CAAC,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,iBAAiB,EACrE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,OAAO,IAAI,GAAG,CAAC,MAAM,KAAK,WAAW,EAC7D,CAAC,GAAG,EAAE,EAAE;YACN,MAAM,UAAU,GAAG,CAAC,OAAO,gBAAgB,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACjF,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,WAAW,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACtD,CAAC;YACD,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,EACD,cAAc,CACf,CAAC;IACJ,CAAC;CACF"}
1
+ {"version":3,"file":"sheets.mjs","sourceRoot":"","sources":["../../src/resources/beta/sheets.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAe,eAAe,EAA8B;OAE5D,EAAE,IAAI,EAAE;OACR,EAAE,iBAAiB,EAAkB,eAAe,EAAE;AAE7D,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,0BAA0B,EAAE,CAAA,eAA0B,CAAA,EAAE;YACrF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,SAAS,CACP,gBAAwB,EACxB,SAAkD,EAAE,EACpD,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,4BAA4B,gBAAgB,EAAE,EAAE;YAC7E,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,CACD,gBAAwB,EACxB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,4BAA4B,gBAAgB,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,cAAc,CACZ,UAA+C,EAC/C,MAAiC,EACjC,OAAwB;QAExB,MAAM,EAAE,kBAAkB,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CACrB,IAAI,CAAA,4BAA4B,kBAAkB,YAAY,SAAS,WAAW,UAAU,EAAE,EAC9F,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CAAC,KAAK,CAAC,MAAwB,EAAE,OAAwB;QAC5D,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;QAE5F,iBAAiB;QACjB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAErD,sBAAsB;QACtB,MAAM,cAAc,GAAoC,EAAE,GAAG,OAAO,EAAE,CAAC;QACvE,IAAI,eAAe,KAAK,SAAS;YAAE,cAAc,CAAC,eAAe,GAAG,eAAe,CAAC;QACpF,IAAI,WAAW,KAAK,SAAS;YAAE,cAAc,CAAC,WAAW,GAAG,WAAW,CAAC;QACxE,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAE5D,8DAA8D;QAC9D,MAAM,UAAU,GAAiC;YAC/C,GAAG,cAAc;SAClB,CAAC;QACF,IAAI,YAAY,CAAC,eAAe,KAAK,SAAS;YAAE,UAAU,CAAC,eAAe,GAAG,YAAY,CAAC,eAAe,CAAC;QAC1G,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS;YAAE,UAAU,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAE3F,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,KAAK,CAAC,iBAAiB,CACrB,gBAAwB,EACxB,SAA0D,EAAE,EAC5D,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAEjG,MAAM,cAAc,GAAmB;YACrC,eAAe,EAAE,eAAe,IAAI,GAAG;YACvC,WAAW,EAAE,WAAW,IAAI,GAAG;YAC/B,OAAO,EAAE,OAAO,IAAI,eAAe;YACnC,OAAO,EAAE,OAAO,IAAI,QAAQ;YAC5B,OAAO,EAAE,OAAO,IAAI,KAAK;SAC1B,CAAC;QAEF,OAAO,iBAAiB,CACtB,KAAK,IAAI,EAAE;YACT,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE,EAAE,OAAO,CAAC,CAAC;QACxF,CAAC,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,SAAS,IAAI,GAAG,CAAC,MAAM,KAAK,iBAAiB,EACrE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,OAAO,IAAI,GAAG,CAAC,MAAM,KAAK,WAAW,EAC7D,CAAC,GAAG,EAAE,EAAE;YACN,MAAM,UAAU,GAAG,CAAC,OAAO,gBAAgB,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACjF,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACxC,UAAU,CAAC,IAAI,CAAC,WAAW,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACtD,CAAC;YACD,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,EACD,cAAc,CACf,CAAC;IACJ,CAAC;CACF"}
@@ -6,20 +6,35 @@ import { RequestOptions } from "../../internal/request-options.mjs";
6
6
  import { PollingOptions } from "../../core/polling.mjs";
7
7
  export declare class Split extends APIResource {
8
8
  /**
9
- * Create a document split job. Experimental: This endpoint is not yet ready for
10
- * production use and is subject to change at any time.
9
+ * Create a document split job.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const split = await client.beta.split.create({
14
+ * document_input: { type: 'type', value: 'value' },
15
+ * });
16
+ * ```
11
17
  */
12
18
  create(params: SplitCreateParams, options?: RequestOptions): APIPromise<SplitCreateResponse>;
13
19
  /**
14
- * List document split jobs. Experimental: This endpoint is not yet ready for
15
- * production use and is subject to change at any time.
20
+ * List document split jobs.
21
+ *
22
+ * @example
23
+ * ```ts
24
+ * // Automatically fetches more pages as needed.
25
+ * for await (const splitListResponse of client.beta.split.list()) {
26
+ * // ...
27
+ * }
28
+ * ```
16
29
  */
17
30
  list(query?: SplitListParams | null | undefined, options?: RequestOptions): PagePromise<SplitListResponsesPaginatedCursor, SplitListResponse>;
18
31
  /**
19
32
  * Get a document split job.
20
33
  *
21
- * Experimental: This endpoint is not yet ready for production use and is subject
22
- * to change at any time.
34
+ * @example
35
+ * ```ts
36
+ * const split = await client.beta.split.get('split_job_id');
37
+ * ```
23
38
  */
24
39
  get(splitJobID: string, query?: SplitGetParams | null | undefined, options?: RequestOptions): APIPromise<SplitGetResponse>;
25
40
  /**
@@ -125,7 +140,7 @@ export interface SplitCategory {
125
140
  description?: string | null;
126
141
  }
127
142
  /**
128
- * Document input specification.
143
+ * Document input specification for beta API.
129
144
  */
130
145
  export interface SplitDocumentInput {
131
146
  /**
@@ -164,7 +179,7 @@ export interface SplitSegmentResponse {
164
179
  pages: Array<number>;
165
180
  }
166
181
  /**
167
- * A document split job.
182
+ * Beta response uses nested document_input object.
168
183
  */
169
184
  export interface SplitCreateResponse {
170
185
  /**
@@ -214,7 +229,7 @@ export interface SplitCreateResponse {
214
229
  updated_at?: string | null;
215
230
  }
216
231
  /**
217
- * A document split job.
232
+ * Beta response uses nested document_input object.
218
233
  */
219
234
  export interface SplitListResponse {
220
235
  /**
@@ -264,7 +279,7 @@ export interface SplitListResponse {
264
279
  updated_at?: string | null;
265
280
  }
266
281
  /**
267
- * A document split job.
282
+ * Beta response uses nested document_input object.
268
283
  */
269
284
  export interface SplitGetResponse {
270
285
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"split.d.mts","sourceRoot":"","sources":["../../src/resources/beta/split.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;OAElB,EAAqB,cAAc,EAAmB;AAE7D,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAS5F;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,iBAAiB,CAAC;IAOpE;;;;;OAKG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACG,iBAAiB,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gBAAgB,CAAC;IA4B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAuB3F;AAED,MAAM,MAAM,iCAAiC,GAAG,eAAe,CAAC,iBAAiB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAC,aAAa,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAE1C;;WAEG;QACH,kBAAkB,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC;KACtD;IAED,UAAiB,aAAa,CAAC;QAC7B;;WAEG;QACH,UAAiB,iBAAiB;YAChC;;;;;eAKG;YACH,mBAAmB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;SACrD;KACF;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,qBAAqB;IAC5D;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC;CACjF;AAED,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,cAAc;CAAG;AAE9E,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"split.d.mts","sourceRoot":"","sources":["../../src/resources/beta/split.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;OAElB,EAAqB,cAAc,EAAmB;AAE7D,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAS5F;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,iBAAiB,CAAC;IAOpE;;;;;;;OAOG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACG,iBAAiB,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gBAAgB,CAAC;IA4B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAuB3F;AAED,MAAM,MAAM,iCAAiC,GAAG,eAAe,CAAC,iBAAiB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAC,aAAa,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAE1C;;WAEG;QACH,kBAAkB,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC;KACtD;IAED,UAAiB,aAAa,CAAC;QAC7B;;WAEG;QACH,UAAiB,iBAAiB;YAChC;;;;;eAKG;YACH,mBAAmB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;SACrD;KACF;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,qBAAqB;IAC5D;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC;CACjF;AAED,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,cAAc;CAAG;AAE9E,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
@@ -6,20 +6,35 @@ import { RequestOptions } from "../../internal/request-options.js";
6
6
  import { PollingOptions } from "../../core/polling.js";
7
7
  export declare class Split extends APIResource {
8
8
  /**
9
- * Create a document split job. Experimental: This endpoint is not yet ready for
10
- * production use and is subject to change at any time.
9
+ * Create a document split job.
10
+ *
11
+ * @example
12
+ * ```ts
13
+ * const split = await client.beta.split.create({
14
+ * document_input: { type: 'type', value: 'value' },
15
+ * });
16
+ * ```
11
17
  */
12
18
  create(params: SplitCreateParams, options?: RequestOptions): APIPromise<SplitCreateResponse>;
13
19
  /**
14
- * List document split jobs. Experimental: This endpoint is not yet ready for
15
- * production use and is subject to change at any time.
20
+ * List document split jobs.
21
+ *
22
+ * @example
23
+ * ```ts
24
+ * // Automatically fetches more pages as needed.
25
+ * for await (const splitListResponse of client.beta.split.list()) {
26
+ * // ...
27
+ * }
28
+ * ```
16
29
  */
17
30
  list(query?: SplitListParams | null | undefined, options?: RequestOptions): PagePromise<SplitListResponsesPaginatedCursor, SplitListResponse>;
18
31
  /**
19
32
  * Get a document split job.
20
33
  *
21
- * Experimental: This endpoint is not yet ready for production use and is subject
22
- * to change at any time.
34
+ * @example
35
+ * ```ts
36
+ * const split = await client.beta.split.get('split_job_id');
37
+ * ```
23
38
  */
24
39
  get(splitJobID: string, query?: SplitGetParams | null | undefined, options?: RequestOptions): APIPromise<SplitGetResponse>;
25
40
  /**
@@ -125,7 +140,7 @@ export interface SplitCategory {
125
140
  description?: string | null;
126
141
  }
127
142
  /**
128
- * Document input specification.
143
+ * Document input specification for beta API.
129
144
  */
130
145
  export interface SplitDocumentInput {
131
146
  /**
@@ -164,7 +179,7 @@ export interface SplitSegmentResponse {
164
179
  pages: Array<number>;
165
180
  }
166
181
  /**
167
- * A document split job.
182
+ * Beta response uses nested document_input object.
168
183
  */
169
184
  export interface SplitCreateResponse {
170
185
  /**
@@ -214,7 +229,7 @@ export interface SplitCreateResponse {
214
229
  updated_at?: string | null;
215
230
  }
216
231
  /**
217
- * A document split job.
232
+ * Beta response uses nested document_input object.
218
233
  */
219
234
  export interface SplitListResponse {
220
235
  /**
@@ -264,7 +279,7 @@ export interface SplitListResponse {
264
279
  updated_at?: string | null;
265
280
  }
266
281
  /**
267
- * A document split job.
282
+ * Beta response uses nested document_input object.
268
283
  */
269
284
  export interface SplitGetResponse {
270
285
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"split.d.ts","sourceRoot":"","sources":["../../src/resources/beta/split.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;OAElB,EAAqB,cAAc,EAAmB;AAE7D,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;OAGG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAS5F;;;OAGG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,iBAAiB,CAAC;IAOpE;;;;;OAKG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACG,iBAAiB,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gBAAgB,CAAC;IA4B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAuB3F;AAED,MAAM,MAAM,iCAAiC,GAAG,eAAe,CAAC,iBAAiB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAC,aAAa,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAE1C;;WAEG;QACH,kBAAkB,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC;KACtD;IAED,UAAiB,aAAa,CAAC;QAC7B;;WAEG;QACH,UAAiB,iBAAiB;YAChC;;;;;eAKG;YACH,mBAAmB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;SACrD;KACF;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,qBAAqB;IAC5D;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC;CACjF;AAED,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,cAAc;CAAG;AAE9E,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"split.d.ts","sourceRoot":"","sources":["../../src/resources/beta/split.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,qBAAqB,EAAE;OAC5D,EAAE,cAAc,EAAE;OAElB,EAAqB,cAAc,EAAmB;AAE7D,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAS5F;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,iCAAiC,EAAE,iBAAiB,CAAC;IAOpE;;;;;;;OAOG;IACH,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACG,iBAAiB,CACrB,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gBAAgB,CAAC;IA4B5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAuB3F;AAED,MAAM,MAAM,iCAAiC,GAAG,eAAe,CAAC,iBAAiB,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;IAEjC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,iBAAiB,CAAC,aAAa,GAAG,IAAI,CAAC;IAEvD;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,aAAa;QAC5B;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAE1C;;WAEG;QACH,kBAAkB,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC;KACtD;IAED,UAAiB,aAAa,CAAC;QAC7B;;WAEG;QACH,UAAiB,iBAAiB;YAChC;;;;;eAKG;YACH,mBAAmB,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,MAAM,CAAC;SACrD;KACF;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,qBAAqB;IAC5D;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAE/B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,IAAI,CAAC;CACjF;AAED,MAAM,WAAW,cAAc;IAC7B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB,EAAE,cAAc;CAAG;AAE9E,MAAM,WAAW,4BAA6B,SAAQ,cAAc;IAClE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
@@ -8,8 +8,14 @@ const path_1 = require("../../internal/utils/path.js");
8
8
  const polling_1 = require("../../core/polling.js");
9
9
  class Split extends resource_1.APIResource {
10
10
  /**
11
- * Create a document split job. Experimental: This endpoint is not yet ready for
12
- * production use and is subject to change at any time.
11
+ * Create a document split job.
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const split = await client.beta.split.create({
16
+ * document_input: { type: 'type', value: 'value' },
17
+ * });
18
+ * ```
13
19
  */
14
20
  create(params, options) {
15
21
  const { organization_id, project_id, ...body } = params;
@@ -20,8 +26,15 @@ class Split extends resource_1.APIResource {
20
26
  });
21
27
  }
22
28
  /**
23
- * List document split jobs. Experimental: This endpoint is not yet ready for
24
- * production use and is subject to change at any time.
29
+ * List document split jobs.
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * // Automatically fetches more pages as needed.
34
+ * for await (const splitListResponse of client.beta.split.list()) {
35
+ * // ...
36
+ * }
37
+ * ```
25
38
  */
26
39
  list(query = {}, options) {
27
40
  return this._client.getAPIList('/api/v1/beta/split/jobs', (pagination_1.PaginatedCursor), {
@@ -32,8 +45,10 @@ class Split extends resource_1.APIResource {
32
45
  /**
33
46
  * Get a document split job.
34
47
  *
35
- * Experimental: This endpoint is not yet ready for production use and is subject
36
- * to change at any time.
48
+ * @example
49
+ * ```ts
50
+ * const split = await client.beta.split.get('split_job_id');
51
+ * ```
37
52
  */
38
53
  get(splitJobID, query = {}, options) {
39
54
  return this._client.get((0, path_1.path) `/api/v1/beta/split/jobs/${splitJobID}`, { query, ...options });
@@ -1 +1 @@
1
- {"version":3,"file":"split.js","sourceRoot":"","sources":["../../src/resources/beta/split.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAAiG;AAEjG,uDAAiD;AACjD,mDAAwF;AAExF,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;OAGG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE;YAClD,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,yBAAyB,EAAE,CAAA,4BAAkC,CAAA,EAAE;YAC5F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,GAAG,CACD,UAAkB,EAClB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,KAAK,CAAC,iBAAiB,CACrB,UAAkB,EAClB,SAA0D,EAAE,EAC5D,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAEjG,MAAM,cAAc,GAAmB;YACrC,eAAe,EAAE,eAAe,IAAI,GAAG;YACvC,WAAW,EAAE,WAAW,IAAI,GAAG;YAC/B,OAAO,EAAE,OAAO,IAAI,yBAAe;YACnC,OAAO,EAAE,OAAO,IAAI,QAAQ;YAC5B,OAAO,EAAE,OAAO,IAAI,KAAK;SAC1B,CAAC;QAEF,OAAO,IAAA,2BAAiB,EACtB,KAAK,IAAI,EAAE;YACT,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QACpD,CAAC,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,WAAW,EACnC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,QAAQ,EAChC,CAAC,GAAG,EAAE,EAAE;YACN,MAAM,UAAU,GAAG,CAAC,aAAa,UAAU,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACjF,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;gBACtB,UAAU,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YACjD,CAAC;YACD,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,EACD,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,KAAK,CAAC,KAAK,CAAC,MAAwB,EAAE,OAAwB;QAC5D,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;QAE5F,uBAAuB;QACvB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAErD,sBAAsB;QACtB,MAAM,cAAc,GAAmB,EAAE,CAAC;QAC1C,IAAI,eAAe,KAAK,SAAS;YAAE,cAAc,CAAC,eAAe,GAAG,eAAe,CAAC;QACpF,IAAI,WAAW,KAAK,SAAS;YAAE,cAAc,CAAC,WAAW,GAAG,WAAW,CAAC;QACxE,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAE5D,8DAA8D;QAC9D,MAAM,UAAU,GAAiC;YAC/C,GAAG,cAAc;SAClB,CAAC;QACF,IAAI,YAAY,CAAC,eAAe,KAAK,SAAS;YAAE,UAAU,CAAC,eAAe,GAAG,YAAY,CAAC,eAAe,CAAC;QAC1G,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS;YAAE,UAAU,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAE3F,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AAtLD,sBAsLC"}
1
+ {"version":3,"file":"split.js","sourceRoot":"","sources":["../../src/resources/beta/split.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,yDAAiG;AAEjG,uDAAiD;AACjD,mDAAwF;AAExF,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,yBAAyB,EAAE;YAClD,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,yBAAyB,EAAE,CAAA,4BAAkC,CAAA,EAAE;YAC5F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CACD,UAAkB,EAClB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,2BAA2B,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,KAAK,CAAC,iBAAiB,CACrB,UAAkB,EAClB,SAA0D,EAAE,EAC5D,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAEjG,MAAM,cAAc,GAAmB;YACrC,eAAe,EAAE,eAAe,IAAI,GAAG;YACvC,WAAW,EAAE,WAAW,IAAI,GAAG;YAC/B,OAAO,EAAE,OAAO,IAAI,yBAAe;YACnC,OAAO,EAAE,OAAO,IAAI,QAAQ;YAC5B,OAAO,EAAE,OAAO,IAAI,KAAK;SAC1B,CAAC;QAEF,OAAO,IAAA,2BAAiB,EACtB,KAAK,IAAI,EAAE;YACT,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QACpD,CAAC,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,WAAW,EACnC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,QAAQ,EAChC,CAAC,GAAG,EAAE,EAAE;YACN,MAAM,UAAU,GAAG,CAAC,aAAa,UAAU,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACjF,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;gBACtB,UAAU,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YACjD,CAAC;YACD,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,EACD,cAAc,CACf,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,KAAK,CAAC,KAAK,CAAC,MAAwB,EAAE,OAAwB;QAC5D,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;QAE5F,uBAAuB;QACvB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAErD,sBAAsB;QACtB,MAAM,cAAc,GAAmB,EAAE,CAAC;QAC1C,IAAI,eAAe,KAAK,SAAS;YAAE,cAAc,CAAC,eAAe,GAAG,eAAe,CAAC;QACpF,IAAI,WAAW,KAAK,SAAS;YAAE,cAAc,CAAC,WAAW,GAAG,WAAW,CAAC;QACxE,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAC5D,IAAI,OAAO,KAAK,SAAS;YAAE,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;QAE5D,8DAA8D;QAC9D,MAAM,UAAU,GAAiC;YAC/C,GAAG,cAAc;SAClB,CAAC;QACF,IAAI,YAAY,CAAC,eAAe,KAAK,SAAS;YAAE,UAAU,CAAC,eAAe,GAAG,YAAY,CAAC,eAAe,CAAC;QAC1G,IAAI,YAAY,CAAC,UAAU,KAAK,SAAS;YAAE,UAAU,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAE3F,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AArMD,sBAqMC"}