@osdk/foundry.datasets 0.0.0

package/build/esm/_components.d.ts

@@ -0,0 +1,123 @@
+import type { FilePath, FolderRid, PageToken } from "@osdk/foundry.core";
+export type LooselyBrandedString<T extends string> = string & {
+    __LOOSE_BRAND?: T;
+};
+/**
+ * Log Safety: UNSAFE
+ */
+export interface Branch {
+    branchId: BranchId;
+    transactionRid?: TransactionRid;
+}
+/**
+ * The identifier (name) of a Branch.
+ *
+ * Log Safety: UNSAFE
+ */
+export type BranchId = LooselyBrandedString<"BranchId">;
+/**
+ * Log Safety: UNSAFE
+ */
+export interface CreateBranchRequest {
+    branchId: BranchId;
+    transactionRid?: TransactionRid;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface CreateDatasetRequest {
+    parentFolderRid: FolderRid;
+    name: DatasetName;
+}
+/**
+ * Log Safety: SAFE
+ */
+export interface CreateTransactionRequest {
+    transactionType: TransactionType;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface Dataset {
+    rid: DatasetRid;
+    name: DatasetName;
+    parentFolderRid: FolderRid;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export type DatasetName = LooselyBrandedString<"DatasetName">;
+/**
+ * The Resource Identifier (RID) of a Dataset.
+ *
+ * Log Safety: SAFE
+ */
+export type DatasetRid = LooselyBrandedString<"DatasetRid">;
+/**
+ * Log Safety: UNSAFE
+ */
+export interface File {
+    path: FilePath;
+    transactionRid: TransactionRid;
+    sizeBytes?: string;
+    updatedTime: FileUpdatedTime;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export type FileUpdatedTime = string;
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ListBranchesResponse {
+    data: Array<Branch>;
+    nextPageToken?: PageToken;
+}
+/**
+ * Log Safety: UNSAFE
+ */
+export interface ListFilesResponse {
+    data: Array<File>;
+    nextPageToken?: PageToken;
+}
+/**
+ * Format for tabular dataset export.
+ *
+ * Log Safety: SAFE
+ */
+export type TableExportFormat = "ARROW" | "CSV";
+/**
+ * Log Safety: UNSAFE
+ */
+export interface Transaction {
+    rid: TransactionRid;
+    transactionType: TransactionType;
+    status: TransactionStatus;
+    createdTime: TransactionCreatedTime;
+    closedTime?: string;
+}
+/**
+ * The timestamp when the transaction was created, in ISO 8601 timestamp format.
+ *
+ * Log Safety: UNSAFE
+ */
+export type TransactionCreatedTime = string;
+/**
+ * The Resource Identifier (RID) of a Transaction.
+ *
+ * Log Safety: SAFE
+ */
+export type TransactionRid = LooselyBrandedString<"TransactionRid">;
+/**
+ * The status of a Transaction.
+ *
+ * Log Safety: SAFE
+ */
+export type TransactionStatus = "ABORTED" | "COMMITTED" | "OPEN";
+/**
+ * The type of a Transaction.
+ *
+ * Log Safety: SAFE
+ */
+export type TransactionType = "APPEND" | "UPDATE" | "SNAPSHOT" | "DELETE";
+//# sourceMappingURL=_components.d.ts.map

package/build/esm/_components.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_components.d.ts","sourceRoot":"","sources":["../../src/_components.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEzE,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,QAAQ,CAAC;IACnB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,eAAe,EAAE,SAAS,CAAC;IAC3B,IAAI,EAAE,WAAW,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,eAAe,EAAE,eAAe,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,UAAU,CAAC;IAChB,IAAI,EAAE,WAAW,CAAC;IAClB,eAAe,EAAE,SAAS,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAE9D;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,oBAAoB,CAAC,YAAY,CAAC,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,QAAQ,CAAC;IACf,cAAc,EAAE,cAAc,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,eAAe,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,aAAa,CAAC,EAAE,SAAS,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAClB,aAAa,CAAC,EAAE,SAAS,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,KAAK,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,cAAc,CAAC;IACpB,eAAe,EAAE,eAAe,CAAC;IACjC,MAAM,EAAE,iBAAiB,CAAC;IAC1B,WAAW,EAAE,sBAAsB,CAAC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;AAEpE;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,WAAW,GAAG,MAAM,CAAC;AAEjE;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,CAAC"}

package/build/esm/chunk-4Z465FSF.js

@@ -0,0 +1,31 @@
+import { __export } from './chunk-PZ5AY32C.js';
+import { foundryPlatformFetch } from '@osdk/shared.net.platformapi';
+
+// src/public/Branch.ts
+var Branch_exports = {};
+__export(Branch_exports, {
+  createBranch: () => createBranch,
+  deleteBranch: () => deleteBranch,
+  getBranch: () => getBranch,
+  listBranches: () => listBranches
+});
+var _createBranch = [1, "/v2/datasets/{0}/branches", 3];
+function createBranch($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _createBranch, ...args);
+}
+var _deleteBranch = [3, "/v2/datasets/{0}/branches/{1}", 2];
+function deleteBranch($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _deleteBranch, ...args);
+}
+var _listBranches = [0, "/v2/datasets/{0}/branches", 2];
+function listBranches($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _listBranches, ...args);
+}
+var _getBranch = [0, "/v2/datasets/{0}/branches/{1}", 2];
+function getBranch($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _getBranch, ...args);
+}
+
+export { Branch_exports, createBranch, deleteBranch, getBranch, listBranches };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=chunk-4Z465FSF.js.map

