@osdk/internal.foundry.datasets 0.2.0-beta.8 → 0.2.0-beta.9

package/build/browser/public/Branch.js

@@ -1,4 +1,74 @@
-export { createBranch, deleteBranch, getBranch, listBranches } from '../chunk-JIXOPP3M.js';
-import '../chunk-PZ5AY32C.js';
-//# sourceMappingURL=Branch.js.map
+/*
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { foundryPlatformFetch as $foundryPlatformFetch } from "@osdk/shared.net.platformapi";
+//
+const _createBranch = [1, "/v1/datasets/{0}/branches", 1];
+/**
+ * Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/branches
+ */
+export function createBranch($ctx, ...args) {
+  return $foundryPlatformFetch($ctx, _createBranch, ...args);
+}
+const _getBranch = [0, "/v1/datasets/{0}/branches/{1}"];
+/**
+ * Get a Branch of a Dataset.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/branches/{branchId}
+ */
+export function getBranch($ctx, ...args) {
+  return $foundryPlatformFetch($ctx, _getBranch, ...args);
+}
+const _deleteBranch = [3, "/v1/datasets/{0}/branches/{1}"];
+/**
+ * Deletes the Branch with the given BranchId.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/branches/{branchId}
+ */
+export function deleteBranch($ctx, ...args) {
+  return $foundryPlatformFetch($ctx, _deleteBranch, ...args);
+}
+const _listBranches = [0, "/v1/datasets/{0}/branches", 2];
+/**
+ * Lists the Branches of a Dataset.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/branches
+ */
+export function listBranches($ctx, ...args) {
+  return $foundryPlatformFetch($ctx, _listBranches, ...args);
+}
 //# sourceMappingURL=Branch.js.map

package/build/browser/public/Branch.js.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":"","file":"Branch.js"}
+{"version":3,"file":"Branch.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_createBranch","createBranch","$ctx","args","_getBranch","getBranch","_deleteBranch","deleteBranch","_listBranches","listBranches"],"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 _createBranch = [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 createBranch($ctx, ...args) {\n    return $foundryPlatformFetch($ctx, _createBranch, ...args);\n}\nconst _getBranch = [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 getBranch($ctx, ...args) {\n    return $foundryPlatformFetch($ctx, _getBranch, ...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 _listBranches = [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 listBranches($ctx, ...args) {\n    return $foundryPlatformFetch($ctx, _listBranches, ...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,aAAa,GAAG,CAAC,CAAC,EAAE,2BAA2B,EAAE,CAAC,CAAC;AACzD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EACxC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,aAAa,EAAE,GAAGG,IAAI,CAAC;AAC9D;AACA,MAAMC,UAAU,GAAG,CAAC,CAAC,EAAE,+BAA+B,CAAC;AACvD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EACrC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,UAAU,EAAE,GAAGD,IAAI,CAAC;AAC3D;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,aAAa,GAAG,CAAC,CAAC,EAAE,2BAA2B,EAAE,CAAC,CAAC;AACzD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,YAAYA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EACxC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,aAAa,EAAE,GAAGL,IAAI,CAAC;AAC9D","ignoreList":[]}

package/build/browser/public/Dataset.d.ts

