@bytescale/sdk 3.21.6 → 3.22.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.
@@ -738,7 +738,7 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
738
738
  }
739
739
  }
740
740
  /**
741
- * Deletes a file synchronously.
741
+ * Deletes a file synchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
742
742
  */
743
743
  }, {
744
744
  key: "deleteFile",
@@ -765,7 +765,7 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
765
765
  }
766
766
  }
767
767
  /**
768
- * Deletes multiple files asynchronously.
768
+ * Deletes multiple files asynchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
769
769
  */
770
770
  }, {
771
771
  key: "deleteFileBatch",
@@ -983,7 +983,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
983
983
  key: "copyFolder",
984
984
  value:
985
985
  /**
986
- * Copies a folder asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
986
+ * Copies a folder asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
987
987
  */
988
988
  function copyFolder(params) {
989
989
  try {
@@ -1007,7 +1007,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1007
1007
  }
1008
1008
  }
1009
1009
  /**
1010
- * Copies multiple folders asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1010
+ * Copies multiple folders asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
1011
1011
  */
1012
1012
  }, {
1013
1013
  key: "copyFolderBatch",
@@ -1033,7 +1033,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1033
1033
  }
1034
1034
  }
1035
1035
  /**
1036
- * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1036
+ * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1037
1037
  */
1038
1038
  }, {
1039
1039
  key: "deleteFolder",
@@ -1059,7 +1059,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1059
1059
  }
1060
1060
  }
1061
1061
  /**
1062
- * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1062
+ * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1063
1063
  */
1064
1064
  }, {
1065
1065
  key: "deleteFolderBatch",
@@ -1085,7 +1085,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1085
1085
  }
1086
1086
  }
1087
1087
  /**
1088
- * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder.
1088
+ * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1089
1089
  */
1090
1090
  }, {
1091
1091
  key: "getFolderDetails",
@@ -1112,7 +1112,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1112
1112
  }
1113
1113
  }
1114
1114
  /**
1115
- * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the ```cursor``` request parameter. Pagination is complete when the response includes `isPaginationComplete=true`.
1115
+ * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the next request. Pagination is complete when the response includes `isPaginationComplete=true`.
1116
1116
  */
1117
1117
  }, {
1118
1118
  key: "listFolder",
@@ -1163,7 +1163,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1163
1163
  }
1164
1164
  }
1165
1165
  /**
1166
- * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them.
1166
+ * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1167
1167
  */
1168
1168
  }, {
1169
1169
  key: "putFolder",
@@ -723,7 +723,7 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
723
723
  }
724
724
  }
725
725
  /**
726
- * Deletes a file synchronously.
726
+ * Deletes a file synchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
727
727
  */
728
728
  }, {
729
729
  key: "deleteFile",
@@ -750,7 +750,7 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
750
750
  }
751
751
  }
752
752
  /**
753
- * Deletes multiple files asynchronously.
753
+ * Deletes multiple files asynchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
754
754
  */
755
755
  }, {
756
756
  key: "deleteFileBatch",
@@ -968,7 +968,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
968
968
  key: "copyFolder",
969
969
  value:
970
970
  /**
971
- * Copies a folder asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
971
+ * Copies a folder asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
972
972
  */
973
973
  function copyFolder(params) {
974
974
  try {
@@ -992,7 +992,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
992
992
  }
993
993
  }
994
994
  /**
995
- * Copies multiple folders asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
995
+ * Copies multiple folders asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
996
996
  */
997
997
  }, {
998
998
  key: "copyFolderBatch",
@@ -1018,7 +1018,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1018
1018
  }
1019
1019
  }
1020
1020
  /**
1021
- * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1021
+ * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1022
1022
  */
1023
1023
  }, {
1024
1024
  key: "deleteFolder",
@@ -1044,7 +1044,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1044
1044
  }
1045
1045
  }
1046
1046
  /**
1047
- * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1047
+ * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1048
1048
  */
1049
1049
  }, {
1050
1050
  key: "deleteFolderBatch",
@@ -1070,7 +1070,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1070
1070
  }
1071
1071
  }
1072
1072
  /**
1073
- * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder.
1073
+ * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1074
1074
  */
1075
1075
  }, {
1076
1076
  key: "getFolderDetails",
@@ -1097,7 +1097,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1097
1097
  }
1098
1098
  }