package/build/esm/chunk-4Z465FSF.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/public/Branch.ts"],"names":[],"mappings":";;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBA,SAAS,wBAAwB,6BAA6B;AAG9D,IAAM,gBAAgB,CAAC,GAAG,6BAA6B,CAAC;AAQjD,SAAS,aAAa,SAAS,MAAM;AAC1C,SAAO,sBAAsB,MAAM,eAAe,GAAG,IAAI;AAC3D;AACA,IAAM,gBAAgB,CAAC,GAAG,iCAAiC,CAAC;AAQrD,SAAS,aAAa,SAAS,MAAM;AAC1C,SAAO,sBAAsB,MAAM,eAAe,GAAG,IAAI;AAC3D;AACA,IAAM,gBAAgB,CAAC,GAAG,6BAA6B,CAAC;AAQjD,SAAS,aAAa,SAAS,MAAM;AAC1C,SAAO,sBAAsB,MAAM,eAAe,GAAG,IAAI;AAC3D;AACA,IAAM,aAAa,CAAC,GAAG,iCAAiC,CAAC;AAQlD,SAAS,UAAU,SAAS,MAAM;AACvC,SAAO,sBAAsB,MAAM,YAAY,GAAG,IAAI;AACxD","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 */\n\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\n\nconst _createBranch = [1, \"/v2/datasets/{0}/branches\", 3];\n\n/**\n * Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction.\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v2/datasets/{datasetRid}/branches\n */\nexport function createBranch($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _createBranch, ...args);\n}\nconst _deleteBranch = [3, \"/v2/datasets/{0}/branches/{1}\", 2];\n\n/**\n * Deletes the Branch with the given BranchId.\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v2/datasets/{datasetRid}/branches/{branchBranchId}\n */\nexport function deleteBranch($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _deleteBranch, ...args);\n}\nconst _listBranches = [0, \"/v2/datasets/{0}/branches\", 2];\n\n/**\n * Lists the Branches of a Dataset.\n *\n * Required Scopes: [api:datasets-read]\n * URL: /v2/datasets/{datasetRid}/branches\n */\nexport function listBranches($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _listBranches, ...args);\n}\nconst _getBranch = [0, \"/v2/datasets/{0}/branches/{1}\", 2];\n\n/**\n * Get a Branch of a Dataset.\n *\n * Required Scopes: [api:datasets-read]\n * URL: /v2/datasets/{datasetRid}/branches/{branchBranchId}\n */\nexport function getBranch($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _getBranch, ...args);\n}"]}

package/build/esm/chunk-5SNWGDKH.js

@@ -0,0 +1,26 @@
+import { __export } from './chunk-PZ5AY32C.js';
+import { foundryPlatformFetch } from '@osdk/shared.net.platformapi';
+
+// src/public/Dataset.ts
+var Dataset_exports = {};
+__export(Dataset_exports, {
+  createDataset: () => createDataset,
+  getDataset: () => getDataset,
+  readTableDataset: () => readTableDataset
+});
+var _createDataset = [1, "/v2/datasets", 3];
+function createDataset($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _createDataset, ...args);
+}
+var _getDataset = [0, "/v2/datasets/{0}", 2];
+function getDataset($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _getDataset, ...args);
+}
+var _readTableDataset = [0, "/v2/datasets/{0}/readTable", 2, , "application/octet-stream"];
+function readTableDataset($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _readTableDataset, ...args);
+}
+
+export { Dataset_exports, createDataset, getDataset, readTableDataset };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=chunk-5SNWGDKH.js.map

