@osdk/internal.foundry.datasets 0.2.0-beta.8 → 0.2.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.
- package/CHANGELOG.md +60 -0
- package/build/browser/_components.d.ts +125 -0
- package/build/browser/_components.d.ts.map +1 -0
- package/build/browser/_components.js +17 -0
- package/build/browser/_components.js.map +1 -0
- package/build/browser/_errors.d.ts +359 -0
- package/build/browser/_errors.d.ts.map +1 -0
- package/build/browser/_errors.js +17 -0
- package/build/browser/_errors.js.map +1 -0
- package/build/browser/index.d.ts +7 -0
- package/build/browser/index.d.ts.map +1 -0
- package/build/browser/index.js +19 -6
- package/build/browser/index.js.map +1 -1
- package/build/browser/public/Branch.d.ts +57 -0
- package/build/browser/public/Branch.d.ts.map +1 -0
- package/build/browser/public/Branch.js +73 -3
- package/build/browser/public/Branch.js.map +1 -1
- package/build/browser/public/Dataset.d.ts +97 -0
- package/build/browser/public/Dataset.d.ts.map +1 -0
- package/build/browser/public/Dataset.js +97 -3
- package/build/browser/public/Dataset.js.map +1 -1
- package/build/browser/public/File.d.ts +196 -0
- package/build/browser/public/File.d.ts.map +1 -0
- package/build/browser/public/File.js +183 -3
- package/build/browser/public/File.js.map +1 -1
- package/build/browser/public/Transaction.d.ts +64 -0
- package/build/browser/public/Transaction.d.ts.map +1 -0
- package/build/browser/public/Transaction.js +75 -3
- package/build/browser/public/Transaction.js.map +1 -1
- package/build/esm/_components.d.ts +6 -6
- package/build/esm/_components.d.ts.map +1 -1
- package/build/esm/_components.js +17 -0
- package/build/esm/_components.js.map +1 -0
- package/build/esm/_errors.js +17 -0
- package/build/esm/_errors.js.map +1 -0
- package/build/esm/index.js +19 -6
- package/build/esm/index.js.map +1 -1
- package/build/esm/public/Branch.d.ts +13 -10
- package/build/esm/public/Branch.d.ts.map +1 -1
- package/build/esm/public/Branch.js +73 -3
- package/build/esm/public/Branch.js.map +1 -1
- package/build/esm/public/Dataset.d.ts +22 -22
- package/build/esm/public/Dataset.d.ts.map +1 -1
- package/build/esm/public/Dataset.js +97 -3
- package/build/esm/public/Dataset.js.map +1 -1
- package/build/esm/public/File.d.ts +34 -34
- package/build/esm/public/File.d.ts.map +1 -1
- package/build/esm/public/File.js +183 -3
- package/build/esm/public/File.js.map +1 -1
- package/build/esm/public/Transaction.d.ts +18 -9
- package/build/esm/public/Transaction.d.ts.map +1 -1
- package/build/esm/public/Transaction.js +75 -3
- package/build/esm/public/Transaction.js.map +1 -1
- package/package.json +8 -9
- package/build/browser/chunk-6JHAYAPR.js +0 -31
- package/build/browser/chunk-6JHAYAPR.js.map +0 -1
- package/build/browser/chunk-EDFN5GXZ.js +0 -41
- package/build/browser/chunk-EDFN5GXZ.js.map +0 -1
- package/build/browser/chunk-JIXOPP3M.js +0 -31
- package/build/browser/chunk-JIXOPP3M.js.map +0 -1
- package/build/browser/chunk-PZ5AY32C.js +0 -9
- package/build/browser/chunk-PZ5AY32C.js.map +0 -1
- package/build/browser/chunk-WOQTHZR3.js +0 -36
- package/build/browser/chunk-WOQTHZR3.js.map +0 -1
- package/build/esm/chunk-6JHAYAPR.js +0 -31
- package/build/esm/chunk-6JHAYAPR.js.map +0 -1
- package/build/esm/chunk-EDFN5GXZ.js +0 -41
- package/build/esm/chunk-EDFN5GXZ.js.map +0 -1
- package/build/esm/chunk-JIXOPP3M.js +0 -31
- package/build/esm/chunk-JIXOPP3M.js.map +0 -1
- package/build/esm/chunk-PZ5AY32C.js +0 -9
- package/build/esm/chunk-PZ5AY32C.js.map +0 -1
- package/build/esm/chunk-WOQTHZR3.js +0 -36
- package/build/esm/chunk-WOQTHZR3.js.map +0 -1
|
@@ -1,4 +1,74 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
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/{0}/branches", 1];
|
|
19
|
+
/**
|
|
20
|
+
* Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction.
|
|
21
|
+
*
|
|
22
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
|
|
23
|
+
*
|
|
24
|
+
* @public
|
|
25
|
+
*
|
|
26
|
+
* Required Scopes: [api:datasets-write]
|
|
27
|
+
* URL: /v1/datasets/{datasetRid}/branches
|
|
28
|
+
*/
|
|
29
|
+
export function create($ctx, ...args) {
|
|
30
|
+
return $foundryPlatformFetch($ctx, _create, ...args);
|
|
31
|
+
}
|
|
32
|
+
const _get = [0, "/v1/datasets/{0}/branches/{1}"];
|
|
33
|
+
/**
|
|
34
|
+
* Get a Branch of a Dataset.
|
|
35
|
+
*
|
|
36
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
|
|
37
|
+
*
|
|
38
|
+
* @public
|
|
39
|
+
*
|
|
40
|
+
* Required Scopes: [api:datasets-read]
|
|
41
|
+
* URL: /v1/datasets/{datasetRid}/branches/{branchId}
|
|
42
|
+
*/
|
|
43
|
+
export function get($ctx, ...args) {
|
|
44
|
+
return $foundryPlatformFetch($ctx, _get, ...args);
|
|
45
|
+
}
|
|
46
|
+
const _deleteBranch = [3, "/v1/datasets/{0}/branches/{1}"];
|
|
47
|
+
/**
|
|
48
|
+
* Deletes the Branch with the given BranchId.
|
|
49
|
+
*
|
|
50
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
|
|
51
|
+
*
|
|
52
|
+
* @public
|
|
53
|
+
*
|
|
54
|
+
* Required Scopes: [api:datasets-write]
|
|
55
|
+
* URL: /v1/datasets/{datasetRid}/branches/{branchId}
|
|
56
|
+
*/
|
|
57
|
+
export function deleteBranch($ctx, ...args) {
|
|
58
|
+
return $foundryPlatformFetch($ctx, _deleteBranch, ...args);
|
|
59
|
+
}
|
|
60
|
+
const _list = [0, "/v1/datasets/{0}/branches", 2];
|
|
61
|
+
/**
|
|
62
|
+
* Lists the Branches of a Dataset.
|
|
63
|
+
*
|
|
64
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
|
|
65
|
+
*
|
|
66
|
+
* @public
|
|
67
|
+
*
|
|
68
|
+
* Required Scopes: [api:datasets-read]
|
|
69
|
+
* URL: /v1/datasets/{datasetRid}/branches
|
|
70
|
+
*/
|
|
71
|
+
export function list($ctx, ...args) {
|
|
72
|
+
return $foundryPlatformFetch($ctx, _list, ...args);
|
|
73
|
+
}
|
|
4
74
|
//# sourceMappingURL=Branch.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"
|
|
1
|
+
{"version":3,"file":"Branch.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_create","create","$ctx","args","_get","get","_deleteBranch","deleteBranch","_list","list"],"sources":["Branch.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/{0}/branches\", 1];\n/**\n * Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.\n *\n * @public\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v1/datasets/{datasetRid}/branches\n */\nexport function create($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _create, ...args);\n}\nconst _get = [0, \"/v1/datasets/{0}/branches/{1}\"];\n/**\n * Get a Branch of a Dataset.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n *\n * @public\n *\n * Required Scopes: [api:datasets-read]\n * URL: /v1/datasets/{datasetRid}/branches/{branchId}\n */\nexport function get($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _get, ...args);\n}\nconst _deleteBranch = [3, \"/v1/datasets/{0}/branches/{1}\"];\n/**\n * Deletes the Branch with the given BranchId.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.\n *\n * @public\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v1/datasets/{datasetRid}/branches/{branchId}\n */\nexport function deleteBranch($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _deleteBranch, ...args);\n}\nconst _list = [0, \"/v1/datasets/{0}/branches\", 2];\n/**\n * Lists the Branches of a Dataset.\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n *\n * @public\n *\n * Required Scopes: [api:datasets-read]\n * URL: /v1/datasets/{datasetRid}/branches\n */\nexport function list($ctx, ...args) {\n return $foundryPlatformFetch($ctx, _list, ...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,2BAA2B,EAAE,CAAC,CAAC;AACnD;AACA;AACA;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,+BAA+B,CAAC;AACjD;AACA;AACA;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,aAAa,GAAG,CAAC,CAAC,EAAE,+BAA+B,CAAC;AAC1D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EACxC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,aAAa,EAAE,GAAGH,IAAI,CAAC;AAC9D;AACA,MAAMK,KAAK,GAAG,CAAC,CAAC,EAAE,2BAA2B,EAAE,CAAC,CAAC;AACjD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,IAAIA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EAChC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,KAAK,EAAE,GAAGL,IAAI,CAAC;AACtD","ignoreList":[]}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import type * as _Core from "@osdk/internal.foundry.core";
|
|
2
2
|
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client";
|
|
3
|
-
import type
|
|
3
|
+
import type * as _Datasets from "../_components.js";
|
|
4
4
|
/**
|
|
5
5
|
* Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset.
|
|
6
6
|
*
|
|
@@ -11,7 +11,7 @@ import type { BranchId, CreateDatasetRequest, Dataset, DatasetRid, TableExportFo
|
|
|
11
11
|
* Required Scopes: [api:datasets-write]
|
|
12
12
|
* URL: /v1/datasets
|
|
13
13
|
*/
|
|
14
|
-
export declare function
|
|
14
|
+
export declare function create($ctx: $Client | $ClientContext, ...args: [$body: _Datasets.CreateDatasetRequest]): Promise<_Datasets.Dataset>;
|
|
15
15
|
/**
|
|
16
16
|
* Gets the Dataset with the given DatasetRid.
|
|
17
17
|
*
|
|
@@ -22,7 +22,7 @@ export declare function createDataset($ctx: $Client | $ClientContext, ...args: [
|
|
|
22
22
|
* Required Scopes: [api:datasets-read]
|
|
23
23
|
* URL: /v1/datasets/{datasetRid}
|
|
24
24
|
*/
|
|
25
|
-
export declare function
|
|
25
|
+
export declare function get($ctx: $Client | $ClientContext, ...args: [datasetRid: _Datasets.DatasetRid]): Promise<_Datasets.Dataset>;
|
|
26
26
|
/**
|
|
27
27
|
* Gets the content of a dataset as a table in the specified format.
|
|
28
28
|
*
|
|
@@ -35,13 +35,13 @@ export declare function getDataset($ctx: $Client | $ClientContext, ...args: [dat
|
|
|
35
35
|
* Required Scopes: [api:datasets-read]
|
|
36
36
|
* URL: /v1/datasets/{datasetRid}/readTable
|
|
37
37
|
*/
|
|
38
|
-
export declare function
|
|
39
|
-
datasetRid: DatasetRid,
|
|
38
|
+
export declare function read($ctx: $Client | $ClientContext, ...args: [
|
|
39
|
+
datasetRid: _Datasets.DatasetRid,
|
|
40
40
|
$queryParams: {
|
|
41
|
-
branchId?: BranchId | undefined;
|
|
42
|
-
startTransactionRid?: TransactionRid | undefined;
|
|
43
|
-
endTransactionRid?: TransactionRid | undefined;
|
|
44
|
-
format: TableExportFormat;
|
|
41
|
+
branchId?: _Datasets.BranchId | undefined;
|
|
42
|
+
startTransactionRid?: _Datasets.TransactionRid | undefined;
|
|
43
|
+
endTransactionRid?: _Datasets.TransactionRid | undefined;
|
|
44
|
+
format: _Datasets.TableExportFormat;
|
|
45
45
|
columns: Array<string>;
|
|
46
46
|
rowLimit?: number | undefined;
|
|
47
47
|
}
|
|
@@ -54,12 +54,12 @@ export declare function readTable($ctx: $Client | $ClientContext, ...args: [
|
|
|
54
54
|
* Required Scopes: [api:datasets-write]
|
|
55
55
|
* URL: /v1/datasets/{datasetRid}/schema
|
|
56
56
|
*/
|
|
57
|
-
export declare function
|
|
58
|
-
datasetRid: DatasetRid,
|
|
57
|
+
export declare function replaceSchema($ctx: $Client | $ClientContext, ...args: [
|
|
58
|
+
datasetRid: _Datasets.DatasetRid,
|
|
59
59
|
$body: any,
|
|
60
60
|
$queryParams?: {
|
|
61
|
-
branchId?: BranchId | undefined;
|
|
62
|
-
preview?: PreviewMode | undefined;
|
|
61
|
+
branchId?: _Datasets.BranchId | undefined;
|
|
62
|
+
preview?: _Core.PreviewMode | undefined;
|
|
63
63
|
}
|
|
64
64
|
]): Promise<void>;
|
|
65
65
|
/**
|
|
@@ -71,11 +71,11 @@ export declare function putSchema($ctx: $Client | $ClientContext, ...args: [
|
|
|
71
71
|
* URL: /v1/datasets/{datasetRid}/schema
|
|
72
72
|
*/
|
|
73
73
|
export declare function getSchema($ctx: $Client | $ClientContext, ...args: [
|
|
74
|
-
datasetRid: DatasetRid,
|
|
74
|
+
datasetRid: _Datasets.DatasetRid,
|
|
75
75
|
$queryParams?: {
|
|
76
|
-
branchId?: BranchId | undefined;
|
|
77
|
-
transactionRid?: TransactionRid | undefined;
|
|
78
|
-
preview?: PreviewMode | undefined;
|
|
76
|
+
branchId?: _Datasets.BranchId | undefined;
|
|
77
|
+
transactionRid?: _Datasets.TransactionRid | undefined;
|
|
78
|
+
preview?: _Core.PreviewMode | undefined;
|
|
79
79
|
}
|
|
80
80
|
]): Promise<any | undefined>;
|
|
81
81
|
/**
|
|
@@ -87,11 +87,11 @@ export declare function getSchema($ctx: $Client | $ClientContext, ...args: [
|
|
|
87
87
|
* URL: /v1/datasets/{datasetRid}/schema
|
|
88
88
|
*/
|
|
89
89
|
export declare function deleteSchema($ctx: $Client | $ClientContext, ...args: [
|
|
90
|
-
datasetRid: DatasetRid,
|
|
90
|
+
datasetRid: _Datasets.DatasetRid,
|
|
91
91
|
$queryParams?: {
|
|
92
|
-
branchId?: BranchId | undefined;
|
|
93
|
-
transactionRid?: TransactionRid | undefined;
|
|
94
|
-
preview?: PreviewMode | undefined;
|
|
92
|
+
branchId?: _Datasets.BranchId | undefined;
|
|
93
|
+
transactionRid?: _Datasets.TransactionRid | undefined;
|
|
94
|
+
preview?: _Core.PreviewMode | undefined;
|
|
95
95
|
}
|
|
96
96
|
]): Promise<void>;
|
|
97
97
|
//# sourceMappingURL=Dataset.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Dataset.d.ts","sourceRoot":"","sources":["../../../src/public/Dataset.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"Dataset.d.ts","sourceRoot":"","sources":["../../../src/public/Dataset.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,6BAA6B,CAAC;AAC1D,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,qBAAqB,CAAC;AAG7B,OAAO,KAAK,KAAK,SAAS,MAAM,mBAAmB,CAAC;AAQpD;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,oBAAoB,CAAC,GAC/C,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAE5B;AAMD;;;;;;;;;GASG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,GAC1C,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAE5B;AAgBD;;;;;;;;;;;GAWG;AACH,wBAAgB,IAAI,CAClB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,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,IAAI,CAAC,CAEf;AAaD;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,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,EAC9B,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,EAC9B,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"}
|
|
@@ -1,4 +1,98 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
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
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
|
|
23
|
+
*
|
|
24
|
+
* @public
|
|
25
|
+
*
|
|
26
|
+
* Required Scopes: [api:datasets-write]
|
|
27
|
+
* URL: /v1/datasets
|
|
28
|
+
*/
|
|
29
|
+
export function create($ctx, ...args) {
|
|
30
|
+
return $foundryPlatformFetch($ctx, _create, ...args);
|
|
31
|
+
}
|
|
32
|
+
const _get = [0, "/v1/datasets/{0}"];
|
|
33
|
+
/**
|
|
34
|
+
* Gets the Dataset with the given DatasetRid.
|
|
35
|
+
*
|
|
36
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
|
|
37
|
+
*
|
|
38
|
+
* @public
|
|
39
|
+
*
|
|
40
|
+
* Required Scopes: [api:datasets-read]
|
|
41
|
+
* URL: /v1/datasets/{datasetRid}
|
|
42
|
+
*/
|
|
43
|
+
export function get($ctx, ...args) {
|
|
44
|
+
return $foundryPlatformFetch($ctx, _get, ...args);
|
|
45
|
+
}
|
|
46
|
+
const _read = [0, "/v1/datasets/{0}/readTable", 2,, "*/*"];
|
|
47
|
+
/**
|
|
48
|
+
* Gets the content of a dataset as a table in the specified format.
|
|
49
|
+
*
|
|
50
|
+
* This endpoint currently does not support views (Virtual datasets composed of other datasets).
|
|
51
|
+
*
|
|
52
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
|
|
53
|
+
*
|
|
54
|
+
* @public
|
|
55
|
+
*
|
|
56
|
+
* Required Scopes: [api:datasets-read]
|
|
57
|
+
* URL: /v1/datasets/{datasetRid}/readTable
|
|
58
|
+
*/
|
|
59
|
+
export function read($ctx, ...args) {
|
|
60
|
+
return $foundryPlatformFetch($ctx, _read, ...args);
|
|
61
|
+
}
|
|
62
|
+
const _replaceSchema = [2, "/v1/datasets/{0}/schema", 3];
|
|
63
|
+
/**
|
|
64
|
+
* Puts a Schema on an existing Dataset and Branch.
|
|
65
|
+
*
|
|
66
|
+
* @alpha
|
|
67
|
+
*
|
|
68
|
+
* Required Scopes: [api:datasets-write]
|
|
69
|
+
* URL: /v1/datasets/{datasetRid}/schema
|
|
70
|
+
*/
|
|
71
|
+
export function replaceSchema($ctx, ...args) {
|
|
72
|
+
return $foundryPlatformFetch($ctx, _replaceSchema, ...args);
|
|
73
|
+
}
|
|
74
|
+
const _getSchema = [0, "/v1/datasets/{0}/schema", 2];
|
|
75
|
+
/**
|
|
76
|
+
* Retrieves the Schema for a Dataset and Branch, if it exists.
|
|
77
|
+
*
|
|
78
|
+
* @alpha
|
|
79
|
+
*
|
|
80
|
+
* Required Scopes: [api:datasets-read]
|
|
81
|
+
* URL: /v1/datasets/{datasetRid}/schema
|
|
82
|
+
*/
|
|
83
|
+
export function getSchema($ctx, ...args) {
|
|
84
|
+
return $foundryPlatformFetch($ctx, _getSchema, ...args);
|
|
85
|
+
}
|
|
86
|
+
const _deleteSchema = [3, "/v1/datasets/{0}/schema", 2];
|
|
87
|
+
/**
|
|
88
|
+
* Deletes the Schema from a Dataset and Branch.
|
|
89
|
+
*
|
|
90
|
+
* @alpha
|
|
91
|
+
*
|
|
92
|
+
* Required Scopes: [api:datasets-write]
|
|
93
|
+
* URL: /v1/datasets/{datasetRid}/schema
|
|
94
|
+
*/
|
|
95
|
+
export function deleteSchema($ctx, ...args) {
|
|
96
|
+
return $foundryPlatformFetch($ctx, _deleteSchema, ...args);
|
|
97
|
+
}
|
|
4
98
|
//# sourceMappingURL=Dataset.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":[],"
|
|
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 * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.\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 * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\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).\n *\n * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\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;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;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;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":[]}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import type * as _Core from "@osdk/internal.foundry.core";
|
|
2
2
|
import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client";
|
|
3
|
-
import type
|
|
3
|
+
import type * as _Datasets from "../_components.js";
|
|
4
4
|
/**
|
|
5
5
|
* Lists Files contained in a Dataset. By default files are listed on the latest view of the default
|
|
6
6
|
* branch - `master` for most enrollments.
|
|
@@ -34,16 +34,16 @@ import type { BranchId, DatasetRid, File, ListFilesResponse, TransactionRid, Tra
|
|
|
34
34
|
* Required Scopes: [api:datasets-read]
|
|
35
35
|
* URL: /v1/datasets/{datasetRid}/files
|
|
36
36
|
*/
|
|
37
|
-
export declare function
|
|
38
|
-
datasetRid: DatasetRid,
|
|
37
|
+
export declare function list($ctx: $Client | $ClientContext, ...args: [
|
|
38
|
+
datasetRid: _Datasets.DatasetRid,
|
|
39
39
|
$queryParams?: {
|
|
40
|
-
branchId?: BranchId | undefined;
|
|
41
|
-
startTransactionRid?: TransactionRid | undefined;
|
|
42
|
-
endTransactionRid?: TransactionRid | undefined;
|
|
43
|
-
pageSize?: PageSize | undefined;
|
|
44
|
-
pageToken?: PageToken | undefined;
|
|
40
|
+
branchId?: _Datasets.BranchId | undefined;
|
|
41
|
+
startTransactionRid?: _Datasets.TransactionRid | undefined;
|
|
42
|
+
endTransactionRid?: _Datasets.TransactionRid | undefined;
|
|
43
|
+
pageSize?: _Core.PageSize | undefined;
|
|
44
|
+
pageToken?: _Core.PageToken | undefined;
|
|
45
45
|
}
|
|
46
|
-
]): Promise<ListFilesResponse>;
|
|
46
|
+
]): Promise<_Datasets.ListFilesResponse>;
|
|
47
47
|
/**
|
|
48
48
|
* Uploads a File to an existing Dataset.
|
|
49
49
|
* The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.
|
|
@@ -71,16 +71,16 @@ export declare function listFiles($ctx: $Client | $ClientContext, ...args: [
|
|
|
71
71
|
* Required Scopes: [api:datasets-write]
|
|
72
72
|
* URL: /v1/datasets/{datasetRid}/files:upload
|
|
73
73
|
*/
|
|
74
|
-
export declare function
|
|
75
|
-
datasetRid: DatasetRid,
|
|
74
|
+
export declare function upload($ctx: $Client | $ClientContext, ...args: [
|
|
75
|
+
datasetRid: _Datasets.DatasetRid,
|
|
76
76
|
$body: Blob,
|
|
77
77
|
$queryParams: {
|
|
78
|
-
filePath: FilePath;
|
|
79
|
-
branchId?: BranchId | undefined;
|
|
80
|
-
transactionType?: TransactionType | undefined;
|
|
81
|
-
transactionRid?: TransactionRid | undefined;
|
|
78
|
+
filePath: _Core.FilePath;
|
|
79
|
+
branchId?: _Datasets.BranchId | undefined;
|
|
80
|
+
transactionType?: _Datasets.TransactionType | undefined;
|
|
81
|
+
transactionRid?: _Datasets.TransactionRid | undefined;
|
|
82
82
|
}
|
|
83
|
-
]): Promise<File>;
|
|
83
|
+
]): Promise<_Datasets.File>;
|
|
84
84
|
/**
|
|
85
85
|
* Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest
|
|
86
86
|
* view of the default branch - `master` for most enrollments.
|
|
@@ -112,15 +112,15 @@ export declare function uploadFile($ctx: $Client | $ClientContext, ...args: [
|
|
|
112
112
|
* Required Scopes: [api:datasets-read]
|
|
113
113
|
* URL: /v1/datasets/{datasetRid}/files/{filePath}
|
|
114
114
|
*/
|
|
115
|
-
export declare function
|
|
116
|
-
datasetRid: DatasetRid,
|
|
117
|
-
filePath: FilePath,
|
|
115
|
+
export declare function get($ctx: $Client | $ClientContext, ...args: [
|
|
116
|
+
datasetRid: _Datasets.DatasetRid,
|
|
117
|
+
filePath: _Core.FilePath,
|
|
118
118
|
$queryParams?: {
|
|
119
|
-
branchId?: BranchId | undefined;
|
|
120
|
-
startTransactionRid?: TransactionRid | undefined;
|
|
121
|
-
endTransactionRid?: TransactionRid | undefined;
|
|
119
|
+
branchId?: _Datasets.BranchId | undefined;
|
|
120
|
+
startTransactionRid?: _Datasets.TransactionRid | undefined;
|
|
121
|
+
endTransactionRid?: _Datasets.TransactionRid | undefined;
|
|
122
122
|
}
|
|
123
|
-
]): Promise<File>;
|
|
123
|
+
]): Promise<_Datasets.File>;
|
|
124
124
|
/**
|
|
125
125
|
* Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default
|
|
126
126
|
* branch - `master` for most enrollments. The file will still be visible on historical views.
|
|
@@ -145,11 +145,11 @@ export declare function getFileMetadata($ctx: $Client | $ClientContext, ...args:
|
|
|
145
145
|
* URL: /v1/datasets/{datasetRid}/files/{filePath}
|
|
146
146
|
*/
|
|
147
147
|
export declare function deleteFile($ctx: $Client | $ClientContext, ...args: [
|
|
148
|
-
datasetRid: DatasetRid,
|
|
149
|
-
filePath: FilePath,
|
|
148
|
+
datasetRid: _Datasets.DatasetRid,
|
|
149
|
+
filePath: _Core.FilePath,
|
|
150
150
|
$queryParams?: {
|
|
151
|
-
branchId?: BranchId | undefined;
|
|
152
|
-
transactionRid?: TransactionRid | undefined;
|
|
151
|
+
branchId?: _Datasets.BranchId | undefined;
|
|
152
|
+
transactionRid?: _Datasets.TransactionRid | undefined;
|
|
153
153
|
}
|
|
154
154
|
]): Promise<void>;
|
|
155
155
|
/**
|
|
@@ -184,13 +184,13 @@ export declare function deleteFile($ctx: $Client | $ClientContext, ...args: [
|
|
|
184
184
|
* Required Scopes: [api:datasets-read]
|
|
185
185
|
* URL: /v1/datasets/{datasetRid}/files/{filePath}/content
|
|
186
186
|
*/
|
|
187
|
-
export declare function
|
|
188
|
-
datasetRid: DatasetRid,
|
|
189
|
-
filePath: FilePath,
|
|
187
|
+
export declare function read($ctx: $Client | $ClientContext, ...args: [
|
|
188
|
+
datasetRid: _Datasets.DatasetRid,
|
|
189
|
+
filePath: _Core.FilePath,
|
|
190
190
|
$queryParams?: {
|
|
191
|
-
branchId?: BranchId | undefined;
|
|
192
|
-
startTransactionRid?: TransactionRid | undefined;
|
|
193
|
-
endTransactionRid?: TransactionRid | undefined;
|
|
191
|
+
branchId?: _Datasets.BranchId | undefined;
|
|
192
|
+
startTransactionRid?: _Datasets.TransactionRid | undefined;
|
|
193
|
+
endTransactionRid?: _Datasets.TransactionRid | undefined;
|
|
194
194
|
}
|
|
195
195
|
]): Promise<Blob>;
|
|
196
196
|
//# sourceMappingURL=File.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"File.d.ts","sourceRoot":"","sources":["../../../src/public/File.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"File.d.ts","sourceRoot":"","sources":["../../../src/public/File.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,KAAK,KAAK,MAAM,6BAA6B,CAAC;AAC1D,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,qBAAqB,CAAC;AAG7B,OAAO,KAAK,KAAK,SAAS,MAAM,mBAAmB,CAAC;AAiBpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,IAAI,CAClB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,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;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,MAAM,CACpB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,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;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,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,EAC9B,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,IAAI,CAAC,CAEf"}
|
package/build/esm/public/File.js
CHANGED
|
@@ -1,4 +1,184 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
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
|
+
* #### Advanced Usage
|
|
24
|
+
*
|
|
25
|
+
* See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
|
|
26
|
+
*
|
|
27
|
+
* To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most
|
|
28
|
+
* recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the
|
|
29
|
+
* branch if there are no snapshot transactions.
|
|
30
|
+
*
|
|
31
|
+
* To **list files on the resolved view of a transaction** specify the Transaction's resource identifier
|
|
32
|
+
* as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot
|
|
33
|
+
* transaction, or the earliest ancestor transaction if there are no snapshot transactions.
|
|
34
|
+
*
|
|
35
|
+
* To **list files on the resolved view of a range of transactions** specify the the start transaction's resource
|
|
36
|
+
* identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This
|
|
37
|
+
* will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`.
|
|
38
|
+
* Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when
|
|
39
|
+
* the start and end transactions do not belong to the same root-to-leaf path.
|
|
40
|
+
*
|
|
41
|
+
* To **list files on a specific transaction** specify the Transaction's resource identifier as both the
|
|
42
|
+
* `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that
|
|
43
|
+
* Transaction.
|
|
44
|
+
*
|
|
45
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
|
|
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
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
|
|
77
|
+
*
|
|
78
|
+
* @public
|
|
79
|
+
*
|
|
80
|
+
* Required Scopes: [api:datasets-write]
|
|
81
|
+
* URL: /v1/datasets/{datasetRid}/files:upload
|
|
82
|
+
*/
|
|
83
|
+
export function upload($ctx, ...args) {
|
|
84
|
+
return $foundryPlatformFetch($ctx, _upload, ...args);
|
|
85
|
+
}
|
|
86
|
+
const _get = [0, "/v1/datasets/{0}/files/{1}", 2];
|
|
87
|
+
/**
|
|
88
|
+
* Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest
|
|
89
|
+
* view of the default branch - `master` for most enrollments.
|
|
90
|
+
*
|
|
91
|
+
* #### Advanced Usage
|
|
92
|
+
*
|
|
93
|
+
* See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
|
|
94
|
+
*
|
|
95
|
+
* To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will
|
|
96
|
+
* retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest
|
|
97
|
+
* ancestor transaction of the branch if there are no snapshot transactions.
|
|
98
|
+
*
|
|
99
|
+
* To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier
|
|
100
|
+
* as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot
|
|
101
|
+
* transaction, or the earliest ancestor transaction if there are no snapshot transactions.
|
|
102
|
+
*
|
|
103
|
+
* To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's
|
|
104
|
+
* resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.
|
|
105
|
+
* This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the
|
|
106
|
+
* `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path.
|
|
107
|
+
*
|
|
108
|
+
* To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the
|
|
109
|
+
* `startTransactionRid` and `endTransactionRid`.
|
|
110
|
+
*
|
|
111
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
|
|
112
|
+
*
|
|
113
|
+
* @public
|
|
114
|
+
*
|
|
115
|
+
* Required Scopes: [api:datasets-read]
|
|
116
|
+
* URL: /v1/datasets/{datasetRid}/files/{filePath}
|
|
117
|
+
*/
|
|
118
|
+
export function get($ctx, ...args) {
|
|
119
|
+
return $foundryPlatformFetch($ctx, _get, ...args);
|
|
120
|
+
}
|
|
121
|
+
const _deleteFile = [3, "/v1/datasets/{0}/files/{1}", 2];
|
|
122
|
+
/**
|
|
123
|
+
* Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default
|
|
124
|
+
* branch - `master` for most enrollments. The file will still be visible on historical views.
|
|
125
|
+
*
|
|
126
|
+
* #### Advanced Usage
|
|
127
|
+
*
|
|
128
|
+
* See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
|
|
129
|
+
*
|
|
130
|
+
* To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction
|
|
131
|
+
* will be created and committed on this branch.
|
|
132
|
+
*
|
|
133
|
+
* To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier
|
|
134
|
+
* as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a
|
|
135
|
+
* single transaction. See [createTransaction](https://www.palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to
|
|
136
|
+
* open a transaction.
|
|
137
|
+
*
|
|
138
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
|
|
139
|
+
*
|
|
140
|
+
* @public
|
|
141
|
+
*
|
|
142
|
+
* Required Scopes: [api:datasets-write]
|
|
143
|
+
* URL: /v1/datasets/{datasetRid}/files/{filePath}
|
|
144
|
+
*/
|
|
145
|
+
export function deleteFile($ctx, ...args) {
|
|
146
|
+
return $foundryPlatformFetch($ctx, _deleteFile, ...args);
|
|
147
|
+
}
|
|
148
|
+
const _read = [0, "/v1/datasets/{0}/files/{1}/content", 2,, "*/*"];
|
|
149
|
+
/**
|
|
150
|
+
* Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest
|
|
151
|
+
* view of the default branch - `master` for most enrollments.
|
|
152
|
+
*
|
|
153
|
+
* #### Advanced Usage
|
|
154
|
+
*
|
|
155
|
+
* See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
|
|
156
|
+
*
|
|
157
|
+
* To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will
|
|
158
|
+
* retrieve the content for the most recent version of the file since the latest snapshot transaction, or the
|
|
159
|
+
* earliest ancestor transaction of the branch if there are no snapshot transactions.
|
|
160
|
+
*
|
|
161
|
+
* To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier
|
|
162
|
+
* as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest
|
|
163
|
+
* snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions.
|
|
164
|
+
*
|
|
165
|
+
* To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's
|
|
166
|
+
* resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.
|
|
167
|
+
* This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the
|
|
168
|
+
* `endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior
|
|
169
|
+
* is undefined when the start and end transactions do not belong to the same root-to-leaf path.
|
|
170
|
+
*
|
|
171
|
+
* To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the
|
|
172
|
+
* `startTransactionRid` and `endTransactionRid`.
|
|
173
|
+
*
|
|
174
|
+
* Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
|
|
175
|
+
*
|
|
176
|
+
* @public
|
|
177
|
+
*
|
|
178
|
+
* Required Scopes: [api:datasets-read]
|
|
179
|
+
* URL: /v1/datasets/{datasetRid}/files/{filePath}/content
|
|
180
|
+
*/
|
|
181
|
+
export function read($ctx, ...args) {
|
|
182
|
+
return $foundryPlatformFetch($ctx, _read, ...args);
|
|
183
|
+
}
|
|
4
184
|
//# sourceMappingURL=File.js.map
|