1099
1099
  /**
1100
- * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the ```cursor``` request parameter. Pagination is complete when the response includes `isPaginationComplete=true`.
1100
+ * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the next request. Pagination is complete when the response includes `isPaginationComplete=true`.
1101
1101
  */
1102
1102
  }, {
1103
1103
  key: "listFolder",
@@ -1148,7 +1148,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1148
1148
  }
1149
1149
  }
1150
1150
  /**
1151
- * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them.
1151
+ * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1152
1152
  */
1153
1153
  }, {
1154
1154
  key: "putFolder",
@@ -738,7 +738,7 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
738
738
  }
739
739
  }
740
740
  /**
741
- * Deletes a file synchronously.
741
+ * Deletes a file synchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
742
742
  */
743
743
  }, {
744
744
  key: "deleteFile",
@@ -765,7 +765,7 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
765
765
  }
766
766
  }
767
767
  /**
768
- * Deletes multiple files asynchronously.
768
+ * Deletes multiple files asynchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
769
769
  */
770
770
  }, {
771
771
  key: "deleteFileBatch",
@@ -983,7 +983,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
983
983
  key: "copyFolder",
984
984
  value:
985
985
  /**
986
- * Copies a folder asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
986
+ * Copies a folder asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
987
987
  */
988
988
  function copyFolder(params) {
989
989
  try {
@@ -1007,7 +1007,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1007
1007
  }
1008
1008
  }
1009
1009
  /**
1010
- * Copies multiple folders asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1010
+ * Copies multiple folders asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
1011
1011
  */
1012
1012
  }, {
1013
1013
  key: "copyFolderBatch",
@@ -1033,7 +1033,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1033
1033
  }
1034
1034
  }
1035
1035
  /**
1036
- * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1036
+ * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1037
1037
  */
1038
1038
  }, {
1039
1039
  key: "deleteFolder",
@@ -1059,7 +1059,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1059
1059
  }
1060
1060
  }
1061
1061
  /**
1062
- * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1062
+ * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1063
1063
  */
1064
1064
  }, {
1065
1065
  key: "deleteFolderBatch",
@@ -1085,7 +1085,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1085
1085
  }
1086
1086
  }
1087
1087
  /**
1088
- * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder.
1088
+ * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1089
1089
  */
1090
1090
  }, {
1091
1091
  key: "getFolderDetails",
@@ -1112,7 +1112,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1112
1112
  }
1113
1113
  }
1114
1114
  /**
1115
- * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the ```cursor``` request parameter. Pagination is complete when the response includes `isPaginationComplete=true`.
1115
+ * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the next request. Pagination is complete when the response includes `isPaginationComplete=true`.
1116
1116
  */
1117
1117
  }, {
1118
1118
  key: "listFolder",
@@ -1163,7 +1163,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1163
1163
  }
1164
1164
  }
1165
1165
  /**
1166
- * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them.
1166
+ * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1167
1167
  */
1168
1168
  }, {
1169
1169
  key: "putFolder",
@@ -725,7 +725,7 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
725
725
  }
726
726
  }
727
727
  /**
728
- * Deletes a file synchronously.
728
+ * Deletes a file synchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
729
729
  */
730
730
  }, {
731
731
  key: "deleteFile",
@@ -752,7 +752,7 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
752
752
  }
753
753
  }
754
754
  /**
755
- * Deletes multiple files asynchronously.
755
+ * Deletes multiple files asynchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
756
756
  */
757
757
  }, {
758
758
  key: "deleteFileBatch",
@@ -970,7 +970,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
970
970
  key: "copyFolder",
971
971
  value:
972
972
  /**
973
- * Copies a folder asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
973
+ * Copies a folder asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
974
974
  */
975
975
  function copyFolder(params) {
976
976
  try {
@@ -994,7 +994,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
994
994
  }
995
995
  }
996
996
  /**
997
- * Copies multiple folders asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
997
+ * Copies multiple folders asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
998
998
  */
999
999
  }, {
1000
1000
  key: "copyFolderBatch",
@@ -1020,7 +1020,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1020
1020
  }
1021
1021
  }
1022
1022
  /**
1023
- * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1023
+ * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1024
1024
  */
1025
1025
  }, {
1026
1026
  key: "deleteFolder",
@@ -1046,7 +1046,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1046
1046
  }
1047
1047
  }
