@llamaindex/llama-cloud 2.2.0 → 2.4.0

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 (172) hide show
  1. package/CHANGELOG.md +38 -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 +57 -0
  14. package/resources/beta/agent-data.d.mts.map +1 -1
  15. package/resources/beta/agent-data.d.ts +57 -0
  16. package/resources/beta/agent-data.d.ts.map +1 -1
  17. package/resources/beta/agent-data.js +57 -0
  18. package/resources/beta/agent-data.js.map +1 -1
  19. package/resources/beta/agent-data.mjs +57 -0
  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 +0 -4
  38. package/resources/beta/beta.d.mts.map +1 -1
  39. package/resources/beta/beta.d.ts +0 -4
  40. package/resources/beta/beta.d.ts.map +1 -1
  41. package/resources/beta/beta.js +0 -4
  42. package/resources/beta/beta.js.map +1 -1
  43. package/resources/beta/beta.mjs +0 -4
  44. package/resources/beta/beta.mjs.map +1 -1
  45. package/resources/beta/directories/directories.d.mts +34 -0
  46. package/resources/beta/directories/directories.d.mts.map +1 -1
  47. package/resources/beta/directories/directories.d.ts +34 -0
  48. package/resources/beta/directories/directories.d.ts.map +1 -1
  49. package/resources/beta/directories/directories.js +34 -0
  50. package/resources/beta/directories/directories.js.map +1 -1
  51. package/resources/beta/directories/directories.mjs +34 -0
  52. package/resources/beta/directories/directories.mjs.map +1 -1
  53. package/resources/beta/directories/files.d.mts +93 -0
  54. package/resources/beta/directories/files.d.mts.map +1 -1
  55. package/resources/beta/directories/files.d.ts +93 -0
  56. package/resources/beta/directories/files.d.ts.map +1 -1
  57. package/resources/beta/directories/files.js +50 -0
  58. package/resources/beta/directories/files.js.map +1 -1
  59. package/resources/beta/directories/files.mjs +50 -0
  60. package/resources/beta/directories/files.mjs.map +1 -1
  61. package/resources/beta/index.d.mts +0 -1
  62. package/resources/beta/index.d.mts.map +1 -1
  63. package/resources/beta/index.d.ts +0 -1
  64. package/resources/beta/index.d.ts.map +1 -1
  65. package/resources/beta/index.js +1 -3
  66. package/resources/beta/index.js.map +1 -1
  67. package/resources/beta/index.mjs +0 -1
  68. package/resources/beta/index.mjs.map +1 -1
  69. package/resources/beta/sheets.d.mts +38 -0
  70. package/resources/beta/sheets.d.mts.map +1 -1
  71. package/resources/beta/sheets.d.ts +38 -0
  72. package/resources/beta/sheets.d.ts.map +1 -1
  73. package/resources/beta/sheets.js +38 -0
  74. package/resources/beta/sheets.js.map +1 -1
  75. package/resources/beta/sheets.mjs +38 -0
  76. package/resources/beta/sheets.mjs.map +1 -1
  77. package/resources/beta/split.d.mts +25 -10
  78. package/resources/beta/split.d.mts.map +1 -1
  79. package/resources/beta/split.d.ts +25 -10
  80. package/resources/beta/split.d.ts.map +1 -1
  81. package/resources/beta/split.js +21 -6
  82. package/resources/beta/split.js.map +1 -1
  83. package/resources/beta/split.mjs +21 -6
  84. package/resources/beta/split.mjs.map +1 -1
  85. package/resources/classify.d.mts +70 -0
  86. package/resources/classify.d.mts.map +1 -1
  87. package/resources/classify.d.ts +70 -0
  88. package/resources/classify.d.ts.map +1 -1
  89. package/resources/classify.js +113 -0
  90. package/resources/classify.js.map +1 -1
  91. package/resources/classify.mjs +113 -0
  92. package/resources/classify.mjs.map +1 -1
  93. package/resources/configurations.d.mts +214 -13
  94. package/resources/configurations.d.mts.map +1 -1
  95. package/resources/configurations.d.ts +214 -13
  96. package/resources/configurations.d.ts.map +1 -1
  97. package/resources/extract.d.mts +16 -6
  98. package/resources/extract.d.mts.map +1 -1
  99. package/resources/extract.d.ts +16 -6
  100. package/resources/extract.d.ts.map +1 -1
  101. package/resources/extract.js +14 -1
  102. package/resources/extract.js.map +1 -1
  103. package/resources/extract.mjs +14 -1
  104. package/resources/extract.mjs.map +1 -1
  105. package/resources/index.d.mts +1 -1
  106. package/resources/index.d.mts.map +1 -1
  107. package/resources/index.d.ts +1 -1
  108. package/resources/index.d.ts.map +1 -1
  109. package/resources/index.js.map +1 -1
  110. package/resources/index.mjs.map +1 -1
  111. package/resources/parsing.d.mts +5 -4
  112. package/resources/parsing.d.mts.map +1 -1
  113. package/resources/parsing.d.ts +5 -4
  114. package/resources/parsing.d.ts.map +1 -1
  115. package/resources/pipelines/documents.d.mts +0 -3
  116. package/resources/pipelines/documents.d.mts.map +1 -1
  117. package/resources/pipelines/documents.d.ts +0 -3
  118. package/resources/pipelines/documents.d.ts.map +1 -1
  119. package/resources/pipelines/pipelines.d.mts +0 -7
  120. package/resources/pipelines/pipelines.d.mts.map +1 -1
  121. package/resources/pipelines/pipelines.d.ts +0 -7
  122. package/resources/pipelines/pipelines.d.ts.map +1 -1
  123. package/resources/pipelines/pipelines.js.map +1 -1
  124. package/resources/pipelines/pipelines.mjs.map +1 -1
  125. package/resources/retrievers/index.d.mts +1 -1
  126. package/resources/retrievers/index.d.mts.map +1 -1
  127. package/resources/retrievers/index.d.ts +1 -1
  128. package/resources/retrievers/index.d.ts.map +1 -1
  129. package/resources/retrievers/index.js.map +1 -1
  130. package/resources/retrievers/index.mjs.map +1 -1
  131. package/resources/retrievers/retrievers.d.mts +17 -5
  132. package/resources/retrievers/retrievers.d.mts.map +1 -1
  133. package/resources/retrievers/retrievers.d.ts +17 -5
  134. package/resources/retrievers/retrievers.d.ts.map +1 -1
  135. package/resources/retrievers/retrievers.js +10 -3
  136. package/resources/retrievers/retrievers.js.map +1 -1
  137. package/resources/retrievers/retrievers.mjs +10 -3
  138. package/resources/retrievers/retrievers.mjs.map +1 -1
  139. package/src/client.ts +2 -0
  140. package/src/internal/utils/env.ts +2 -2
  141. package/src/resources/beta/agent-data.ts +57 -0
  142. package/src/resources/beta/batch/batch.ts +27 -0
  143. package/src/resources/beta/batch/job-items.ts +18 -0
  144. package/src/resources/beta/beta.ts +0 -29
  145. package/src/resources/beta/directories/directories.ts +34 -0
  146. package/src/resources/beta/directories/files.ts +86 -0
  147. package/src/resources/beta/index.ts +0 -12
  148. package/src/resources/beta/sheets.ts +38 -0
  149. package/src/resources/beta/split.ts +25 -10
  150. package/src/resources/classify.ts +130 -0
  151. package/src/resources/configurations.ts +256 -8
  152. package/src/resources/extract.ts +16 -7
  153. package/src/resources/index.ts +1 -0
  154. package/src/resources/parsing.ts +9 -2
  155. package/src/resources/pipelines/documents.ts +0 -3
  156. package/src/resources/pipelines/pipelines.ts +0 -7
  157. package/src/resources/retrievers/index.ts +1 -0
  158. package/src/resources/retrievers/retrievers.ts +37 -5
  159. package/src/version.ts +1 -1
  160. package/version.d.mts +1 -1
  161. package/version.d.ts +1 -1
  162. package/version.js +1 -1
  163. package/version.mjs +1 -1
  164. package/resources/beta/parse-configurations.d.mts +0 -210
  165. package/resources/beta/parse-configurations.d.mts.map +0 -1
  166. package/resources/beta/parse-configurations.d.ts +0 -210
  167. package/resources/beta/parse-configurations.d.ts.map +0 -1
  168. package/resources/beta/parse-configurations.js +0 -84
  169. package/resources/beta/parse-configurations.js.map +0 -1
  170. package/resources/beta/parse-configurations.mjs +0 -80
  171. package/resources/beta/parse-configurations.mjs.map +0 -1
  172. package/src/resources/beta/parse-configurations.ts +0 -311
