@osdk/internal.foundry.datasets 2.78.0 → 2.79.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 (111) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/build/browser/index.d.ts +1 -6
  3. package/build/browser/index.d.ts.map +1 -1
  4. package/build/browser/index.js +1 -4
  5. package/build/browser/index.js.map +1 -1
  6. package/build/browser/public/Branch.d.ts +1 -49
  7. package/build/browser/public/Branch.d.ts.map +1 -1
  8. package/build/browser/public/Branch.js +1 -50
  9. package/build/browser/public/Branch.js.map +1 -1
  10. package/build/browser/public/Dataset.d.ts +1 -91
  11. package/build/browser/public/Dataset.d.ts.map +1 -1
  12. package/build/browser/public/Dataset.js +1 -76
  13. package/build/browser/public/Dataset.js.map +1 -1
  14. package/build/browser/public/File.d.ts +1 -190
  15. package/build/browser/public/File.d.ts.map +1 -1
  16. package/build/browser/public/File.js +1 -162
  17. package/build/browser/public/File.js.map +1 -1
  18. package/build/browser/public/Transaction.d.ts +1 -56
  19. package/build/browser/public/Transaction.d.ts.map +1 -1
  20. package/build/browser/public/Transaction.js +1 -52
  21. package/build/browser/public/Transaction.js.map +1 -1
  22. package/build/browser/public/v1.d.ts +2 -0
  23. package/build/browser/public/v1.d.ts.map +1 -0
  24. package/build/browser/public/v1.js +17 -0
  25. package/build/browser/public/v1.js.map +1 -0
  26. package/build/browser/{_components.d.ts → v1/_components.d.ts} +1 -1
  27. package/build/browser/v1/_components.d.ts.map +1 -0
  28. package/build/browser/v1/_errors.d.ts.map +1 -0
  29. package/build/browser/v1/index.d.ts +7 -0
  30. package/build/browser/v1/index.d.ts.map +1 -0
  31. package/build/browser/v1/index.js +20 -0
  32. package/build/browser/v1/index.js.map +1 -0
  33. package/build/browser/v1/public/Branch.d.ts +50 -0
  34. package/build/browser/v1/public/Branch.d.ts.map +1 -0
  35. package/build/browser/v1/public/Branch.js +66 -0
  36. package/build/browser/v1/public/Branch.js.map +1 -0
  37. package/build/browser/v1/public/Dataset.d.ts +92 -0
  38. package/build/browser/v1/public/Dataset.d.ts.map +1 -0
  39. package/build/browser/v1/public/Dataset.js +92 -0
  40. package/build/browser/v1/public/Dataset.js.map +1 -0
  41. package/build/browser/v1/public/File.d.ts +191 -0
  42. package/build/browser/v1/public/File.d.ts.map +1 -0
  43. package/build/browser/v1/public/File.js +178 -0
  44. package/build/browser/v1/public/File.js.map +1 -0
  45. package/build/browser/v1/public/Transaction.d.ts +57 -0
  46. package/build/browser/v1/public/Transaction.d.ts.map +1 -0
  47. package/build/browser/v1/public/Transaction.js +68 -0
  48. package/build/browser/v1/public/Transaction.js.map +1 -0
  49. package/build/esm/index.d.ts +1 -6
  50. package/build/esm/index.d.ts.map +1 -1
  51. package/build/esm/index.js +1 -4
  52. package/build/esm/index.js.map +1 -1
  53. package/build/esm/public/Branch.d.ts +1 -49
  54. package/build/esm/public/Branch.d.ts.map +1 -1
  55. package/build/esm/public/Branch.js +1 -50
  56. package/build/esm/public/Branch.js.map +1 -1
  57. package/build/esm/public/Dataset.d.ts +1 -91
  58. package/build/esm/public/Dataset.d.ts.map +1 -1
  59. package/build/esm/public/Dataset.js +1 -76
  60. package/build/esm/public/Dataset.js.map +1 -1
  61. package/build/esm/public/File.d.ts +1 -190
  62. package/build/esm/public/File.d.ts.map +1 -1
  63. package/build/esm/public/File.js +1 -162
  64. package/build/esm/public/File.js.map +1 -1
  65. package/build/esm/public/Transaction.d.ts +1 -56
  66. package/build/esm/public/Transaction.d.ts.map +1 -1
  67. package/build/esm/public/Transaction.js +1 -52
  68. package/build/esm/public/Transaction.js.map +1 -1
  69. package/build/esm/public/v1.d.ts +2 -0
  70. package/build/esm/public/v1.d.ts.map +1 -0
  71. package/build/esm/public/v1.js +17 -0
  72. package/build/esm/public/v1.js.map +1 -0
  73. package/build/esm/{_components.d.ts → v1/_components.d.ts} +1 -1
  74. package/build/esm/v1/_components.d.ts.map +1 -0
  75. package/build/esm/v1/_errors.d.ts.map +1 -0
  76. package/build/esm/v1/index.d.ts +7 -0
  77. package/build/esm/v1/index.d.ts.map +1 -0
  78. package/build/esm/v1/index.js +20 -0
  79. package/build/esm/v1/index.js.map +1 -0
  80. package/build/esm/v1/public/Branch.d.ts +50 -0
  81. package/build/esm/v1/public/Branch.d.ts.map +1 -0
  82. package/build/esm/v1/public/Branch.js +66 -0
  83. package/build/esm/v1/public/Branch.js.map +1 -0
  84. package/build/esm/v1/public/Dataset.d.ts +92 -0
  85. package/build/esm/v1/public/Dataset.d.ts.map +1 -0
  86. package/build/esm/v1/public/Dataset.js +92 -0
  87. package/build/esm/v1/public/Dataset.js.map +1 -0
  88. package/build/esm/v1/public/File.d.ts +191 -0
  89. package/build/esm/v1/public/File.d.ts.map +1 -0
  90. package/build/esm/v1/public/File.js +178 -0
  91. package/build/esm/v1/public/File.js.map +1 -0
  92. package/build/esm/v1/public/Transaction.d.ts +57 -0
  93. package/build/esm/v1/public/Transaction.d.ts.map +1 -0
  94. package/build/esm/v1/public/Transaction.js +68 -0
  95. package/build/esm/v1/public/Transaction.js.map +1 -0
  96. package/package.json +9 -4
  97. package/v1.d.ts +17 -0
  98. package/build/browser/_components.d.ts.map +0 -1
  99. package/build/browser/_errors.d.ts.map +0 -1
  100. package/build/esm/_components.d.ts.map +0 -1
  101. package/build/esm/_errors.d.ts.map +0 -1
  102. /package/build/browser/{_components.js → v1/_components.js} +0 -0
  103. /package/build/browser/{_components.js.map → v1/_components.js.map} +0 -0
  104. /package/build/browser/{_errors.d.ts → v1/_errors.d.ts} +0 -0
  105. /package/build/browser/{_errors.js → v1/_errors.js} +0 -0
  106. /package/build/browser/{_errors.js.map → v1/_errors.js.map} +0 -0
  107. /package/build/esm/{_components.js → v1/_components.js} +0 -0
  108. /package/build/esm/{_components.js.map → v1/_components.js.map} +0 -0
  109. /package/build/esm/{_errors.d.ts → v1/_errors.d.ts} +0 -0
  110. /package/build/esm/{_errors.js → v1/_errors.js} +0 -0
  111. /package/build/esm/{_errors.js.map → v1/_errors.js.map} +0 -0