1048
1048
  /**
1049
- * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1049
+ * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1050
1050
  */
1051
1051
  }, {
1052
1052
  key: "deleteFolderBatch",
@@ -1072,7 +1072,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1072
1072
  }
1073
1073
  }
1074
1074
  /**
1075
- * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder.
1075
+ * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1076
1076
  */
1077
1077
  }, {
1078
1078
  key: "getFolderDetails",
@@ -1099,7 +1099,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1099
1099
  }
1100
1100
  }
1101
1101
  /**
1102
- * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the ```cursor``` request parameter. Pagination is complete when the response includes `isPaginationComplete=true`.
1102
+ * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the next request. Pagination is complete when the response includes `isPaginationComplete=true`.
1103
1103
  */
1104
1104
  }, {
1105
1105
  key: "listFolder",
@@ -1150,7 +1150,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1150
1150
  }
1151
1151
  }
1152
1152
  /**
1153
- * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them.
1153
+ * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1154
1154
  */
1155
1155
  }, {
1156
1156
  key: "putFolder",
@@ -163,11 +163,11 @@ export declare class FileApi extends runtime.BaseAPI {
163
163
  */
164
164
  copyFileBatch(params: CopyFileBatchOperationParams): Promise<AsyncResponse>;
165
165
  /**
166
- * Deletes a file synchronously.
166
+ * Deletes a file synchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
167
167
  */
168
168
  deleteFile(params: DeleteFileParams): Promise<void>;
169
169
  /**
170
- * Deletes multiple files asynchronously.
170
+ * Deletes multiple files asynchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
171
171
  */
172
172
  deleteFileBatch(params: DeleteFileBatchOperationParams): Promise<AsyncResponse>;
173
173
  /**
@@ -49,31 +49,31 @@ export interface PutFolderOperationParams {
49
49
  }
50
50
  export declare class FolderApi extends runtime.BaseAPI {
51
51
  /**
52
- * Copies a folder asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
52
+ * Copies a folder asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
53
53
  */
54
54
  copyFolder(params: CopyFolderOperationParams): Promise<AsyncResponse>;
55
55
  /**
56
- * Copies multiple folders asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
56
+ * Copies multiple folders asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
57
57
  */
58
58
  copyFolderBatch(params: CopyFolderBatchOperationParams): Promise<AsyncResponse>;
59
59
  /**
60
- * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
60
+ * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
61
61
  */
62
62
  deleteFolder(params: DeleteFolderOperationParams): Promise<AsyncResponse>;
63
63
  /**
64
- * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
64
+ * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
65
65
  */
66
66
  deleteFolderBatch(params: DeleteFolderBatchOperationParams): Promise<AsyncResponse>;
67
67
  /**
68
- * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder.
68
+ * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
69
69
  */
70
70
  getFolderDetails(params: GetFolderDetailsParams): Promise<FolderDetails>;
71
71
  /**
72
- * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the ```cursor``` request parameter. Pagination is complete when the response includes `isPaginationComplete=true`.
72
+ * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the next request. Pagination is complete when the response includes `isPaginationComplete=true`.
73
73
  */
74
74
  listFolder(params: ListFolderParams): Promise<ListFolderResponse>;
75
75
  /**
76
- * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them.
76
+ * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
77
77
  */
78
78
  putFolder(params: PutFolderOperationParams): Promise<FolderDetails>;
79
79
  }
@@ -7,7 +7,7 @@ export declare type AccountJobStatus = "Created" | "Pending" | "Running" | "Roll
7
7
  * Job type.
8
8
  * @export
9
9
  */
10
- export declare type AccountJobType = "ProcessFileJob" | "DeleteFolderBatchJob" | "DeleteFileBatchJob" | "CopyFolderBatchJob" | "CopyFileBatchJob";
10
+ export declare type AccountJobType = "ProcessVideoJob" | "ProcessAudioJob" | "AntivirusJob" | "DeleteFolderBatchJob" | "DeleteFileBatchJob" | "CopyFolderBatchJob" | "CopyFileBatchJob";
11
11
  /**
12
12
  * Response body from an API endpoint that performs work asynchronously (i.e. does not complete the work immediately).
13
13
  * @export
@@ -212,12 +212,6 @@ export interface CopyFileBatchRequest {
212
212
  * @interface CopyFileRequest
213
213
  */
214
214
  export interface CopyFileRequest {
215
- /**
216
- *
217
- * @type {TagCondition}
218
- * @memberof CopyFileRequest
219
- */
220
- condition?: TagCondition;
221
215
  /**
222
216
  * Absolute path to a file. Begins with a `/`.
223
217
  * @type {string}
@@ -263,12 +257,6 @@ export interface CopyFolderBatchRequest {
263
257
  * @interface CopyFolderRequest
264
258
  */
265
259
  export interface CopyFolderRequest {
266
- /**
267
- *
268
- * @type {TagCondition}
269
- * @memberof CopyFolderRequest
270
- */
271
- condition?: TagCondition;
272
260
  /**
273
261
  * If `true` then copies files.
274
262
  *
@@ -278,7 +266,13 @@ export interface CopyFolderRequest {
278
266
  */
279
267
  copyFiles?: boolean;
280
268
  /**
281
- * If `true` then copies files from folders that have overridden storage settings, else skips them. The current folder is treated the same: if it has overridden storage settings, then its files will only be copied if this flag is `true`, else they will be skipped.
269
+ * If `true` then copies files from folders that have overridden storage settings, else skips them.
270
+ *
271
+ * If the `source` folder overrides its storage settings, then its files will only be copied if this flag is `true`.
272
+ *
273
+ * If the `source` folder inherits its storage settings, then its files will be copied regardless of this flag.
274
+ *
275
+ * In all cases, files will only be copied if `copyFiles` is also set to `true`.
282
276
  *
283
277
  * You can ignore this setting if your account does not use folders with overridden storage settings, such as custom AWS S3 buckets.
284
278
  *
@@ -417,7 +411,7 @@ export interface DeleteFolderBatchRequest {
417
411
  *
418
412
  * If the folder has overridden storage settings, then no files will be deleted.
419
413
  *
420
- * You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you're using here. Leave all other flags unset.
414
+ * You can use ListFolder to preview the operation using the `dryRun` parameter.
421
415
  * @export
422
416
  * @interface DeleteFolderRequest
423
417
  */
@@ -579,7 +573,7 @@ export interface DynamicFilePath {
579
573
  folderPathVariablesEnabled?: boolean;
580
574
  }
581
575
  /**
582
- * Response body for all error responses.
576
+ * Response body for client-side and server-side errors.
583
577
  * @export
584
578
  * @interface ErrorResponse
585
579
  */
@@ -1882,162 +1876,6 @@ export declare type StorageLayerSummary = InternalStorageV1 | InternalStorageV2
1882
1876
  * @export
1883
1877
  */
1884
1878
  export declare type StorageLayerUpdate = DigitalOceanStorage | GoogleStorage | InternalStorageV2 | R2Storage | S3Storage | WebStorage;
1885
- /**
1886
- * @type TagCondition
1887
- * Expresses a condition that matches files by their tags.
1888
- * @export
1889
- */
1890
- export declare type TagCondition = TagConditionAll | TagConditionAnd | TagConditionAny | TagConditionEquals | TagConditionNot | TagConditionOr;
1891
- /**
1892
- *
1893
- * @export
1894
- * @interface TagConditionAll
1895
- */
1896
- export interface TagConditionAll {
1897
- /**
1898
- *
1899
- * @type {Array<string>}
1900
- * @memberof TagConditionAll
1901
- */
1902
- all: Array<string>;
1903
- /**
1904
- *
1905
- * @type {string}
1906
- * @memberof TagConditionAll
1907
- */
1908
- type: TagConditionAllTypeEnum;
1909
- }
1910
- /**
1911
- * @export
1912
- */
1913
- export declare type TagConditionAllTypeEnum = "All";
1914
- /**
1915
- *
1916
- * @export
1917
- * @interface TagConditionAnd
1918
- */
1919
- export interface TagConditionAnd {
1920
- /**
1921
- *
1922
- * @type {TagCondition}
1923
- * @memberof TagConditionAnd
1924
- */
1925
- left: TagCondition;
1926
- /**
1927
- *
1928
- * @type {TagCondition}
1929
- * @memberof TagConditionAnd
1930
- */
1931
- right: TagCondition;
1932
- /**
1933
- *
1934
- * @type {string}
1935
- * @memberof TagConditionAnd
1936
- */
1937
- type: TagConditionAndTypeEnum;
1938
- }
1939
- /**
1940
- * @export
1941
- */
1942
- export declare type TagConditionAndTypeEnum = "And";
1943
- /**
1944
- *
1945
- * @export
1946
- * @interface TagConditionAny
1947
- */
1948
- export interface TagConditionAny {
1949
- /**
1950
- *
1951
- * @type {Array<string>}
1952
- * @memberof TagConditionAny
1953
- */
1954
- any: Array<string>;
1955
- /**
1956
- *
1957
- * @type {string}
1958
- * @memberof TagConditionAny
1959
- */
1960
- type: TagConditionAnyTypeEnum;
1961
- }
1962
- /**
1963
- * @export
1964
- */
1965
- export declare type TagConditionAnyTypeEnum = "Any";
1966
- /**
1967
- *
1968
- * @export
1969
- * @interface TagConditionEquals
1970
- */
1971
- export interface TagConditionEquals {
1972
- /**
1973
- * File tag scope, e.g. for a transformation definition, a CDN download access token, or an API key's tag whitelist.
1974
- * @type {string}
1975
- * @memberof TagConditionEquals
1976
- */
1977
- equals: string;
1978
- /**
1979
- *
1980
- * @type {string}
1981
- * @memberof TagConditionEquals
1982
- */
1983
- type: TagConditionEqualsTypeEnum;
1984
- }
1985
- /**
1986
- * @export
1987
- */
1988
- export declare type TagConditionEqualsTypeEnum = "Equals";
1989
- /**
1990
- *
1991
- * @export
1992
- * @interface TagConditionNot
1993
- */
1994
- export interface TagConditionNot {
1995
- /**
1996
- *
1997
- * @type {TagCondition}
1998
- * @memberof TagConditionNot
1999
- */
2000
- condition: TagCondition;
2001
- /**
2002
- *
2003
- * @type {string}
2004
- * @memberof TagConditionNot
2005
- */
2006
- type: TagConditionNotTypeEnum;
2007
- }
2008
- /**
2009
- * @export
2010
- */
2011
- export declare type TagConditionNotTypeEnum = "Not";
2012
- /**
2013
- *
2014
- * @export
2015
- * @interface TagConditionOr
2016
- */
2017
- export interface TagConditionOr {
2018
- /**
2019
- *
2020
- * @type {TagCondition}
2021
- * @memberof TagConditionOr
2022
- */
2023
- left: TagCondition;
2024
- /**
2025
- *
2026
- * @type {TagCondition}
2027
- * @memberof TagConditionOr
2028
- */
2029
- right: TagCondition;
2030
- /**
2031
- *
2032
- * @type {string}
2033
- * @memberof TagConditionOr
2034
- */
2035
- type: TagConditionOrTypeEnum;
2036
- }
2037
- /**
2038
- * @export
2039
- */
2040
- export declare type TagConditionOrTypeEnum = "Or";
2041
1879
  /**
2042
1880
  * This data type specifies no update is to be performed.
2043
1881
  * @export
@@ -738,7 +738,7 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
738
738
  }
739
739
  }
740
740
  /**
741
- * Deletes a file synchronously.
741
+ * Deletes a file synchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
742
742
  */
743
743
  }, {
744
744
  key: "deleteFile",
@@ -765,7 +765,7 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
765
765
  }
766
766
  }
767
767
  /**
768
- * Deletes multiple files asynchronously.
768
+ * Deletes multiple files asynchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
769
769
  */
770
770
  }, {
771
771
  key: "deleteFileBatch",
@@ -983,7 +983,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
983
983
  key: "copyFolder",
984
984
  value:
985
985
  /**
986
- * Copies a folder asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
986
+ * Copies a folder asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
987
987
  */
988
988
  function copyFolder(params) {
989
989
  try {
@@ -1007,7 +1007,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1007
1007
  }
1008
1008
  }
1009
1009
  /**
1010
- * Copies multiple folders asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1010
+ * Copies multiple folders asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
1011
1011
  */
1012
1012
  }, {
1013
1013
  key: "copyFolderBatch",
@@ -1033,7 +1033,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1033
1033
  }