@@ -0,0 +1,97 @@
+import type * as _Core from "@osdk/internal.foundry.core";
+import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client";
+import type * as _Datasets from "../_components.js";
+/**
+ * Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets
+ */
+export declare function createDataset($ctx: $Client | $ClientContext, ...args: [$body: _Datasets.CreateDatasetRequest]): Promise<_Datasets.Dataset>;
+/**
+ * Gets the Dataset with the given DatasetRid.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}
+ */
+export declare function getDataset($ctx: $Client | $ClientContext, ...args: [datasetRid: _Datasets.DatasetRid]): Promise<_Datasets.Dataset>;
+/**
+ * Gets the content of a dataset as a table in the specified format.
+ *
+ * This endpoint currently does not support views (Virtual datasets composed of other datasets).
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/readTable
+ */
+export declare function readTable($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: _Datasets.DatasetRid,
+    $queryParams: {
+        branchId?: _Datasets.BranchId | undefined;
+        startTransactionRid?: _Datasets.TransactionRid | undefined;
+        endTransactionRid?: _Datasets.TransactionRid | undefined;
+        format: _Datasets.TableExportFormat;
+        columns: Array<string>;
+        rowLimit?: number | undefined;
+    }
+]): Promise<Blob>;
+/**
+ * Puts a Schema on an existing Dataset and Branch.
+ *
+ * @alpha
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/schema
+ */
+export declare function putSchema($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: _Datasets.DatasetRid,
+    $body: any,
+    $queryParams?: {
+        branchId?: _Datasets.BranchId | undefined;
+        preview?: _Core.PreviewMode | undefined;
+    }
+]): Promise<void>;
+/**
+ * Retrieves the Schema for a Dataset and Branch, if it exists.
+ *
+ * @alpha
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/schema
+ */
+export declare function getSchema($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: _Datasets.DatasetRid,
+    $queryParams?: {
+        branchId?: _Datasets.BranchId | undefined;
+        transactionRid?: _Datasets.TransactionRid | undefined;
+        preview?: _Core.PreviewMode | undefined;
+    }
+]): Promise<any | undefined>;
+/**
+ * Deletes the Schema from a Dataset and Branch.
+ *
+ * @alpha
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/schema
+ */
+export declare function deleteSchema($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: _Datasets.DatasetRid,
+    $queryParams?: {
+        branchId?: _Datasets.BranchId | undefined;
+        transactionRid?: _Datasets.TransactionRid | undefined;
+        preview?: _Core.PreviewMode | undefined;
+    }
+]): Promise<void>;
+//# sourceMappingURL=Dataset.d.ts.map

package/build/browser/public/Dataset.d.ts.map

@@ -0,0 +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,aAAa,CAC3B,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,UAAU,CACxB,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,SAAS,CACvB,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,SAAS,CACvB,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"}

package/build/browser/public/Dataset.js

@@ -1,4 +1,98 @@
-export { createDataset, deleteSchema, getDataset, getSchema, putSchema, readTable } from '../chunk-EDFN5GXZ.js';
-import '../chunk-PZ5AY32C.js';
-//# sourceMappingURL=Dataset.js.map
+/*
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { foundryPlatformFetch as $foundryPlatformFetch } from "@osdk/shared.net.platformapi";
+//
+const _createDataset = [1, "/v1/datasets", 1];
+/**
+ * Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets
+ */
+export function createDataset($ctx, ...args) {
+  return $foundryPlatformFetch($ctx, _createDataset, ...args);
+}
+const _getDataset = [0, "/v1/datasets/{0}"];
+/**
+ * Gets the Dataset with the given DatasetRid.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}
+ */
+export function getDataset($ctx, ...args) {
+  return $foundryPlatformFetch($ctx, _getDataset, ...args);
+}
+const _readTable = [0, "/v1/datasets/{0}/readTable", 2,, "*/*"];
+/**
+ * Gets the content of a dataset as a table in the specified format.
+ *
+ * This endpoint currently does not support views (Virtual datasets composed of other datasets).
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/readTable
+ */
+export function readTable($ctx, ...args) {
+  return $foundryPlatformFetch($ctx, _readTable, ...args);
+}
+const _putSchema = [2, "/v1/datasets/{0}/schema", 3];
+/**
+ * Puts a Schema on an existing Dataset and Branch.
+ *
+ * @alpha
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/schema
+ */
+export function putSchema($ctx, ...args) {
+  return $foundryPlatformFetch($ctx, _putSchema, ...args);
+}
+const _getSchema = [0, "/v1/datasets/{0}/schema", 2];
+/**
+ * Retrieves the Schema for a Dataset and Branch, if it exists.
+ *
+ * @alpha
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/schema
+ */
+export function getSchema($ctx, ...args) {
+  return $foundryPlatformFetch($ctx, _getSchema, ...args);
+}
+const _deleteSchema = [3, "/v1/datasets/{0}/schema", 2];
+/**
+ * Deletes the Schema from a Dataset and Branch.
+ *
+ * @alpha
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/schema
+ */
+export function deleteSchema($ctx, ...args) {
+  return $foundryPlatformFetch($ctx, _deleteSchema, ...args);
+}
 //# sourceMappingURL=Dataset.js.map