package/build/esm/chunk-5SNWGDKH.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/public/Dataset.ts"],"names":[],"mappings":";;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBA,SAAS,wBAAwB,6BAA6B;AAG9D,IAAM,iBAAiB,CAAC,GAAG,gBAAgB,CAAC;AAQrC,SAAS,cAAc,SAAS,MAAM;AAC3C,SAAO,sBAAsB,MAAM,gBAAgB,GAAG,IAAI;AAC5D;AACA,IAAM,cAAc,CAAC,GAAG,oBAAoB,CAAC;AAQtC,SAAS,WAAW,SAAS,MAAM;AACxC,SAAO,sBAAsB,MAAM,aAAa,GAAG,IAAI;AACzD;AACA,IAAM,oBAAoB,CAAC,GAAG,8BAA8B,GAAE,EAAE,0BAA0B;AAUnF,SAAS,iBAAiB,SAAS,MAAM;AAC9C,SAAO,sBAAsB,MAAM,mBAAmB,GAAG,IAAI;AAC/D","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 */\n\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\n\nconst _createDataset = [1, \"/v2/datasets\", 3];\n\n/**\n * Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset.\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v2/datasets\n */\nexport function createDataset($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _createDataset, ...args);\n}\nconst _getDataset = [0, \"/v2/datasets/{0}\", 2];\n\n/**\n * Get the Dataset\n *\n * Required Scopes: [api:datasets-read]\n * URL: /v2/datasets/{datasetRid}\n */\nexport function getDataset($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _getDataset, ...args);\n}\nconst _readTableDataset = [0, \"/v2/datasets/{0}/readTable\", 2,, \"application/octet-stream\"];\n\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 * Required Scopes: [api:datasets-read]\n * URL: /v2/datasets/{datasetRid}/readTable\n */\nexport function readTableDataset($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _readTableDataset, ...args);\n}"]}

package/build/esm/chunk-C6VXNB4U.js

@@ -0,0 +1,36 @@
+import { __export } from './chunk-PZ5AY32C.js';
+import { foundryPlatformFetch } from '@osdk/shared.net.platformapi';
+
+// src/public/File.ts
+var File_exports = {};
+__export(File_exports, {
+  deleteFile: () => deleteFile,
+  getFile: () => getFile,
+  getFileContent: () => getFileContent,
+  listFiles: () => listFiles,
+  uploadFile: () => uploadFile
+});
+var _deleteFile = [3, "/v2/datasets/{0}/files/{1}", 2];
+function deleteFile($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _deleteFile, ...args);
+}
+var _listFiles = [0, "/v2/datasets/{0}/files", 2];
+function listFiles($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _listFiles, ...args);
+}
+var _getFile = [0, "/v2/datasets/{0}/files/{1}", 2];
+function getFile($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _getFile, ...args);
+}
+var _uploadFile = [1, "/v2/datasets/{0}/files/{1}/upload", 3, "application/octet-stream"];
+function uploadFile($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _uploadFile, ...args);
+}
+var _getFileContent = [0, "/v2/datasets/{0}/files/{1}/content", 2, , "application/octet-stream"];
+function getFileContent($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _getFileContent, ...args);
+}
+
+export { File_exports, deleteFile, getFile, getFileContent, listFiles, uploadFile };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=chunk-C6VXNB4U.js.map