1034
1034
  }
1035
1035
  /**
1036
- * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1036
+ * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1037
1037
  */
1038
1038
  }, {
1039
1039
  key: "deleteFolder",
@@ -1059,7 +1059,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1059
1059
  }
1060
1060
  }
1061
1061
  /**
1062
- * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1062
+ * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1063
1063
  */
1064
1064
  }, {
1065
1065
  key: "deleteFolderBatch",
@@ -1085,7 +1085,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1085
1085
  }
1086
1086
  }
1087
1087
  /**
1088
- * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder.
1088
+ * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1089
1089
  */
1090
1090
  }, {
1091
1091
  key: "getFolderDetails",
@@ -1112,7 +1112,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1112
1112
  }
1113
1113
  }
1114
1114
  /**
1115
- * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the ```cursor``` request parameter. Pagination is complete when the response includes `isPaginationComplete=true`.
1115
+ * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the next request. Pagination is complete when the response includes `isPaginationComplete=true`.
1116
1116
  */
1117
1117
  }, {
1118
1118
  key: "listFolder",
@@ -1163,7 +1163,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1163
1163
  }
1164
1164
  }
1165
1165
  /**
1166
- * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them.
1166
+ * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1167
1167
  */
1168
1168
  }, {
1169
1169
  key: "putFolder",
@@ -723,7 +723,7 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
723
723
  }