@@ -16,6 +16,14 @@ class Files extends resource_1.APIResource {
16
16
  * Note: This endpoint uses directory_file_id (the internal ID). If you're trying
17
17
  * to update a file by its unique_id, use the list endpoint with a filter to find
18
18
  * the directory_file_id first.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const file = await client.beta.directories.files.update(
23
+ * 'directory_file_id',
24
+ * { path_directory_id: 'directory_id' },
25
+ * );
26
+ * ```
19
27
  */
20
28
  update(directoryFileID, params, options) {
21
29
  const { path_directory_id, organization_id, project_id, ...body } = params;
@@ -28,6 +36,16 @@ class Files extends resource_1.APIResource {
28
36
  /**
29
37
  * List all files within the specified directory with optional filtering and
30
38
  * pagination.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * // Automatically fetches more pages as needed.
43
+ * for await (const fileListResponse of client.beta.directories.files.list(
44
+ * 'directory_id',
45
+ * )) {
46
+ * // ...
47
+ * }
48
+ * ```
31
49
  */
32
50
  list(directoryID, query = {}, options) {
33
51
  return this._client.getAPIList((0, path_1.path) `/api/v1/beta/directories/${directoryID}/files`, (pagination_1.PaginatedCursor), { query, ...options });
@@ -38,6 +56,14 @@ class Files extends resource_1.APIResource {
38
56
  * Note: This endpoint uses directory_file_id (the internal ID). If you're trying
39
57
  * to delete a file by its unique_id, use the list endpoint with a filter to find
40
58
  * the directory_file_id first.
59
+ *
60
+ * @example
61
+ * ```ts
62
+ * await client.beta.directories.files.delete(
63
+ * 'directory_file_id',
64
+ * { directory_id: 'directory_id' },
65
+ * );
66
+ * ```
41
67
  */
42
68
  delete(directoryFileID, params, options) {
43
69
  const { directory_id, organization_id, project_id } = params;
@@ -52,6 +78,14 @@ class Files extends resource_1.APIResource {
52
78
  *
53
79
  * The directory must exist and belong to the project passed in. The file_id must
54
80
  * be provided and exist in the project.
81
+ *
82
+ * @example
83
+ * ```ts
84
+ * const response = await client.beta.directories.files.add(
85
+ * 'directory_id',
86
+ * { file_id: 'file_id' },
87
+ * );
88
+ * ```
55
89
  */
56
90
  add(directoryID, params, options) {
57
91
  const { organization_id, project_id, ...body } = params;
@@ -65,6 +99,14 @@ class Files extends resource_1.APIResource {
65
99
  * Get a file by its directory_file_id within the specified directory. If you're
66
100
  * trying to get a file by its unique_id, use the list endpoint with a filter
67
101
  * instead.
102
+ *
103
+ * @example
104
+ * ```ts
105
+ * const file = await client.beta.directories.files.get(
106
+ * 'directory_file_id',
107
+ * { directory_id: 'directory_id' },
108
+ * );
109
+ * ```
68
110
  */
69
111
  get(directoryFileID, params, options) {
70
112
  const { directory_id, ...query } = params;
@@ -79,6 +121,14 @@ class Files extends resource_1.APIResource {
79
121
  * Uploads a file and creates a directory file entry in a single operation. If
80
122
  * unique_id or display_name are not provided, they will be derived from the file
81
123
  * metadata.
124
+ *
125
+ * @example
126
+ * ```ts
127
+ * const response = await client.beta.directories.files.upload(
128
+ * 'directory_id',
129
+ * { upload_file: fs.createReadStream('path/to/file') },
130
+ * );
131
+ * ```
82
132
  */
83
133
  upload(directoryID, params, options) {
84
134
  const { organization_id, project_id, ...body } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"files.js","sourceRoot":"","sources":["../../../src/resources/beta/directories/files.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAAoG;AAEpG,0DAAyD;AAEzD,0DAAwE;AACxE,0DAAoD;AAEpD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;OAQG;IACH,MAAM,CACJ,eAAuB,EACvB,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,4BAA4B,iBAAiB,UAAU,eAAe,EAAE,EAAE;YACtG,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,WAAmB,EACnB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,4BAA4B,WAAW,QAAQ,EACnD,CAAA,4BAAiC,CAAA,EACjC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,eAAuB,EAAE,MAAwB,EAAE,OAAwB;QAChF,MAAM,EAAE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,YAAY,UAAU,eAAe,EAAE,EAAE;YAClG,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,WAAmB,EAAE,MAAqB,EAAE,OAAwB;QACtE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,4BAA4B,WAAW,QAAQ,EAAE;YAC5E,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,eAAuB,EAAE,MAAqB,EAAE,OAAwB;QAC1E,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,4BAA4B,YAAY,UAAU,eAAe,EAAE,EAAE;YAC/F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,WAAmB,EACnB,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,WAAI,EAAA,4BAA4B,WAAW,eAAe,EAC1D,IAAA,qCAA2B,EAAC,EAAE,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CACxG,CAAC;IACJ,CAAC;CACF;AArGD,sBAqGC"}
1
+ {"version":3,"file":"files.js","sourceRoot":"","sources":["../../../src/resources/beta/directories/files.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAErD,4DAAoG;AAEpG,0DAAyD;AAEzD,0DAAwE;AACxE,0DAAoD;AAEpD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,eAAuB,EACvB,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,4BAA4B,iBAAiB,UAAU,eAAe,EAAE,EAAE;YACtG,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,WAAmB,EACnB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,4BAA4B,WAAW,QAAQ,EACnD,CAAA,4BAAiC,CAAA,EACjC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,eAAuB,EAAE,MAAwB,EAAE,OAAwB;QAChF,MAAM,EAAE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,4BAA4B,YAAY,UAAU,eAAe,EAAE,EAAE;YAClG,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,WAAmB,EAAE,MAAqB,EAAE,OAAwB;QACtE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,4BAA4B,WAAW,QAAQ,EAAE;YAC5E,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,eAAuB,EAAE,MAAqB,EAAE,OAAwB;QAC1E,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,4BAA4B,YAAY,UAAU,eAAe,EAAE,EAAE;YAC/F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,WAAmB,EACnB,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,WAAI,EAAA,4BAA4B,WAAW,eAAe,EAC1D,IAAA,qCAA2B,EAAC,EAAE,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CACxG,CAAC;IACJ,CAAC;CACF;AAvJD,sBAuJC"}
@@ -13,6 +13,14 @@ export class Files extends APIResource {
13
13
  * Note: This endpoint uses directory_file_id (the internal ID). If you're trying
14
14
  * to update a file by its unique_id, use the list endpoint with a filter to find
15
15
  * the directory_file_id first.
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * const file = await client.beta.directories.files.update(
20
+ * 'directory_file_id',
21
+ * { path_directory_id: 'directory_id' },
22
+ * );
23
+ * ```
16
24
  */
17
25
  update(directoryFileID, params, options) {
18
26
  const { path_directory_id, organization_id, project_id, ...body } = params;
@@ -25,6 +33,16 @@ export class Files extends APIResource {
25
33
  /**
26
34
  * List all files within the specified directory with optional filtering and
27
35
  * pagination.
36
+ *
37
+ * @example
38
+ * ```ts
39
+ * // Automatically fetches more pages as needed.
40
+ * for await (const fileListResponse of client.beta.directories.files.list(
41
+ * 'directory_id',
42
+ * )) {
43
+ * // ...
44
+ * }
45
+ * ```
28
46
  */
29
47
  list(directoryID, query = {}, options) {
30
48
  return this._client.getAPIList(path `/api/v1/beta/directories/${directoryID}/files`, (PaginatedCursor), { query, ...options });
@@ -35,6 +53,14 @@ export class Files extends APIResource {
35
53
  * Note: This endpoint uses directory_file_id (the internal ID). If you're trying
36
54
  * to delete a file by its unique_id, use the list endpoint with a filter to find
37
55
  * the directory_file_id first.
56
+ *
57
+ * @example
58
+ * ```ts
59
+ * await client.beta.directories.files.delete(
60
+ * 'directory_file_id',
61
+ * { directory_id: 'directory_id' },
62
+ * );
63
+ * ```
38
64
  */
39
65
  delete(directoryFileID, params, options) {
40
66
  const { directory_id, organization_id, project_id } = params;
@@ -49,6 +75,14 @@ export class Files extends APIResource {
49
75
  *
50
76
  * The directory must exist and belong to the project passed in. The file_id must
51
77
  * be provided and exist in the project.
78
+ *
79
+ * @example
80
+ * ```ts
81
+ * const response = await client.beta.directories.files.add(
82
+ * 'directory_id',
83
+ * { file_id: 'file_id' },
84
+ * );
85
+ * ```
52
86
  */
53
87
  add(directoryID, params, options) {
54
88
  const { organization_id, project_id, ...body } = params;
@@ -62,6 +96,14 @@ export class Files extends APIResource {
62
96
  * Get a file by its directory_file_id within the specified directory. If you're
63
97
  * trying to get a file by its unique_id, use the list endpoint with a filter
64
98
  * instead.
99
+ *
100
+ * @example
101
+ * ```ts
102
+ * const file = await client.beta.directories.files.get(
103
+ * 'directory_file_id',
104
+ * { directory_id: 'directory_id' },
105
+ * );
106
+ * ```
65
107
  */
66
108
  get(directoryFileID, params, options) {
67
109
  const { directory_id, ...query } = params;
@@ -76,6 +118,14 @@ export class Files extends APIResource {
76
118
  * Uploads a file and creates a directory file entry in a single operation. If
77
119
  * unique_id or display_name are not provided, they will be derived from the file
78
120
  * metadata.
121
+ *
122
+ * @example
123
+ * ```ts
124
+ * const response = await client.beta.directories.files.upload(
125
+ * 'directory_id',
126
+ * { upload_file: fs.createReadStream('path/to/file') },
127
+ * );
128
+ * ```
79
129
  */
80
130
  upload(directoryID, params, options) {
81
131
  const { organization_id, project_id, ...body } = params;
@@ -1 +1 @@
1
- {"version":3,"file":"files.mjs","sourceRoot":"","sources":["../../../src/resources/beta/directories/files.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,eAAe,EAA8B;OAE5D,EAAE,YAAY,EAAE;OAEhB,EAAE,2BAA2B,EAAE;OAC/B,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;OAQG;IACH,MAAM,CACJ,eAAuB,EACvB,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,4BAA4B,iBAAiB,UAAU,eAAe,EAAE,EAAE;YACtG,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,IAAI,CACF,WAAmB,EACnB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,4BAA4B,WAAW,QAAQ,EACnD,CAAA,eAAiC,CAAA,EACjC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,eAAuB,EAAE,MAAwB,EAAE,OAAwB;QAChF,MAAM,EAAE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,4BAA4B,YAAY,UAAU,eAAe,EAAE,EAAE;YAClG,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,WAAmB,EAAE,MAAqB,EAAE,OAAwB;QACtE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,4BAA4B,WAAW,QAAQ,EAAE;YAC5E,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,eAAuB,EAAE,MAAqB,EAAE,OAAwB;QAC1E,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,4BAA4B,YAAY,UAAU,eAAe,EAAE,EAAE;YAC/F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,WAAmB,EACnB,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAI,CAAA,4BAA4B,WAAW,eAAe,EAC1D,2BAA2B,CAAC,EAAE,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CACxG,CAAC;IACJ,CAAC;CACF"}
1
+ {"version":3,"file":"files.mjs","sourceRoot":"","sources":["../../../src/resources/beta/directories/files.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,eAAe,EAA8B;OAE5D,EAAE,YAAY,EAAE;OAEhB,EAAE,2BAA2B,EAAE;OAC/B,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,eAAuB,EACvB,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,4BAA4B,iBAAiB,UAAU,eAAe,EAAE,EAAE;YACtG,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,WAAmB,EACnB,QAA2C,EAAE,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,4BAA4B,WAAW,QAAQ,EACnD,CAAA,eAAiC,CAAA,EACjC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,eAAuB,EAAE,MAAwB,EAAE,OAAwB;QAChF,MAAM,EAAE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,4BAA4B,YAAY,UAAU,eAAe,EAAE,EAAE;YAClG,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,WAAmB,EAAE,MAAqB,EAAE,OAAwB;QACtE,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,4BAA4B,WAAW,QAAQ,EAAE;YAC5E,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE;YACtC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,eAAuB,EAAE,MAAqB,EAAE,OAAwB;QAC1E,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,4BAA4B,YAAY,UAAU,eAAe,EAAE,EAAE;YAC/F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,WAAmB,EACnB,MAAwB,EACxB,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAI,CAAA,4BAA4B,WAAW,eAAe,EAC1D,2BAA2B,CAAC,EAAE,KAAK,EAAE,EAAE,eAAe,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CACxG,CAAC;IACJ,CAAC;CACF"}
@@ -2,7 +2,6 @@ export { AgentData, type AgentDataDeleteResponse, type AgentDataAggregateRespons
2
2
  export { Batch, type BatchCreateResponse, type BatchListResponse, type BatchCancelResponse, type BatchGetStatusResponse, type BatchCreateParams, type BatchListParams, type BatchCancelParams, type BatchGetStatusParams, type BatchListResponsesPaginatedBatchItems, } from "./batch/index.mjs";
3
3
  export { Beta } from "./beta.mjs";
4
4
  export { Directories, type DirectoryCreateResponse, type DirectoryUpdateResponse, type DirectoryListResponse, type DirectoryGetResponse, type DirectoryCreateParams, type DirectoryUpdateParams, type DirectoryListParams, type DirectoryDeleteParams, type DirectoryGetParams, type DirectoryListResponsesPaginatedCursor, } from "./directories/index.mjs";
5
- export { ParseConfigurations, type ParseConfiguration, type ParseConfigurationCreate, type ParseConfigurationQueryResponse, type ParseConfigurationCreateParams, type ParseConfigurationUpdateParams, type ParseConfigurationListParams, type ParseConfigurationDeleteParams, type ParseConfigurationGetParams, type ParseConfigurationsPaginatedCursor, } from "./parse-configurations.mjs";
6
5
  export { Sheets, type SheetsJob, type SheetsParsingConfig, type SheetDeleteJobResponse, type SheetCreateParams, type SheetListParams, type SheetDeleteJobParams, type SheetGetParams, type SheetGetResultTableParams, type SheetsJobsPaginatedCursor, } from "./sheets.mjs";
7
6
  export { Split, type SplitCategory, type SplitDocumentInput, type SplitResultResponse, type SplitSegmentResponse, type SplitCreateResponse, type SplitListResponse, type SplitGetResponse, type SplitCreateParams, type SplitListParams, type SplitGetParams, type SplitListResponsesPaginatedCursor, } from "./split.mjs";
8
7
  //# sourceMappingURL=index.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/beta/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,8CAA8C,EACnD,KAAK,4BAA4B,GAClC;OACM,EACL,KAAK,EACL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,qCAAqC,GAC3C;OACM,EAAE,IAAI,EAAE;OACR,EACL,WAAW,EACX,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,qCAAqC,GAC3C;OACM,EACL,mBAAmB,EACnB,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,EACpC,KAAK,8BAA8B,EACnC,KAAK,8BAA8B,EACnC,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EACnC,KAAK,2BAA2B,EAChC,KAAK,kCAAkC,GACxC;OACM,EACL,MAAM,EACN,KAAK,SAAS,EACd,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,GAC/B;OACM,EACL,KAAK,EACL,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,iCAAiC,GACvC"}
1
+ {"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/beta/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,8CAA8C,EACnD,KAAK,4BAA4B,GAClC;OACM,EACL,KAAK,EACL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,qCAAqC,GAC3C;OACM,EAAE,IAAI,EAAE;OACR,EACL,WAAW,EACX,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,qCAAqC,GAC3C;OACM,EACL,MAAM,EACN,KAAK,SAAS,EACd,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,GAC/B;OACM,EACL,KAAK,EACL,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,iCAAiC,GACvC"}
@@ -2,7 +2,6 @@ export { AgentData, type AgentDataDeleteResponse, type AgentDataAggregateRespons
2
2
  export { Batch, type BatchCreateResponse, type BatchListResponse, type BatchCancelResponse, type BatchGetStatusResponse, type BatchCreateParams, type BatchListParams, type BatchCancelParams, type BatchGetStatusParams, type BatchListResponsesPaginatedBatchItems, } from "./batch/index.js";
3
3
  export { Beta } from "./beta.js";
4
4
  export { Directories, type DirectoryCreateResponse, type DirectoryUpdateResponse, type DirectoryListResponse, type DirectoryGetResponse, type DirectoryCreateParams, type DirectoryUpdateParams, type DirectoryListParams, type DirectoryDeleteParams, type DirectoryGetParams, type DirectoryListResponsesPaginatedCursor, } from "./directories/index.js";
5
- export { ParseConfigurations, type ParseConfiguration, type ParseConfigurationCreate, type ParseConfigurationQueryResponse, type ParseConfigurationCreateParams, type ParseConfigurationUpdateParams, type ParseConfigurationListParams, type ParseConfigurationDeleteParams, type ParseConfigurationGetParams, type ParseConfigurationsPaginatedCursor, } from "./parse-configurations.js";
6
5
  export { Sheets, type SheetsJob, type SheetsParsingConfig, type SheetDeleteJobResponse, type SheetCreateParams, type SheetListParams, type SheetDeleteJobParams, type SheetGetParams, type SheetGetResultTableParams, type SheetsJobsPaginatedCursor, } from "./sheets.js";
7
6
  export { Split, type SplitCategory, type SplitDocumentInput, type SplitResultResponse, type SplitSegmentResponse, type SplitCreateResponse, type SplitListResponse, type SplitGetResponse, type SplitCreateParams, type SplitListParams, type SplitGetParams, type SplitListResponsesPaginatedCursor, } from "./split.js";
8
7
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/beta/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,8CAA8C,EACnD,KAAK,4BAA4B,GAClC;OACM,EACL,KAAK,EACL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,qCAAqC,GAC3C;OACM,EAAE,IAAI,EAAE;OACR,EACL,WAAW,EACX,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,qCAAqC,GAC3C;OACM,EACL,mBAAmB,EACnB,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,EACpC,KAAK,8BAA8B,EACnC,KAAK,8BAA8B,EACnC,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EACnC,KAAK,2BAA2B,EAChC,KAAK,kCAAkC,GACxC;OACM,EACL,MAAM,EACN,KAAK,SAAS,EACd,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,GAC/B;OACM,EACL,KAAK,EACL,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,iCAAiC,GACvC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/beta/index.ts"],"names":[],"mappings":"OAEO,EACL,SAAS,EACT,KAAK,uBAAuB,EAC5B,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,8CAA8C,EACnD,KAAK,4BAA4B,GAClC;OACM,EACL,KAAK,EACL,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,qCAAqC,GAC3C;OACM,EAAE,IAAI,EAAE;OACR,EACL,WAAW,EACX,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,qCAAqC,GAC3C;OACM,EACL,MAAM,EACN,KAAK,SAAS,EACd,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,GAC/B;OACM,EACL,KAAK,EACL,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,iCAAiC,GACvC"}
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.Split = exports.Sheets = exports.ParseConfigurations = exports.Directories = exports.Beta = exports.Batch = exports.AgentData = void 0;
4
+ exports.Split = exports.Sheets = exports.Directories = exports.Beta = exports.Batch = exports.AgentData = void 0;
5
5
  var agent_data_1 = require("./agent-data.js");
6
6
  Object.defineProperty(exports, "AgentData", { enumerable: true, get: function () { return agent_data_1.AgentData; } });
7
7
  var index_1 = require("./batch/index.js");
@@ -10,8 +10,6 @@ var beta_1 = require("./beta.js");
10
10
  Object.defineProperty(exports, "Beta", { enumerable: true, get: function () { return beta_1.Beta; } });
11
11
  var index_2 = require("./directories/index.js");
12
12
  Object.defineProperty(exports, "Directories", { enumerable: true, get: function () { return index_2.Directories; } });
13
- var parse_configurations_1 = require("./parse-configurations.js");
14
- Object.defineProperty(exports, "ParseConfigurations", { enumerable: true, get: function () { return parse_configurations_1.ParseConfigurations; } });
15
13
  var sheets_1 = require("./sheets.js");
16
14
  Object.defineProperty(exports, "Sheets", { enumerable: true, get: function () { return sheets_1.Sheets; } });
17
15
  var split_1 = require("./split.js");
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/beta/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CAcsB;AAbpB,uGAAA,SAAS,OAAA;AAcX,0CAWuB;AAVrB,8FAAA,KAAK,OAAA;AAWP,kCAA8B;AAArB,4FAAA,IAAI,OAAA;AACb,gDAY6B;AAX3B,oGAAA,WAAW,OAAA;AAYb,kEAWgC;AAV9B,2HAAA,mBAAmB,OAAA;AAWrB,sCAWkB;AAVhB,gGAAA,MAAM,OAAA;AAWR,oCAaiB;AAZf,8FAAA,KAAK,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/beta/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8CAcsB;AAbpB,uGAAA,SAAS,OAAA;AAcX,0CAWuB;AAVrB,8FAAA,KAAK,OAAA;AAWP,kCAA8B;AAArB,4FAAA,IAAI,OAAA;AACb,gDAY6B;AAX3B,oGAAA,WAAW,OAAA;AAYb,sCAWkB;AAVhB,gGAAA,MAAM,OAAA;AAWR,oCAaiB;AAZf,8FAAA,KAAK,OAAA"}
@@ -3,7 +3,6 @@ export { AgentData, } from "./agent-data.mjs";
3
3
  export { Batch, } from "./batch/index.mjs";
4
4
  export { Beta } from "./beta.mjs";
5
5
  export { Directories, } from "./directories/index.mjs";
6
- export { ParseConfigurations, } from "./parse-configurations.mjs";
7
6
  export { Sheets, } from "./sheets.mjs";
8
7
  export { Split, } from "./split.mjs";
9
8
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/beta/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,GAaV;OACM,EACL,KAAK,GAUN;OACM,EAAE,IAAI,EAAE;OACR,EACL,WAAW,GAWZ;OACM,EACL,mBAAmB,GAUpB;OACM,EACL,MAAM,GAUP;OACM,EACL,KAAK,GAYN"}
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/beta/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,SAAS,GAaV;OACM,EACL,KAAK,GAUN;OACM,EAAE,IAAI,EAAE;OACR,EACL,WAAW,GAWZ;OACM,EACL,MAAM,GAUP;OACM,EACL,KAAK,GAYN"}
@@ -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;