package/build/browser/public/Dataset.js.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":"","file":"Dataset.js"}
+{"version":3,"file":"Dataset.js","names":["foundryPlatformFetch","$foundryPlatformFetch","_createDataset","createDataset","$ctx","args","_getDataset","getDataset","_readTable","readTable","_putSchema","putSchema","_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 _createDataset = [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 createDataset($ctx, ...args) {\n    return $foundryPlatformFetch($ctx, _createDataset, ...args);\n}\nconst _getDataset = [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 getDataset($ctx, ...args) {\n    return $foundryPlatformFetch($ctx, _getDataset, ...args);\n}\nconst _readTable = [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 readTable($ctx, ...args) {\n    return $foundryPlatformFetch($ctx, _readTable, ...args);\n}\nconst _putSchema = [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 putSchema($ctx, ...args) {\n    return $foundryPlatformFetch($ctx, _putSchema, ...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,cAAc,GAAG,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC;AAC7C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,aAAaA,CAACC,IAAI,EAAE,GAAGC,IAAI,EAAE;EACzC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEF,cAAc,EAAE,GAAGG,IAAI,CAAC;AAC/D;AACA,MAAMC,WAAW,GAAG,CAAC,CAAC,EAAE,kBAAkB,CAAC;AAC3C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,UAAUA,CAACH,IAAI,EAAE,GAAGC,IAAI,EAAE;EACtC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEE,WAAW,EAAE,GAAGD,IAAI,CAAC;AAC5D;AACA,MAAMG,UAAU,GAAG,CAAC,CAAC,EAAE,4BAA4B,EAAE,CAAC,GAAI,KAAK,CAAC;AAChE;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACL,IAAI,EAAE,GAAGC,IAAI,EAAE;EACrC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEI,UAAU,EAAE,GAAGH,IAAI,CAAC;AAC3D;AACA,MAAMK,UAAU,GAAG,CAAC,CAAC,EAAE,yBAAyB,EAAE,CAAC,CAAC;AACpD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,SAASA,CAACP,IAAI,EAAE,GAAGC,IAAI,EAAE;EACrC,OAAOJ,qBAAqB,CAACG,IAAI,EAAEM,UAAU,EAAE,GAAGL,IAAI,CAAC;AAC3D;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":[]}

package/build/browser/public/File.d.ts

@@ -0,0 +1,196 @@
+import type * as _Core from "@osdk/internal.foundry.core";
+import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client";
+import type * as _Datasets from "../_components.js";
+/**
+ * Lists Files contained in a Dataset. By default files are listed on the latest view of the default
+ * branch - `master` for most enrollments.
+ *
+ * #### Advanced Usage
+ *
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
+ *
+ * To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most
+ * recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the
+ * branch if there are no snapshot transactions.
+ *
+ * To **list files on the resolved view of a transaction** specify the Transaction's resource identifier
+ * as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot
+ * transaction, or the earliest ancestor transaction if there are no snapshot transactions.
+ *
+ * To **list files on the resolved view of a range of transactions** specify the the start transaction's resource
+ * identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This
+ * will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`.
+ * Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when
+ * the start and end transactions do not belong to the same root-to-leaf path.
+ *
+ * To **list files on a specific transaction** specify the Transaction's resource identifier as both the
+ * `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that
+ * Transaction.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/files
+ */
+export declare function listFiles($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: _Datasets.DatasetRid,
+    $queryParams?: {
+        branchId?: _Datasets.BranchId | undefined;
+        startTransactionRid?: _Datasets.TransactionRid | undefined;
+        endTransactionRid?: _Datasets.TransactionRid | undefined;
+        pageSize?: _Core.PageSize | undefined;
+        pageToken?: _Core.PageToken | undefined;
+    }
+]): Promise<_Datasets.ListFilesResponse>;
+/**
+ * Uploads a File to an existing Dataset.
+ * The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.
+ *
+ * By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments.
+ * If the file already exists only the most recent version will be visible in the updated view.
+ *
+ * #### Advanced Usage
+ *
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
+ *
+ * To **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will
+ * be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this
+ * default specify `transactionType` in addition to `branchId`.
+ * See [createBranch](https://www.palantir.com/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch.
+ *
+ * To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as
+ * `transactionRid`. This is useful for uploading multiple files in a single transaction.
+ * See [createTransaction](https://www.palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/files:upload
+ */
+export declare function uploadFile($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: _Datasets.DatasetRid,
+    $body: Blob,
+    $queryParams: {
+        filePath: _Core.FilePath;
+        branchId?: _Datasets.BranchId | undefined;
+        transactionType?: _Datasets.TransactionType | undefined;
+        transactionRid?: _Datasets.TransactionRid | undefined;
+    }
+]): Promise<_Datasets.File>;
+/**
+ * Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest
+ * view of the default branch - `master` for most enrollments.
+ *
+ * #### Advanced Usage
+ *
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
+ *
+ * To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will
+ * retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest
+ * ancestor transaction of the branch if there are no snapshot transactions.
+ *
+ * To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier
+ * as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot
+ * transaction, or the earliest ancestor transaction if there are no snapshot transactions.
+ *
+ * To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's
+ * resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.
+ * This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the
+ * `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path.
+ *
+ * To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the
+ * `startTransactionRid` and `endTransactionRid`.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/files/{filePath}
+ */
+export declare function getFileMetadata($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: _Datasets.DatasetRid,
+    filePath: _Core.FilePath,
+    $queryParams?: {
+        branchId?: _Datasets.BranchId | undefined;
+        startTransactionRid?: _Datasets.TransactionRid | undefined;
+        endTransactionRid?: _Datasets.TransactionRid | undefined;
+    }
+]): Promise<_Datasets.File>;
+/**
+ * Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default
+ * branch - `master` for most enrollments. The file will still be visible on historical views.
+ *
+ * #### Advanced Usage
+ *
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
+ *
+ * To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction
+ * will be created and committed on this branch.
+ *
+ * To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier
+ * as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a
+ * single transaction. See [createTransaction](https://www.palantir.com/docs/foundry/api/datasets-resources/transactions/create-transaction/) to
+ * open a transaction.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v1/datasets/{datasetRid}/files/{filePath}
+ */
+export declare function deleteFile($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: _Datasets.DatasetRid,
+    filePath: _Core.FilePath,
+    $queryParams?: {
+        branchId?: _Datasets.BranchId | undefined;
+        transactionRid?: _Datasets.TransactionRid | undefined;
+    }
+]): Promise<void>;
+/**
+ * Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest
+ * view of the default branch - `master` for most enrollments.
+ *
+ * #### Advanced Usage
+ *
+ * See [Datasets Core Concepts](https://www.palantir.com/docs/foundry/data-integration/datasets/) for details on using branches and transactions.
+ *
+ * To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will
+ * retrieve the content for the most recent version of the file since the latest snapshot transaction, or the
+ * earliest ancestor transaction of the branch if there are no snapshot transactions.
+ *
+ * To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier
+ * as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest
+ * snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions.
+ *
+ * To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's
+ * resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.
+ * This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the
+ * `endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior
+ * is undefined when the start and end transactions do not belong to the same root-to-leaf path.
+ *
+ * To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the
+ * `startTransactionRid` and `endTransactionRid`.
+ *
+ * Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.
+ *
+ * @public
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v1/datasets/{datasetRid}/files/{filePath}/content
+ */
+export declare function getFileContent($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: _Datasets.DatasetRid,
+    filePath: _Core.FilePath,
+    $queryParams?: {
+        branchId?: _Datasets.BranchId | undefined;
+        startTransactionRid?: _Datasets.TransactionRid | undefined;
+        endTransactionRid?: _Datasets.TransactionRid | undefined;
+    }
+]): Promise<Blob>;
+//# sourceMappingURL=File.d.ts.map

package/build/browser/public/File.d.ts.map

@@ -0,0 +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,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,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,UAAU,CACxB,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,eAAe,CAC7B,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,cAAc,CAC5B,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"}