@@ -0,0 +1,92 @@
1
+ import type * as _Core from "@osdk/internal.foundry.core/v1";
2
+ import type { SharedClient as $OldClient, SharedClientContext as $OldClientContext } from "@osdk/shared.client";
3
+ import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client2";
4
+ import type * as _Datasets from "../_components.js";
5
+ /**
6
+ * Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset.
7
+ *
8
+ * @public
9
+ *
10
+ * Required Scopes: [api:datasets-write]
11
+ * URL: /v1/datasets
12
+ */
13
+ export declare function create($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [$body: _Datasets.CreateDatasetRequest]): Promise<_Datasets.Dataset>;
14
+ /**
15
+ * Gets the Dataset with the given DatasetRid.
16
+ *
17
+ * @public
18
+ *
19
+ * Required Scopes: [api:datasets-read]
20
+ * URL: /v1/datasets/{datasetRid}
21
+ */
22
+ export declare function get($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [datasetRid: _Datasets.DatasetRid]): Promise<_Datasets.Dataset>;
23
+ /**
24
+ * Gets the content of a dataset as a table in the specified format.
25
+ *
26
+ * This endpoint currently does not support views (virtual datasets composed of other datasets). For more information, refer to the [views documentation](https://www.palantir.com/docs/foundry/data-integration/views).
27
+ *
28
+ * @public
29
+ *
30
+ * Required Scopes: [api:datasets-read]
31
+ * URL: /v1/datasets/{datasetRid}/readTable
32
+ */
33
+ export declare function read($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
34
+ datasetRid: _Datasets.DatasetRid,
35
+ $queryParams: {
36
+ branchId?: _Datasets.BranchId | undefined;
37
+ startTransactionRid?: _Datasets.TransactionRid | undefined;
38
+ endTransactionRid?: _Datasets.TransactionRid | undefined;
39
+ format: _Datasets.TableExportFormat;
40
+ columns: Array<string>;
41
+ rowLimit?: number | undefined;
42
+ }
43
+ ]): Promise<Response>;
44
+ /**
45
+ * Puts a Schema on an existing Dataset and Branch.
46
+ *
47
+ * @alpha
48
+ *
49
+ * Required Scopes: [api:datasets-write]
50
+ * URL: /v1/datasets/{datasetRid}/schema
51
+ */
52
+ export declare function replaceSchema($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
53
+ datasetRid: _Datasets.DatasetRid,
54
+ $body: any,
55
+ $queryParams?: {
56
+ branchId?: _Datasets.BranchId | undefined;
57
+ preview?: _Core.PreviewMode | undefined;
58
+ }
59
+ ]): Promise<void>;
60
+ /**
61
+ * Retrieves the Schema for a Dataset and Branch, if it exists.
62
+ *
63
+ * @alpha
64
+ *
65
+ * Required Scopes: [api:datasets-read]
66
+ * URL: /v1/datasets/{datasetRid}/schema
67
+ */
68
+ export declare function getSchema($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
69
+ datasetRid: _Datasets.DatasetRid,
70
+ $queryParams?: {
71
+ branchId?: _Datasets.BranchId | undefined;
72
+ transactionRid?: _Datasets.TransactionRid | undefined;
73
+ preview?: _Core.PreviewMode | undefined;
74
+ }
75
+ ]): Promise<any | undefined>;
76
+ /**
77
+ * Deletes the Schema from a Dataset and Branch.
78
+ *
79
+ * @alpha
80
+ *
81
+ * Required Scopes: [api:datasets-write]
82
+ * URL: /v1/datasets/{datasetRid}/schema
83
+ */
84
+ export declare function deleteSchema($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
85
+ datasetRid: _Datasets.DatasetRid,
86
+ $queryParams?: {
87
+ branchId?: _Datasets.BranchId | undefined;
88
+ transactionRid?: _Datasets.TransactionRid | undefined;
89
+ preview?: _Core.PreviewMode | undefined;
90
+ }
91
+ ]): Promise<void>;
92
+ //# sourceMappingURL=Dataset.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Dataset.d.ts","sourceRoot":"","sources":["../../../../src/v1/public/Dataset.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,SAAS,MAAM,mBAAmB,CAAC;AAQpD;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,oBAAoB,CAAC,GAC/C,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAE5B;AAMD;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,GAC1C,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAE5B;AAgBD;;;;;;;;;GASG;AACH,wBAAgB,IAAI,CAClB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAEhC,YAAY,EAAE;QACZ,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1C,mBAAmB,CAAC,EAAE,SAAS,CAAC,cAAc,GAAG,SAAS,CAAC;QAC3D,iBAAiB,CAAC,EAAE,SAAS,CAAC,cAAc,GAAG,SAAS,CAAC;QACzD,MAAM,EAAE,SAAS,CAAC,iBAAiB,CAAC;QACpC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;KAC/B;CACF,GACA,OAAO,CAAC,QAAQ,CAAC,CAEnB;AAaD;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,KAAK,EAAE,GAAG;IACV,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1C,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAaD;;;;;;;GAOG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAEhC,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1C,cAAc,CAAC,EAAE,SAAS,CAAC,cAAc,GAAG,SAAS,CAAC;QACtD,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,GAAG,GAAG,SAAS,CAAC,CAE1B;AAaD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAEhC,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1C,cAAc,CAAC,EAAE,SAAS,CAAC,cAAc,GAAG,SAAS,CAAC;QACtD,OAAO,CAAC,EAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,IAAI,CAAC,CAEf"}
@@ -0,0 +1,92 @@
1
+ /*
2
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ import { foundryPlatformFetch as $foundryPlatformFetch } from "@osdk/shared.net.platformapi";
17
+ //
18
+ const _create = [1, "/v1/datasets", 1];
19
+ /**
20
+ * Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset.
21
+ *
22
+ * @public
23
+ *
24
+ * Required Scopes: [api:datasets-write]
25
+ * URL: /v1/datasets
26
+ */
27
+ export function create($ctx, ...args) {
28
+ return $foundryPlatformFetch($ctx, _create, ...args);
29
+ }
30
+ const _get = [0, "/v1/datasets/{0}"];
31
+ /**
32
+ * Gets the Dataset with the given DatasetRid.
33
+ *
34
+ * @public
35
+ *
36
+ * Required Scopes: [api:datasets-read]
37
+ * URL: /v1/datasets/{datasetRid}
38
+ */
39
+ export function get($ctx, ...args) {
40
+ return $foundryPlatformFetch($ctx, _get, ...args);
41
+ }
42
+ const _read = [0, "/v1/datasets/{0}/readTable", 2,, "*/*"];
43
+ /**
44
+ * Gets the content of a dataset as a table in the specified format.
45
+ *
46
+ * This endpoint currently does not support views (virtual datasets composed of other datasets). For more information, refer to the [views documentation](https://www.palantir.com/docs/foundry/data-integration/views).
47
+ *
48
+ * @public
49
+ *
50
+ * Required Scopes: [api:datasets-read]
51
+ * URL: /v1/datasets/{datasetRid}/readTable
52
+ */
53
+ export function read($ctx, ...args) {
54
+ return $foundryPlatformFetch($ctx, _read, ...args);
55
+ }
56
+ const _replaceSchema = [2, "/v1/datasets/{0}/schema", 3];
57
+ /**
58
+ * Puts a Schema on an existing Dataset and Branch.
59
+ *
60
+ * @alpha
61
+ *
62
+ * Required Scopes: [api:datasets-write]
63
+ * URL: /v1/datasets/{datasetRid}/schema
64
+ */
65
+ export function replaceSchema($ctx, ...args) {
66
+ return $foundryPlatformFetch($ctx, _replaceSchema, ...args);
67
+ }
68
+ const _getSchema = [0, "/v1/datasets/{0}/schema", 2];
69
+ /**
70
+ * Retrieves the Schema for a Dataset and Branch, if it exists.
71
+ *
72
+ * @alpha
73
+ *
74
+ * Required Scopes: [api:datasets-read]
75
+ * URL: /v1/datasets/{datasetRid}/schema
76
+ */
77
+ export function getSchema($ctx, ...args) {
78
+ return $foundryPlatformFetch($ctx, _getSchema, ...args);
79
+ }
80
+ const _deleteSchema = [3, "/v1/datasets/{0}/schema", 2];
81
+ /**
82
+ * Deletes the Schema from a Dataset and Branch.
83
+ *
84
+ * @alpha
85
+ *
86
+ * Required Scopes: [api:datasets-write]
87
+ * URL: /v1/datasets/{datasetRid}/schema
88
+ */
89
+ export function deleteSchema($ctx, ...args) {
90
+ return $foundryPlatformFetch($ctx, _deleteSchema, ...args);
91
+ }
92
+ //# sourceMappingURL=Dataset.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Dataset.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_create","create","$ctx","args","_get","get","_read","read","_replaceSchema","replaceSchema","_getSchema","getSchema","_deleteSchema","deleteSchema"],"sources":["Dataset.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _create = [1, \"/v1/datasets\", 1];\n/**\n * Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset.\n *\n * @public\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v1/datasets\n */\nexport function create($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _create, ...args);\n}\nconst _get = [0, \"/v1/datasets/{0}\"];\n/**\n * Gets the Dataset with the given DatasetRid.\n *\n * @public\n *\n * Required Scopes: [api:datasets-read]\n * URL: /v1/datasets/{datasetRid}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _read = [0, \"/v1/datasets/{0}/readTable\", 2, , \"*/*\"];\n/**\n * Gets the content of a dataset as a table in the specified format.\n *\n * This endpoint currently does not support views (virtual datasets composed of other datasets). For more information, refer to the [views documentation](https://www.palantir.com/docs/foundry/data-integration/views).\n *\n * @public\n *\n * Required Scopes: [api:datasets-read]\n * URL: /v1/datasets/{datasetRid}/readTable\n */\nexport function read($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _read, ...args);\n}\nconst _replaceSchema = [2, \"/v1/datasets/{0}/schema\", 3];\n/**\n * Puts a Schema on an existing Dataset and Branch.\n *\n * @alpha\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v1/datasets/{datasetRid}/schema\n */\nexport function replaceSchema($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _replaceSchema, ...args);\n}\nconst _getSchema = [0, \"/v1/datasets/{0}/schema\", 2];\n/**\n * Retrieves the Schema for a Dataset and Branch, if it exists.\n *\n * @alpha\n *\n * Required Scopes: [api:datasets-read]\n * URL: /v1/datasets/{datasetRid}/schema\n */\nexport function getSchema($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _getSchema, ...args);\n}\nconst _deleteSchema = [3, \"/v1/datasets/{0}/schema\", 2];\n/**\n * Deletes the Schema from a Dataset and Branch.\n *\n * @alpha\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v1/datasets/{datasetRid}/schema\n */\nexport function deleteSchema($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _deleteSchema, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,OAAO,GAAG,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC;AACtC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,OAAO,EAAE,GAAGG,IAAI,CAAC;AACxD;AACA,MAAMC,IAAI,GAAG,CAAC,CAAC,EAAE,kBAAkB,CAAC;AACpC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,IAAI,EAAE,GAAGD,IAAI,CAAC;AACrD;AACA,MAAMG,KAAK,GAAG,CAAC,CAAC,EAAE,4BAA4B,EAAE,CAAC,GAAI,KAAK,CAAC;AAC3D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,IAAIA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EAChC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,KAAK,EAAE,GAAGH,IAAI,CAAC;AACtD;AACA,MAAMK,cAAc,GAAG,CAAC,CAAC,EAAE,yBAAyB,EAAE,CAAC,CAAC;AACxD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EACzC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,cAAc,EAAE,GAAGL,IAAI,CAAC;AAC/D;AACA,MAAMO,UAAU,GAAG,CAAC,CAAC,EAAE,yBAAyB,EAAE,CAAC,CAAC;AACpD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACT,IAAI,EAAE,GAAGC,IAAI,EAAE;EACrC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEQ,UAAU,EAAE,GAAGP,IAAI,CAAC;AAC3D;AACA,MAAMS,aAAa,GAAG,CAAC,CAAC,EAAE,yBAAyB,EAAE,CAAC,CAAC;AACvD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACX,IAAI,EAAE,GAAGC,IAAI,EAAE;EACxC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEU,aAAa,EAAE,GAAGT,IAAI,CAAC;AAC9D","ignoreList":[]}
@@ -0,0 +1,191 @@
1
+ import type * as _Core from "@osdk/internal.foundry.core/v1";
2
+ import type { SharedClient as $OldClient, SharedClientContext as $OldClientContext } from "@osdk/shared.client";
3
+ import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client2";
4
+ import type * as _Datasets from "../_components.js";
5
+ /**
6
+ * Lists Files contained in a Dataset. By default files are listed on the latest view of the default
7
+ * branch - `master` for most enrollments.
8
+ *
9
+ * This endpoint currently does not support views (virtual datasets composed of other datasets). For more information, refer to the [views documentation](https://www.palantir.com/docs/foundry/data-integration/views).
10
+ *
11
+ * #### Advanced Usage
12
+ *
13
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
14
+ *
15
+ * To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most
16
+ * recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the
17
+ * branch if there are no snapshot transactions.
18
+ *
19
+ * To **list files on the resolved view of a transaction** specify the Transaction's resource identifier
20
+ * as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot
21
+ * transaction, or the earliest ancestor transaction if there are no snapshot transactions.
22
+ *
23
+ * To **list files on the resolved view of a range of transactions** specify the the start transaction's resource
24
+ * identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This
25
+ * will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`.
26
+ * Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when
27
+ * the start and end transactions do not belong to the same root-to-leaf path.
28
+ *
29
+ * To **list files on a specific transaction** specify the Transaction's resource identifier as both the
30
+ * `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that
31
+ * Transaction.
32
+ *
33
+ * @public
34
+ *
35
+ * Required Scopes: [api:datasets-read]
36
+ * URL: /v1/datasets/{datasetRid}/files
37
+ */
38
+ export declare function list($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
39
+ datasetRid: _Datasets.DatasetRid,
40
+ $queryParams?: {
41
+ branchId?: _Datasets.BranchId | undefined;
42
+ startTransactionRid?: _Datasets.TransactionRid | undefined;
43
+ endTransactionRid?: _Datasets.TransactionRid | undefined;
44
+ pageSize?: _Core.PageSize | undefined;
45
+ pageToken?: _Core.PageToken | undefined;
46
+ }
47
+ ]): Promise<_Datasets.ListFilesResponse>;
48
+ /**
49
+ * Uploads a File to an existing Dataset.
50
+ * The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.
51
+ *
52
+ * By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments.
53
+ * If the file already exists only the most recent version will be visible in the updated view.
54
+ *
55
+ * #### Advanced Usage
56
+ *
57
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
58
+ *
59
+ * To **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will
60
+ * be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this
61
+ * default specify `transactionType` in addition to `branchId`.
62
+ * See [createBranch](https://www.palantir.com/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch.
63
+ *
64
+ * To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as
65
+ * `transactionRid`. This is useful for uploading multiple files in a single transaction.
66
+ * See [createTransaction](https://www.palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction.
67
+ *
68
+ * @public
69
+ *
70
+ * Required Scopes: [api:datasets-write]
71
+ * URL: /v1/datasets/{datasetRid}/files:upload
72
+ */
73
+ export declare function upload($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
74
+ datasetRid: _Datasets.DatasetRid,
75
+ $body: Blob,
76
+ $queryParams: {
77
+ filePath: _Core.FilePath;
78
+ branchId?: _Datasets.BranchId | undefined;
79
+ transactionType?: _Datasets.TransactionType | undefined;
80
+ transactionRid?: _Datasets.TransactionRid | undefined;
81
+ }
82
+ ]): Promise<_Datasets.File>;
83
+ /**
84
+ * Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest
85
+ * view of the default branch - `master` for most enrollments.
86
+ *
87
+ * #### Advanced Usage
88
+ *
89
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
90
+ *
91
+ * To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will
92
+ * retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest
93
+ * ancestor transaction of the branch if there are no snapshot transactions.
94
+ *
95
+ * To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier
96
+ * as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot
97
+ * transaction, or the earliest ancestor transaction if there are no snapshot transactions.
98
+ *
99
+ * To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's
100
+ * resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.
101
+ * This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the
102
+ * `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path.
103
+ *
104
+ * To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the
105
+ * `startTransactionRid` and `endTransactionRid`.
106
+ *
107
+ * @public
108
+ *
109
+ * Required Scopes: [api:datasets-read]
110
+ * URL: /v1/datasets/{datasetRid}/files/{filePath}
111
+ */
112
+ export declare function get($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
113
+ datasetRid: _Datasets.DatasetRid,
114
+ filePath: _Core.FilePath,
115
+ $queryParams?: {
116
+ branchId?: _Datasets.BranchId | undefined;
117
+ startTransactionRid?: _Datasets.TransactionRid | undefined;
118
+ endTransactionRid?: _Datasets.TransactionRid | undefined;
119
+ }
120
+ ]): Promise<_Datasets.File>;
121
+ /**
122
+ * Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default
123
+ * branch - `master` for most enrollments. The file will still be visible on historical views.
124
+ *
125
+ * #### Advanced Usage
126
+ *
127
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
128
+ *
129
+ * To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction
130
+ * will be created and committed on this branch.
131
+ *
132
+ * To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier
133
+ * as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a
134
+ * single transaction. See [createTransaction](https://www.palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to
135
+ * open a transaction.
136
+ *
137
+ * @public
138
+ *
139
+ * Required Scopes: [api:datasets-write]
140
+ * URL: /v1/datasets/{datasetRid}/files/{filePath}
141
+ */
142
+ export declare function deleteFile($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
143
+ datasetRid: _Datasets.DatasetRid,
144
+ filePath: _Core.FilePath,
145
+ $queryParams?: {
146
+ branchId?: _Datasets.BranchId | undefined;
147
+ transactionRid?: _Datasets.TransactionRid | undefined;
148
+ }
149
+ ]): Promise<void>;
150
+ /**
151
+ * Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest
152
+ * view of the default branch - `master` for most enrollments.
153
+ *
154
+ * This endpoint currently does not support views (virtual datasets composed of other datasets). For more information, refer to the [views documentation](https://www.palantir.com/docs/foundry/data-integration/views).
155
+ *
156
+ * #### Advanced Usage
157
+ *
158
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
159
+ *
160
+ * To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will
161
+ * retrieve the content for the most recent version of the file since the latest snapshot transaction, or the
162
+ * earliest ancestor transaction of the branch if there are no snapshot transactions.
163
+ *
164
+ * To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier
165
+ * as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest
166
+ * snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions.
167
+ *
168
+ * To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's
169
+ * resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.
170
+ * This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the
171
+ * `endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior
172
+ * is undefined when the start and end transactions do not belong to the same root-to-leaf path.
173
+ *
174
+ * To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the
175
+ * `startTransactionRid` and `endTransactionRid`.
176
+ *
177
+ * @public
178
+ *
179
+ * Required Scopes: [api:datasets-read]
180
+ * URL: /v1/datasets/{datasetRid}/files/{filePath}/content
181
+ */
182
+ export declare function read($ctx: $Client | $ClientContext | $OldClient | $OldClientContext, ...args: [
183
+ datasetRid: _Datasets.DatasetRid,
184
+ filePath: _Core.FilePath,
185
+ $queryParams?: {
186
+ branchId?: _Datasets.BranchId | undefined;
187
+ startTransactionRid?: _Datasets.TransactionRid | undefined;
188
+ endTransactionRid?: _Datasets.TransactionRid | undefined;
189
+ }
190
+ ]): Promise<Response>;
191
+ //# sourceMappingURL=File.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"File.d.ts","sourceRoot":"","sources":["../../../../src/v1/public/File.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,EACV,YAAY,IAAI,UAAU,EAC1B,mBAAmB,IAAI,iBAAiB,EACzC,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,sBAAsB,CAAC;AAG9B,OAAO,KAAK,KAAK,SAAS,MAAM,mBAAmB,CAAC;AAiBpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,IAAI,CAClB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAEhC,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1C,mBAAmB,CAAC,EAAE,SAAS,CAAC,cAAc,GAAG,SAAS,CAAC;QAC3D,iBAAiB,CAAC,EAAE,SAAS,CAAC,cAAc,GAAG,SAAS,CAAC;QACzD,QAAQ,CAAC,EAAE,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC;QACtC,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;KACzC;CACF,GACA,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAEtC;AAeD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,KAAK,EAAE,IAAI;IACX,YAAY,EAAE;QACZ,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC;QACzB,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1C,eAAe,CAAC,EAAE,SAAS,CAAC,eAAe,GAAG,SAAS,CAAC;QACxD,cAAc,CAAC,EAAE,SAAS,CAAC,cAAc,GAAG,SAAS,CAAC;KACvD;CACF,GACA,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAEzB;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,QAAQ,EAAE,KAAK,CAAC,QAAQ;IAExB,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1C,mBAAmB,CAAC,EAAE,SAAS,CAAC,cAAc,GAAG,SAAS,CAAC;QAC3D,iBAAiB,CAAC,EAAE,SAAS,CAAC,cAAc,GAAG,SAAS,CAAC;KAC1D;CACF,GACA,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAEzB;AAaD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,QAAQ,EAAE,KAAK,CAAC,QAAQ;IAExB,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1C,cAAc,CAAC,EAAE,SAAS,CAAC,cAAc,GAAG,SAAS,CAAC;KACvD;CACF,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAcD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,IAAI,CAClB,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,UAAU,GAAG,iBAAiB,EAC/D,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,QAAQ,EAAE,KAAK,CAAC,QAAQ;IAExB,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC1C,mBAAmB,CAAC,EAAE,SAAS,CAAC,cAAc,GAAG,SAAS,CAAC;QAC3D,iBAAiB,CAAC,EAAE,SAAS,CAAC,cAAc,GAAG,SAAS,CAAC;KAC1D;CACF,GACA,OAAO,CAAC,QAAQ,CAAC,CAEnB"}
@@ -0,0 +1,178 @@
1
+ /*
2
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ import { foundryPlatformFetch as $foundryPlatformFetch } from "@osdk/shared.net.platformapi";
17
+ //
18
+ const _list = [0, "/v1/datasets/{0}/files", 2];
19
+ /**
20
+ * Lists Files contained in a Dataset. By default files are listed on the latest view of the default
21
+ * branch - `master` for most enrollments.
22
+ *
23
+ * This endpoint currently does not support views (virtual datasets composed of other datasets). For more information, refer to the [views documentation](https://www.palantir.com/docs/foundry/data-integration/views).
24
+ *
25
+ * #### Advanced Usage
26
+ *
27
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
28
+ *
29
+ * To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most
30
+ * recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the
31
+ * branch if there are no snapshot transactions.
32
+ *
33
+ * To **list files on the resolved view of a transaction** specify the Transaction's resource identifier
34
+ * as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot
35
+ * transaction, or the earliest ancestor transaction if there are no snapshot transactions.
36
+ *
37
+ * To **list files on the resolved view of a range of transactions** specify the the start transaction's resource
38
+ * identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This
39
+ * will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`.
40
+ * Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when
41
+ * the start and end transactions do not belong to the same root-to-leaf path.
42
+ *
43
+ * To **list files on a specific transaction** specify the Transaction's resource identifier as both the
44
+ * `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that
45
+ * Transaction.
46
+ *
47
+ * @public
48
+ *
49
+ * Required Scopes: [api:datasets-read]
50
+ * URL: /v1/datasets/{datasetRid}/files
51
+ */
52
+ export function list($ctx, ...args) {
53
+ return $foundryPlatformFetch($ctx, _list, ...args);
54
+ }
55
+ const _upload = [1, "/v1/datasets/{0}/files:upload", 3, "*/*"];
56
+ /**
57
+ * Uploads a File to an existing Dataset.
58
+ * The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.
59
+ *
60
+ * By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments.
61
+ * If the file already exists only the most recent version will be visible in the updated view.
62
+ *
63
+ * #### Advanced Usage
64
+ *
65
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
66
+ *
67
+ * To **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will
68
+ * be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this
69
+ * default specify `transactionType` in addition to `branchId`.
70
+ * See [createBranch](https://www.palantir.com/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch.
71
+ *
72
+ * To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as
73
+ * `transactionRid`. This is useful for uploading multiple files in a single transaction.
74
+ * See [createTransaction](https://www.palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction.
75
+ *
76
+ * @public
77
+ *
78
+ * Required Scopes: [api:datasets-write]
79
+ * URL: /v1/datasets/{datasetRid}/files:upload
80
+ */
81
+ export function upload($ctx, ...args) {
82
+ return $foundryPlatformFetch($ctx, _upload, ...args);
83
+ }
84
+ const _get = [0, "/v1/datasets/{0}/files/{1}", 2];
85
+ /**
86
+ * Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest
87
+ * view of the default branch - `master` for most enrollments.
88
+ *
89
+ * #### Advanced Usage
90
+ *
91
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
92
+ *
93
+ * To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will
94
+ * retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest
95
+ * ancestor transaction of the branch if there are no snapshot transactions.
96
+ *
97
+ * To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier
98
+ * as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot
99
+ * transaction, or the earliest ancestor transaction if there are no snapshot transactions.
100
+ *
101
+ * To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's
102
+ * resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.
103
+ * This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the
104
+ * `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path.
105
+ *
106
+ * To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the
107
+ * `startTransactionRid` and `endTransactionRid`.
108
+ *
109
+ * @public
110
+ *
111
+ * Required Scopes: [api:datasets-read]
112
+ * URL: /v1/datasets/{datasetRid}/files/{filePath}
113
+ */
114
+ export function get($ctx, ...args) {
115
+ return $foundryPlatformFetch($ctx, _get, ...args);
116
+ }
117
+ const _deleteFile = [3, "/v1/datasets/{0}/files/{1}", 2];
118
+ /**
119
+ * Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default
120
+ * branch - `master` for most enrollments. The file will still be visible on historical views.
121
+ *
122
+ * #### Advanced Usage
123
+ *
124
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
125
+ *
126
+ * To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction
127
+ * will be created and committed on this branch.
128
+ *
129
+ * To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier
130
+ * as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a
131
+ * single transaction. See [createTransaction](https://www.palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to
132
+ * open a transaction.
133
+ *
134
+ * @public
135
+ *
136
+ * Required Scopes: [api:datasets-write]
137
+ * URL: /v1/datasets/{datasetRid}/files/{filePath}
138
+ */
139
+ export function deleteFile($ctx, ...args) {
140
+ return $foundryPlatformFetch($ctx, _deleteFile, ...args);
141
+ }
142
+ const _read = [0, "/v1/datasets/{0}/files/{1}/content", 2,, "*/*"];
143
+ /**
144
+ * Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest
145
+ * view of the default branch - `master` for most enrollments.
146
+ *
147
+ * This endpoint currently does not support views (virtual datasets composed of other datasets). For more information, refer to the [views documentation](https://www.palantir.com/docs/foundry/data-integration/views).
148
+ *
149
+ * #### Advanced Usage
150
+ *
151
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
152
+ *
153
+ * To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will
154
+ * retrieve the content for the most recent version of the file since the latest snapshot transaction, or the
155
+ * earliest ancestor transaction of the branch if there are no snapshot transactions.
156
+ *
157
+ * To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier
158
+ * as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest
159
+ * snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions.
160
+ *
161
+ * To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's
162
+ * resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.
163
+ * This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the
164
+ * `endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior
165
+ * is undefined when the start and end transactions do not belong to the same root-to-leaf path.
166
+ *
167
+ * To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the
168
+ * `startTransactionRid` and `endTransactionRid`.
169
+ *
170
+ * @public
171
+ *
172
+ * Required Scopes: [api:datasets-read]
173
+ * URL: /v1/datasets/{datasetRid}/files/{filePath}/content
174
+ */
175
+ export function read($ctx, ...args) {
176
+ return $foundryPlatformFetch($ctx, _read, ...args);
177
+ }
178
+ //# sourceMappingURL=File.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"File.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_list","list","$ctx","args","_upload","upload","_get","get","_deleteFile","deleteFile","_read","read"],"sources":["File.js"],"sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\nconst _list = [0, \"/v1/datasets/{0}/files\", 2];\n/**\n * Lists Files contained in a Dataset. By default files are listed on the latest view of the default\n * branch - `master` for most enrollments.\n *\n * This endpoint currently does not support views (virtual datasets composed of other datasets). For more information, refer to the [views documentation](https://www.palantir.com/docs/foundry/data-integration/views).\n *\n * #### Advanced Usage\n *\n * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n *\n * To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most\n * recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the\n * branch if there are no snapshot transactions.\n *\n * To **list files on the resolved view of a transaction** specify the Transaction's resource identifier\n * as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot\n * transaction, or the earliest ancestor transaction if there are no snapshot transactions.\n *\n * To **list files on the resolved view of a range of transactions** specify the the start transaction's resource\n * identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This\n * will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`.\n * Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when\n * the start and end transactions do not belong to the same root-to-leaf path.\n *\n * To **list files on a specific transaction** specify the Transaction's resource identifier as both the\n * `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that\n * Transaction.\n *\n * @public\n *\n * Required Scopes: [api:datasets-read]\n * URL: /v1/datasets/{datasetRid}/files\n */\nexport function list($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _list, ...args);\n}\nconst _upload = [1, \"/v1/datasets/{0}/files:upload\", 3, \"*/*\"];\n/**\n * Uploads a File to an existing Dataset.\n * The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\n *\n * By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments.\n * If the file already exists only the most recent version will be visible in the updated view.\n *\n * #### Advanced Usage\n *\n * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n *\n * To **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will\n * be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this\n * default specify `transactionType` in addition to `branchId`.\n * See [createBranch](https://www.palantir.com/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch.\n *\n * To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as\n * `transactionRid`. This is useful for uploading multiple files in a single transaction.\n * See [createTransaction](https://www.palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction.\n *\n * @public\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v1/datasets/{datasetRid}/files:upload\n */\nexport function upload($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _upload, ...args);\n}\nconst _get = [0, \"/v1/datasets/{0}/files/{1}\", 2];\n/**\n * Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest\n * view of the default branch - `master` for most enrollments.\n *\n * #### Advanced Usage\n *\n * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n *\n * To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will\n * retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest\n * ancestor transaction of the branch if there are no snapshot transactions.\n *\n * To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier\n * as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot\n * transaction, or the earliest ancestor transaction if there are no snapshot transactions.\n *\n * To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's\n * resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.\n * This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the\n * `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path.\n *\n * To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the\n * `startTransactionRid` and `endTransactionRid`.\n *\n * @public\n *\n * Required Scopes: [api:datasets-read]\n * URL: /v1/datasets/{datasetRid}/files/{filePath}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _deleteFile = [3, \"/v1/datasets/{0}/files/{1}\", 2];\n/**\n * Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default\n * branch - `master` for most enrollments. The file will still be visible on historical views.\n *\n * #### Advanced Usage\n *\n * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n *\n * To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction\n * will be created and committed on this branch.\n *\n * To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier\n * as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a\n * single transaction. See [createTransaction](https://www.palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to\n * open a transaction.\n *\n * @public\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v1/datasets/{datasetRid}/files/{filePath}\n */\nexport function deleteFile($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _deleteFile, ...args);\n}\nconst _read = [0, \"/v1/datasets/{0}/files/{1}/content\", 2, , \"*/*\"];\n/**\n * Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest\n * view of the default branch - `master` for most enrollments.\n *\n * This endpoint currently does not support views (virtual datasets composed of other datasets). For more information, refer to the [views documentation](https://www.palantir.com/docs/foundry/data-integration/views).\n *\n * #### Advanced Usage\n *\n * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n *\n * To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will\n * retrieve the content for the most recent version of the file since the latest snapshot transaction, or the\n * earliest ancestor transaction of the branch if there are no snapshot transactions.\n *\n * To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier\n * as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest\n * snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions.\n *\n * To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's\n * resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.\n * This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the\n * `endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior\n * is undefined when the start and end transactions do not belong to the same root-to-leaf path.\n *\n * To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the\n * `startTransactionRid` and `endTransactionRid`.\n *\n * @public\n *\n * Required Scopes: [api:datasets-read]\n * URL: /v1/datasets/{datasetRid}/files/{filePath}/content\n */\nexport function read($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _read, ...args);\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,oBAAoB,IAAIC,qBAAqB,QAAQ,8BAA8B;AAC5F;AACA,MAAMC,KAAK,GAAG,CAAC,CAAC,EAAE,wBAAwB,EAAE,CAAC,CAAC;AAC9C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,IAAIA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EAChC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,KAAK,EAAE,GAAGG,IAAI,CAAC;AACtD;AACA,MAAMC,OAAO,GAAG,CAAC,CAAC,EAAE,+BAA+B,EAAE,CAAC,EAAE,KAAK,CAAC;AAC9D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,MAAMA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EAClC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,OAAO,EAAE,GAAGD,IAAI,CAAC;AACxD;AACA,MAAMG,IAAI,GAAG,CAAC,CAAC,EAAE,4BAA4B,EAAE,CAAC,CAAC;AACjD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,GAAGA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EAC/B,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,IAAI,EAAE,GAAGH,IAAI,CAAC;AACrD;AACA,MAAMK,WAAW,GAAG,CAAC,CAAC,EAAE,4BAA4B,EAAE,CAAC,CAAC;AACxD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,UAAUA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EACtC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,WAAW,EAAE,GAAGL,IAAI,CAAC;AAC5D;AACA,MAAMO,KAAK,GAAG,CAAC,CAAC,EAAE,oCAAoC,EAAE,CAAC,GAAI,KAAK,CAAC;AACnE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,IAAIA,CAACT,IAAI,EAAE,GAAGC,IAAI,EAAE;EAChC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEQ,KAAK,EAAE,GAAGP,IAAI,CAAC;AACtD","ignoreList":[]}