724
724
  }
725
725
  /**
726
- * Deletes a file synchronously.
726
+ * Deletes a file synchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
727
727
  */
728
728
  }, {
729
729
  key: "deleteFile",
@@ -750,7 +750,7 @@ var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
750
750
  }
751
751
  }
752
752
  /**
753
- * Deletes multiple files asynchronously.
753
+ * Deletes multiple files asynchronously. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
754
754
  */
755
755
  }, {
756
756
  key: "deleteFileBatch",
@@ -968,7 +968,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
968
968
  key: "copyFolder",
969
969
  value:
970
970
  /**
971
- * Copies a folder asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
971
+ * Copies a folder asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
972
972
  */
973
973
  function copyFolder(params) {
974
974
  try {
@@ -992,7 +992,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
992
992
  }
993
993
  }
994
994
  /**
995
- * Copies multiple folders asynchronously. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
995
+ * Copies multiple folders asynchronously. You can use ListFolder to preview the operation using the `dryRun` parameter.
996
996
  */
997
997
  }, {
998
998
  key: "copyFolderBatch",
@@ -1018,7 +1018,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1018
1018
  }
1019
1019
  }
1020
1020
  /**
1021
- * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1021
+ * Deletes a folder asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1022
1022
  */
1023
1023
  }, {
1024
1024
  key: "deleteFolder",
@@ -1044,7 +1044,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1044
1044
  }