package/build/esm/chunk-C6VXNB4U.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/public/File.ts"],"names":[],"mappings":";;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBA,SAAS,wBAAwB,6BAA6B;AAG9D,IAAM,cAAc,CAAC,GAAG,8BAA8B,CAAC;AAiBhD,SAAS,WAAW,SAAS,MAAM;AACxC,SAAO,sBAAsB,MAAM,aAAa,GAAG,IAAI;AACzD;AACA,IAAM,aAAa,CAAC,GAAG,0BAA0B,CAAC;AAyB3C,SAAS,UAAU,SAAS,MAAM;AACvC,SAAO,sBAAsB,MAAM,YAAY,GAAG,IAAI;AACxD;AACA,IAAM,WAAW,CAAC,GAAG,8BAA8B,CAAC;AAuB7C,SAAS,QAAQ,SAAS,MAAM;AACrC,SAAO,sBAAsB,MAAM,UAAU,GAAG,IAAI;AACtD;AACA,IAAM,cAAc,CAAC,GAAG,qCAAqC,GAAG,0BAA0B;AAoBnF,SAAS,WAAW,SAAS,MAAM;AACxC,SAAO,sBAAsB,MAAM,aAAa,GAAG,IAAI;AACzD;AACA,IAAM,kBAAkB,CAAC,GAAG,sCAAsC,GAAE,EAAE,0BAA0B;AAwBzF,SAAS,eAAe,SAAS,MAAM;AAC5C,SAAO,sBAAsB,MAAM,iBAAiB,GAAG,IAAI;AAC7D","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 */\n\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\n\nconst _deleteFile = [3, \"/v2/datasets/{0}/files/{1}\", 2];\n\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 * #### Advanced Usage\n * See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\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 * 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](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to\n * open a transaction.\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v2/datasets/{datasetRid}/files/{filePath}\n */\nexport function deleteFile($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _deleteFile, ...args);\n}\nconst _listFiles = [0, \"/v2/datasets/{0}/files\", 2];\n\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 * #### Advanced Usage\n * See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\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 * 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 * 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 * 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 * Required Scopes: [api:datasets-read]\n * URL: /v2/datasets/{datasetRid}/files\n */\nexport function listFiles($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _listFiles, ...args);\n}\nconst _getFile = [0, \"/v2/datasets/{0}/files/{1}\", 2];\n\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 * #### Advanced Usage\n * See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\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 * 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 * 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 * 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 * Required Scopes: [api:datasets-read]\n * URL: /v2/datasets/{datasetRid}/files/{filePath}\n */\nexport function getFile($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _getFile, ...args);\n}\nconst _uploadFile = [1, \"/v2/datasets/{0}/files/{1}/upload\", 3, \"application/octet-stream\"];\n\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 * 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 * #### Advanced Usage\n * See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\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](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch.\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](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction.\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v2/datasets/{datasetRid}/files/{filePath}/upload\n */\nexport function uploadFile($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _uploadFile, ...args);\n}\nconst _getFileContent = [0, \"/v2/datasets/{0}/files/{1}/content\", 2,, \"application/octet-stream\"];\n\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 * #### Advanced Usage\n * See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\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 * 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 * 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 * 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 * Required Scopes: [api:datasets-read]\n * URL: /v2/datasets/{datasetRid}/files/{filePath}/content\n */\nexport function getFileContent($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _getFileContent, ...args);\n}"]}

package/build/esm/chunk-ONCYXSA5.js

@@ -0,0 +1,31 @@
+import { __export } from './chunk-PZ5AY32C.js';
+import { foundryPlatformFetch } from '@osdk/shared.net.platformapi';
+
+// src/public/Transaction.ts
+var Transaction_exports = {};
+__export(Transaction_exports, {
+  abortTransaction: () => abortTransaction,
+  commitTransaction: () => commitTransaction,
+  createTransaction: () => createTransaction,
+  getTransaction: () => getTransaction
+});
+var _createTransaction = [1, "/v2/datasets/{0}/transactions", 3];
+function createTransaction($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _createTransaction, ...args);
+}
+var _getTransaction = [0, "/v2/datasets/{0}/transactions/{1}", 2];
+function getTransaction($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _getTransaction, ...args);
+}
+var _commitTransaction = [1, "/v2/datasets/{0}/transactions/{1}/commit", 2];
+function commitTransaction($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _commitTransaction, ...args);
+}
+var _abortTransaction = [1, "/v2/datasets/{0}/transactions/{1}/abort", 2];
+function abortTransaction($ctx, ...args) {
+  return foundryPlatformFetch($ctx, _abortTransaction, ...args);
+}
+
+export { Transaction_exports, abortTransaction, commitTransaction, createTransaction, getTransaction };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=chunk-ONCYXSA5.js.map

package/build/esm/chunk-ONCYXSA5.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/public/Transaction.ts"],"names":[],"mappings":";;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAgBA,SAAS,wBAAwB,6BAA6B;AAG9D,IAAM,qBAAqB,CAAC,GAAG,iCAAiC,CAAC;AAQ1D,SAAS,kBAAkB,SAAS,MAAM;AAC/C,SAAO,sBAAsB,MAAM,oBAAoB,GAAG,IAAI;AAChE;AACA,IAAM,kBAAkB,CAAC,GAAG,qCAAqC,CAAC;AAQ3D,SAAS,eAAe,SAAS,MAAM;AAC5C,SAAO,sBAAsB,MAAM,iBAAiB,GAAG,IAAI;AAC7D;AACA,IAAM,qBAAqB,CAAC,GAAG,4CAA4C,CAAC;AASrE,SAAS,kBAAkB,SAAS,MAAM;AAC/C,SAAO,sBAAsB,MAAM,oBAAoB,GAAG,IAAI;AAChE;AACA,IAAM,oBAAoB,CAAC,GAAG,2CAA2C,CAAC;AASnE,SAAS,iBAAiB,SAAS,MAAM;AAC9C,SAAO,sBAAsB,MAAM,mBAAmB,GAAG,IAAI;AAC/D","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 */\n\nimport { foundryPlatformFetch as $foundryPlatformFetch } from \"@osdk/shared.net.platformapi\";\n//\n\nconst _createTransaction = [1, \"/v2/datasets/{0}/transactions\", 3];\n\n/**\n * Creates a Transaction on a Branch of a Dataset.\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v2/datasets/{datasetRid}/transactions\n */\nexport function createTransaction($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _createTransaction, ...args);\n}\nconst _getTransaction = [0, \"/v2/datasets/{0}/transactions/{1}\", 2];\n\n/**\n * Gets a Transaction of a Dataset.\n *\n * Required Scopes: [api:datasets-read]\n * URL: /v2/datasets/{datasetRid}/transactions/{transactionRid}\n */\nexport function getTransaction($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _getTransaction, ...args);\n}\nconst _commitTransaction = [1, \"/v2/datasets/{0}/transactions/{1}/commit\", 2];\n\n/**\n * Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is\n * updated to point to the Transaction.\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v2/datasets/{datasetRid}/transactions/{transactionRid}/commit\n */\nexport function commitTransaction($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _commitTransaction, ...args);\n}\nconst _abortTransaction = [1, \"/v2/datasets/{0}/transactions/{1}/abort\", 2];\n\n/**\n * Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is\n * not updated.\n *\n * Required Scopes: [api:datasets-write]\n * URL: /v2/datasets/{datasetRid}/transactions/{transactionRid}/abort\n */\nexport function abortTransaction($ctx, ...args) {\n  return $foundryPlatformFetch($ctx, _abortTransaction, ...args);\n}"]}

package/build/esm/chunk-PZ5AY32C.js

@@ -0,0 +1,9 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+export { __export };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=chunk-PZ5AY32C.js.map

package/build/esm/chunk-PZ5AY32C.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/build/esm/index.d.ts

@@ -0,0 +1,6 @@
+export type { Branch, BranchId, CreateBranchRequest, CreateDatasetRequest, CreateTransactionRequest, Dataset, DatasetName, DatasetRid, File, FileUpdatedTime, ListBranchesResponse, ListFilesResponse, TableExportFormat, Transaction, TransactionCreatedTime, TransactionRid, TransactionStatus, TransactionType, } from "./_components.js";
+export * as Branches from "./public/Branch.js";
+export * as Datasets from "./public/Dataset.js";
+export * as Files from "./public/File.js";
+export * as Transactions from "./public/Transaction.js";
+//# sourceMappingURL=index.d.ts.map

package/build/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,YAAY,EACV,MAAM,EACN,QAAQ,EACR,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,OAAO,EACP,WAAW,EACX,UAAU,EACV,IAAI,EACJ,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,WAAW,EACX,sBAAsB,EACtB,cAAc,EACd,iBAAiB,EACjB,eAAe,GAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,QAAQ,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAC;AAChD,OAAO,KAAK,KAAK,MAAM,kBAAkB,CAAC;AAC1C,OAAO,KAAK,YAAY,MAAM,yBAAyB,CAAC"}

package/build/esm/index.js

@@ -0,0 +1,7 @@
+export { Branch_exports as Branches } from './chunk-4Z465FSF.js';
+export { Dataset_exports as Datasets } from './chunk-5SNWGDKH.js';
+export { File_exports as Files } from './chunk-C6VXNB4U.js';
+export { Transaction_exports as Transactions } from './chunk-ONCYXSA5.js';
+import './chunk-PZ5AY32C.js';
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.js.map