1045
1045
  }
1046
1046
  /**
1047
- * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
1047
+ * Deletes multiple folders asynchronously. If the folder has overridden storage settings, then no files will be deleted. You can use ListFolder to preview the operation using the `dryRun` parameter. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1048
1048
  */
1049
1049
  }, {
1050
1050
  key: "deleteFolderBatch",
@@ -1070,7 +1070,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1070
1070
  }
1071
1071
  }
1072
1072
  /**
1073
- * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder.
1073
+ * Gets the full details (e.g. permission, storage layer, etc.) for a folder. Returns an empty object if no settings have been configured for this folder. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1074
1074
  */
1075
1075
  }, {
1076
1076
  key: "getFolderDetails",
@@ -1097,7 +1097,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1097
1097
  }
1098
1098
  }
1099
1099
  /**
1100
- * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the ```cursor``` request parameter. Pagination is complete when the response includes `isPaginationComplete=true`.
1100
+ * Lists the folder\'s contents. The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the next request. Pagination is complete when the response includes `isPaginationComplete=true`.
1101
1101
  */
1102
1102
  }, {
1103
1103
  key: "listFolder",
@@ -1148,7 +1148,7 @@ var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
1148
1148
  }
1149
1149
  }
1150
1150
  /**
1151
- * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them.
1151
+ * Creates or updates the folder specified by the `folderPath`. If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings). Note: you don\'t need to create folders before uploading files to them. Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
1152
1152
  */
1153
1153
  }, {
1154
1154
  key: "putFolder",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bytescale/sdk",
3
- "version": "3.21.6",
3
+ "version": "3.22.0",
4
4
  "description": "Bytescale JavaScript SDK",
5
5
  "author": "Bytescale <hello@bytescale.com> (https://www.bytescale.com)",
6
6
  "license": "MIT",