package/build/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/build/esm/public/Branch.d.ts

@@ -0,0 +1,57 @@
+import type { PageSize, PageToken, PreviewMode } from "@osdk/foundry.core";
+import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client";
+import type { Branch, BranchId, CreateBranchRequest, DatasetRid, ListBranchesResponse } from "../_components.js";
+/**
+ * Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction.
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v2/datasets/{datasetRid}/branches
+ */
+export declare function createBranch($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    $body: CreateBranchRequest,
+    $queryParams?: {
+        preview?: PreviewMode | undefined;
+    }
+]): Promise<Branch>;
+/**
+ * Deletes the Branch with the given BranchId.
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v2/datasets/{datasetRid}/branches/{branchBranchId}
+ */
+export declare function deleteBranch($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    branchBranchId: BranchId,
+    $queryParams?: {
+        preview?: PreviewMode | undefined;
+    }
+]): Promise<void>;
+/**
+ * Lists the Branches of a Dataset.
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v2/datasets/{datasetRid}/branches
+ */
+export declare function listBranches($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    $queryParams?: {
+        pageSize?: PageSize | undefined;
+        pageToken?: PageToken | undefined;
+        preview?: PreviewMode | undefined;
+    }
+]): Promise<ListBranchesResponse>;
+/**
+ * Get a Branch of a Dataset.
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v2/datasets/{datasetRid}/branches/{branchBranchId}
+ */
+export declare function getBranch($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    branchBranchId: BranchId,
+    $queryParams?: {
+        preview?: PreviewMode | undefined;
+    }
+]): Promise<Branch>;
+//# sourceMappingURL=Branch.d.ts.map

package/build/esm/public/Branch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Branch.d.ts","sourceRoot":"","sources":["../../../src/public/Branch.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC3E,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,qBAAqB,CAAC;AAG7B,OAAO,KAAK,EACV,MAAM,EACN,QAAQ,EACR,mBAAmB,EACnB,UAAU,EACV,oBAAoB,EACrB,MAAM,mBAAmB,CAAC;AAY3B;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,UAAU;IACtB,KAAK,EAAE,mBAAmB;IAC1B,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,MAAM,CAAC,CAEjB;AAUD;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,UAAU;IACtB,cAAc,EAAE,QAAQ;IAExB,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,IAAI,CAAC,CAEf;AAaD;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,UAAU;IAEtB,YAAY,CAAC,EAAE;QACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;QAClC,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;KACnC;CACF,GACA,OAAO,CAAC,oBAAoB,CAAC,CAE/B;AAUD;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,UAAU;IACtB,cAAc,EAAE,QAAQ;IAExB,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,MAAM,CAAC,CAEjB"}

package/build/esm/public/Branch.js

@@ -0,0 +1,4 @@
+export { createBranch, deleteBranch, getBranch, listBranches } from '../chunk-4Z465FSF.js';
+import '../chunk-PZ5AY32C.js';
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=Branch.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

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

@@ -0,0 +1,48 @@
+import type { PreviewMode } from "@osdk/foundry.core";
+import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client";
+import type { BranchId, CreateDatasetRequest, Dataset, DatasetRid, TableExportFormat, TransactionRid } from "../_components.js";
+/**
+ * Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset.
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v2/datasets
+ */
+export declare function createDataset($ctx: $Client | $ClientContext, ...args: [
+    $body: CreateDatasetRequest,
+    $queryParams?: {
+        preview?: PreviewMode | undefined;
+    }
+]): Promise<Dataset>;
+/**
+ * Get the Dataset
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v2/datasets/{datasetRid}
+ */
+export declare function getDataset($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    $queryParams?: {
+        preview?: PreviewMode | undefined;
+    }
+]): Promise<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).
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v2/datasets/{datasetRid}/readTable
+ */
+export declare function readTableDataset($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    $queryParams: {
+        branchId?: BranchId | undefined;
+        startTransactionRid?: TransactionRid | undefined;
+        endTransactionRid?: TransactionRid | undefined;
+        format: TableExportFormat;
+        columns: Array<string>;
+        rowLimit?: number | undefined;
+        preview?: PreviewMode | undefined;
+    }
+]): Promise<Blob>;
+//# sourceMappingURL=Dataset.d.ts.map

package/build/esm/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,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EACV,YAAY,IAAI,OAAO,EACvB,mBAAmB,IAAI,cAAc,EACtC,MAAM,qBAAqB,CAAC;AAG7B,OAAO,KAAK,EACV,QAAQ,EACR,oBAAoB,EACpB,OAAO,EACP,UAAU,EACV,iBAAiB,EACjB,cAAc,EACf,MAAM,mBAAmB,CAAC;AAW3B;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,KAAK,EAAE,oBAAoB;IAC3B,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,OAAO,CAAC,CAElB;AASD;;;;;GAKG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,UAAU;IAEtB,YAAY,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE;CACrD,GACA,OAAO,CAAC,OAAO,CAAC,CAElB;AAiBD;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,OAAO,GAAG,cAAc,EAC9B,GAAG,IAAI,EAAE;IACP,UAAU,EAAE,UAAU;IAEtB,YAAY,EAAE;QACZ,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;QAChC,mBAAmB,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;QACjD,iBAAiB,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;QAC/C,MAAM,EAAE,iBAAiB,CAAC;QAC1B,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC9B,OAAO,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;KACnC;CACF,GACA,OAAO,CAAC,IAAI,CAAC,CAEf"}

package/build/esm/public/Dataset.js

@@ -0,0 +1,4 @@
+export { createDataset, getDataset, readTableDataset } from '../chunk-5SNWGDKH.js';
+import '../chunk-PZ5AY32C.js';
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=Dataset.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

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

@@ -0,0 +1,154 @@
+import type { FilePath, PageSize, PageToken, PreviewMode } from "@osdk/foundry.core";
+import type { SharedClient as $Client, SharedClientContext as $ClientContext } from "@osdk/shared.client";
+import type { BranchId, DatasetRid, File, ListFilesResponse, TransactionRid, TransactionType } from "../_components.js";
+/**
+ * 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](/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](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to
+ * open a transaction.
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v2/datasets/{datasetRid}/files/{filePath}
+ */
+export declare function deleteFile($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    filePath: FilePath,
+    $queryParams?: {
+        branchId?: BranchId | undefined;
+        transactionRid?: TransactionRid | undefined;
+        preview?: PreviewMode | undefined;
+    }
+]): Promise<void>;
+/**
+ * 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](/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.
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v2/datasets/{datasetRid}/files
+ */
+export declare function listFiles($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    $queryParams?: {
+        branchId?: BranchId | undefined;
+        startTransactionRid?: TransactionRid | undefined;
+        endTransactionRid?: TransactionRid | undefined;
+        pageSize?: PageSize | undefined;
+        pageToken?: PageToken | undefined;
+        preview?: PreviewMode | undefined;
+    }
+]): Promise<ListFilesResponse>;
+/**
+ * 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](/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`.
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v2/datasets/{datasetRid}/files/{filePath}
+ */
+export declare function getFile($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    filePath: FilePath,
+    $queryParams?: {
+        branchId?: BranchId | undefined;
+        startTransactionRid?: TransactionRid | undefined;
+        endTransactionRid?: TransactionRid | undefined;
+        preview?: PreviewMode | undefined;
+    }
+]): Promise<File>;
+/**
+ * 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](/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](/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](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction.
+ *
+ * Required Scopes: [api:datasets-write]
+ * URL: /v2/datasets/{datasetRid}/files/{filePath}/upload
+ */
+export declare function uploadFile($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    filePath: FilePath,
+    $body: Blob,
+    $queryParams?: {
+        branchId?: BranchId | undefined;
+        transactionType?: TransactionType | undefined;
+        transactionRid?: TransactionRid | undefined;
+        preview?: PreviewMode | undefined;
+    }
+]): Promise<File>;
+/**
+ * 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](/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`.
+ *
+ * Required Scopes: [api:datasets-read]
+ * URL: /v2/datasets/{datasetRid}/files/{filePath}/content
+ */
+export declare function getFileContent($ctx: $Client | $ClientContext, ...args: [
+    datasetRid: DatasetRid,
+    filePath: FilePath,
+    $queryParams?: {
+        branchId?: BranchId | undefined;
+        startTransactionRid?: TransactionRid | undefined;
+        endTransactionRid?: TransactionRid | undefined;
+        preview?: PreviewMode | undefined;
+    }
+]): Promise<Blob>;
+//# sourceMappingURL=File.d.ts.map