frameio 4.2.2 → 4.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/Client.d.ts +30 -30
  3. package/dist/cjs/Client.js +38 -38
  4. package/dist/cjs/api/resources/collections/client/Client.d.ts +17 -17
  5. package/dist/cjs/api/resources/collections/client/Client.js +30 -30
  6. package/dist/cjs/api/resources/files/client/Client.d.ts +96 -96
  7. package/dist/cjs/api/resources/files/client/Client.js +175 -175
  8. package/dist/cjs/api/resources/folders/client/Client.d.ts +11 -11
  9. package/dist/cjs/api/resources/folders/client/Client.js +29 -29
  10. package/dist/cjs/api/resources/metadata/client/Client.d.ts +27 -27
  11. package/dist/cjs/api/resources/metadata/client/Client.js +50 -50
  12. package/dist/cjs/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.ts +4 -4
  13. package/dist/cjs/api/resources/projectPermissions/client/Client.d.ts +24 -24
  14. package/dist/cjs/api/resources/projectPermissions/client/Client.js +87 -87
  15. package/dist/cjs/api/resources/projects/client/Client.d.ts +56 -0
  16. package/dist/cjs/api/resources/projects/client/Client.js +166 -0
  17. package/dist/cjs/api/resources/projects/client/requests/AccountProjectsIndexRequest.d.ts +24 -0
  18. package/dist/cjs/api/resources/projects/client/requests/AccountProjectsIndexRequest.js +3 -0
  19. package/dist/cjs/api/resources/projects/client/requests/InvitedProjectsIndexRequest.d.ts +24 -0
  20. package/dist/cjs/api/resources/projects/client/requests/InvitedProjectsIndexRequest.js +3 -0
  21. package/dist/cjs/api/resources/projects/client/requests/index.d.ts +2 -0
  22. package/dist/cjs/api/resources/projects/types/AccountProjectsIndexRequestSort.d.ts +8 -0
  23. package/dist/cjs/api/resources/projects/types/AccountProjectsIndexRequestSort.js +11 -0
  24. package/dist/cjs/api/resources/projects/types/InvitedProjectsIndexRequestSort.d.ts +8 -0
  25. package/dist/cjs/api/resources/projects/types/InvitedProjectsIndexRequestSort.js +11 -0
  26. package/dist/cjs/api/resources/projects/types/index.d.ts +2 -0
  27. package/dist/cjs/api/resources/projects/types/index.js +2 -0
  28. package/dist/cjs/api/resources/shares/client/Client.d.ts +49 -49
  29. package/dist/cjs/api/resources/shares/client/Client.js +146 -146
  30. package/dist/cjs/api/resources/shares/client/requests/AddAssetParams.d.ts +1 -1
  31. package/dist/cjs/api/resources/shares/client/requests/CreateShareParams.d.ts +2 -2
  32. package/dist/cjs/api/resources/shares/client/requests/UpdateShareParams.d.ts +1 -1
  33. package/dist/cjs/api/resources/versionStacks/client/Client.d.ts +64 -64
  34. package/dist/cjs/api/resources/versionStacks/client/Client.js +121 -121
  35. package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.ts +1 -1
  36. package/dist/cjs/api/resources/workspacePermissions/client/Client.d.ts +24 -24
  37. package/dist/cjs/api/resources/workspacePermissions/client/Client.js +87 -87
  38. package/dist/cjs/api/resources/workspaces/client/Client.d.ts +34 -34
  39. package/dist/cjs/api/resources/workspaces/client/Client.js +141 -141
  40. package/dist/cjs/api/types/AuditLogwithIncludes.d.ts +6 -0
  41. package/dist/cjs/api/types/AuditLogwithIncludes.js +6 -0
  42. package/dist/cjs/api/types/Filters.d.ts +6 -0
  43. package/dist/cjs/api/types/Filters.js +6 -0
  44. package/dist/cjs/api/types/LongTextDefinition.d.ts +0 -16
  45. package/dist/cjs/api/types/LongTextDefinition.js +0 -17
  46. package/dist/cjs/api/types/NumberDefinition.d.ts +16 -0
  47. package/dist/cjs/api/types/NumberDefinition.js +13 -0
  48. package/dist/cjs/api/types/TextDefinition.d.ts +0 -16
  49. package/dist/cjs/api/types/TextDefinition.js +0 -17
  50. package/dist/cjs/api/types/ToggleDefinition.d.ts +16 -0
  51. package/dist/cjs/api/types/ToggleDefinition.js +17 -0
  52. package/dist/cjs/api/types/UserSingleDefinition.d.ts +0 -16
  53. package/dist/cjs/api/types/UserSingleDefinition.js +0 -13
  54. package/dist/cjs/version.d.ts +1 -1
  55. package/dist/cjs/version.js +1 -1
  56. package/dist/esm/BaseClient.mjs +2 -2
  57. package/dist/esm/Client.d.mts +30 -30
  58. package/dist/esm/Client.mjs +38 -38
  59. package/dist/esm/api/resources/collections/client/Client.d.mts +17 -17
  60. package/dist/esm/api/resources/collections/client/Client.mjs +30 -30
  61. package/dist/esm/api/resources/files/client/Client.d.mts +96 -96
  62. package/dist/esm/api/resources/files/client/Client.mjs +175 -175
  63. package/dist/esm/api/resources/folders/client/Client.d.mts +11 -11
  64. package/dist/esm/api/resources/folders/client/Client.mjs +29 -29
  65. package/dist/esm/api/resources/metadata/client/Client.d.mts +27 -27
  66. package/dist/esm/api/resources/metadata/client/Client.mjs +50 -50
  67. package/dist/esm/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.mts +4 -4
  68. package/dist/esm/api/resources/projectPermissions/client/Client.d.mts +24 -24
  69. package/dist/esm/api/resources/projectPermissions/client/Client.mjs +87 -87
  70. package/dist/esm/api/resources/projects/client/Client.d.mts +56 -0
  71. package/dist/esm/api/resources/projects/client/Client.mjs +166 -0
  72. package/dist/esm/api/resources/projects/client/requests/AccountProjectsIndexRequest.d.mts +24 -0
  73. package/dist/esm/api/resources/projects/client/requests/AccountProjectsIndexRequest.mjs +2 -0
  74. package/dist/esm/api/resources/projects/client/requests/InvitedProjectsIndexRequest.d.mts +24 -0
  75. package/dist/esm/api/resources/projects/client/requests/InvitedProjectsIndexRequest.mjs +2 -0
  76. package/dist/esm/api/resources/projects/client/requests/index.d.mts +2 -0
  77. package/dist/esm/api/resources/projects/types/AccountProjectsIndexRequestSort.d.mts +8 -0
  78. package/dist/esm/api/resources/projects/types/AccountProjectsIndexRequestSort.mjs +8 -0
  79. package/dist/esm/api/resources/projects/types/InvitedProjectsIndexRequestSort.d.mts +8 -0
  80. package/dist/esm/api/resources/projects/types/InvitedProjectsIndexRequestSort.mjs +8 -0
  81. package/dist/esm/api/resources/projects/types/index.d.mts +2 -0
  82. package/dist/esm/api/resources/projects/types/index.mjs +2 -0
  83. package/dist/esm/api/resources/shares/client/Client.d.mts +49 -49
  84. package/dist/esm/api/resources/shares/client/Client.mjs +146 -146
  85. package/dist/esm/api/resources/shares/client/requests/AddAssetParams.d.mts +1 -1
  86. package/dist/esm/api/resources/shares/client/requests/CreateShareParams.d.mts +2 -2
  87. package/dist/esm/api/resources/shares/client/requests/UpdateShareParams.d.mts +1 -1
  88. package/dist/esm/api/resources/versionStacks/client/Client.d.mts +64 -64
  89. package/dist/esm/api/resources/versionStacks/client/Client.mjs +121 -121
  90. package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.mts +1 -1
  91. package/dist/esm/api/resources/workspacePermissions/client/Client.d.mts +24 -24
  92. package/dist/esm/api/resources/workspacePermissions/client/Client.mjs +87 -87
  93. package/dist/esm/api/resources/workspaces/client/Client.d.mts +34 -34
  94. package/dist/esm/api/resources/workspaces/client/Client.mjs +141 -141
  95. package/dist/esm/api/types/AuditLogwithIncludes.d.mts +6 -0
  96. package/dist/esm/api/types/AuditLogwithIncludes.mjs +6 -0
  97. package/dist/esm/api/types/Filters.d.mts +6 -0
  98. package/dist/esm/api/types/Filters.mjs +6 -0
  99. package/dist/esm/api/types/LongTextDefinition.d.mts +0 -16
  100. package/dist/esm/api/types/LongTextDefinition.mjs +1 -16
  101. package/dist/esm/api/types/NumberDefinition.d.mts +16 -0
  102. package/dist/esm/api/types/NumberDefinition.mjs +13 -0
  103. package/dist/esm/api/types/TextDefinition.d.mts +0 -16
  104. package/dist/esm/api/types/TextDefinition.mjs +1 -16
  105. package/dist/esm/api/types/ToggleDefinition.d.mts +16 -0
  106. package/dist/esm/api/types/ToggleDefinition.mjs +16 -1
  107. package/dist/esm/api/types/UserSingleDefinition.d.mts +0 -16
  108. package/dist/esm/api/types/UserSingleDefinition.mjs +0 -13
  109. package/dist/esm/version.d.mts +1 -1
  110. package/dist/esm/version.mjs +1 -1
  111. package/package.json +112 -112
  112. package/reference.md +1392 -1234
@@ -70,23 +70,11 @@ class VersionStacksClient {
70
70
  this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
71
71
  }
72
72
  /**
73
- * List the children (files) in a given version stack.
74
- * <br/>
75
- * Use the `include` query parameter to selectively include additional properties in the response.
76
- * <br/>
77
- * Note: if you include `media_links.original` and the user does not have permission to download files
78
- * in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
79
- * If the content is inaccessible because watermarking is required for this user and isn't supported by
80
- * the requested media_links, then the request will succeed but the unsupported media links will be set to null.
81
- * Similarly, if a requested transcode link does not exist for a particular file (e.g. including
82
- * `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
83
- * (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
84
- * null in the response payload. In short, the client must handle null media links gracefully.
85
- * <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
73
+ * Move version stack to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
86
74
  *
87
75
  * @param {Frameio.FrameOrAdobeId} account_id
88
76
  * @param {Frameio.FrameOrAdobeId} version_stack_id
89
- * @param {Frameio.VersionStacksIndexRequest} request
77
+ * @param {Frameio.VersionStackMoveParams} request
90
78
  * @param {VersionStacksClient.RequestOptions} requestOptions - Request-specific configuration.
91
79
  *
92
80
  * @throws {@link Frameio.BadRequestError}
@@ -98,33 +86,28 @@ class VersionStacksClient {
98
86
  * @throws {@link Frameio.TooManyRequestsError}
99
87
  *
100
88
  * @example
101
- * await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
102
- * include: "media_links.original",
103
- * after: "<opaque_cursor>",
104
- * page_size: 10,
105
- * include_total_count: false
89
+ * await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
90
+ * data: {
91
+ * parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
92
+ * }
106
93
  * })
107
94
  */
108
- index(account_id, version_stack_id, request = {}, requestOptions) {
109
- return core.HttpResponsePromise.fromPromise(this.__index(account_id, version_stack_id, request, requestOptions));
95
+ move(account_id, version_stack_id, request, requestOptions) {
96
+ return core.HttpResponsePromise.fromPromise(this.__move(account_id, version_stack_id, request, requestOptions));
110
97
  }
111
- __index(account_id_1, version_stack_id_1) {
112
- return __awaiter(this, arguments, void 0, function* (account_id, version_stack_id, request = {}, requestOptions) {
98
+ __move(account_id, version_stack_id, request, requestOptions) {
99
+ return __awaiter(this, void 0, void 0, function* () {
113
100
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
114
- const { include, after, page_size: pageSize, include_total_count: includeTotalCount } = request;
115
- const _queryParams = {
116
- include: include != null ? include : undefined,
117
- after,
118
- page_size: pageSize,
119
- include_total_count: includeTotalCount,
120
- };
121
101
  const _authRequest = yield this._options.authProvider.getAuthRequest();
122
102
  const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
123
103
  const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
124
- url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/version_stacks/${core.url.encodePathParam(version_stack_id)}/children`),
125
- method: "GET",
104
+ url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/version_stacks/${core.url.encodePathParam(version_stack_id)}/move`),
105
+ method: "PATCH",
126
106
  headers: _headers,
127
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
107
+ contentType: "application/json",
108
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
109
+ requestType: "json",
110
+ body: request,
128
111
  timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
129
112
  maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
130
113
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -132,10 +115,7 @@ class VersionStacksClient {
132
115
  logging: this._options.logging,
133
116
  });
134
117
  if (_response.ok) {
135
- return {
136
- data: _response.body,
137
- rawResponse: _response.rawResponse,
138
- };
118
+ return { data: _response.body, rawResponse: _response.rawResponse };
139
119
  }
140
120
  if (_response.error.reason === "status-code") {
141
121
  switch (_response.error.statusCode) {
@@ -161,15 +141,15 @@ class VersionStacksClient {
161
141
  });
162
142
  }
163
143
  }
164
- return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/version_stacks/{version_stack_id}/children");
144
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/v4/accounts/{account_id}/version_stacks/{version_stack_id}/move");
165
145
  });
166
146
  }
167
147
  /**
168
- * Show version stack details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
148
+ * List version stacks in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
169
149
  *
170
150
  * @param {Frameio.FrameOrAdobeId} account_id
171
- * @param {Frameio.FrameOrAdobeId} version_stack_id
172
- * @param {Frameio.VersionStacksShowRequest} request
151
+ * @param {Frameio.FrameOrAdobeId} folder_id
152
+ * @param {Frameio.VersionStacksListRequest} request
173
153
  * @param {VersionStacksClient.RequestOptions} requestOptions - Request-specific configuration.
174
154
  *
175
155
  * @throws {@link Frameio.BadRequestError}
@@ -181,24 +161,30 @@ class VersionStacksClient {
181
161
  * @throws {@link Frameio.TooManyRequestsError}
182
162
  *
183
163
  * @example
184
- * await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
185
- * include: "media_links.original"
164
+ * await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
165
+ * include: "media_links.original",
166
+ * after: "<opaque_cursor>",
167
+ * page_size: 10,
168
+ * include_total_count: false
186
169
  * })
187
170
  */
188
- show(account_id, version_stack_id, request = {}, requestOptions) {
189
- return core.HttpResponsePromise.fromPromise(this.__show(account_id, version_stack_id, request, requestOptions));
171
+ list(account_id, folder_id, request = {}, requestOptions) {
172
+ return core.HttpResponsePromise.fromPromise(this.__list(account_id, folder_id, request, requestOptions));
190
173
  }
191
- __show(account_id_1, version_stack_id_1) {
192
- return __awaiter(this, arguments, void 0, function* (account_id, version_stack_id, request = {}, requestOptions) {
174
+ __list(account_id_1, folder_id_1) {
175
+ return __awaiter(this, arguments, void 0, function* (account_id, folder_id, request = {}, requestOptions) {
193
176
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
194
- const { include } = request;
177
+ const { include, after, page_size: pageSize, include_total_count: includeTotalCount } = request;
195
178
  const _queryParams = {
196
179
  include: include != null ? include : undefined,
180
+ after,
181
+ page_size: pageSize,
182
+ include_total_count: includeTotalCount,
197
183
  };
198
184
  const _authRequest = yield this._options.authProvider.getAuthRequest();
199
185
  const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
200
186
  const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
201
- url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/version_stacks/${core.url.encodePathParam(version_stack_id)}`),
187
+ url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/version_stacks`),
202
188
  method: "GET",
203
189
  headers: _headers,
204
190
  queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
@@ -238,19 +224,15 @@ class VersionStacksClient {
238
224
  });
239
225
  }
240
226
  }
241
- return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/version_stacks/{version_stack_id}");
227
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/folders/{folder_id}/version_stacks");
242
228
  });
243
229
  }
244
230
  /**
245
- * Copy version stack. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user<br><br>
246
- *
247
- * Currently, copying version stacks between Adobe storage backed projects is not supported. Copying individual
248
- * files within a version stack and then restacking them is currently the supported method for copying version
249
- * stacks for these projects.
231
+ * Create a new Version Stack under the parent folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
250
232
  *
251
233
  * @param {Frameio.FrameOrAdobeId} account_id
252
- * @param {Frameio.FrameOrAdobeId} version_stack_id
253
- * @param {Frameio.VersionStackCopyParams} request
234
+ * @param {Frameio.FrameOrAdobeId} folder_id
235
+ * @param {Frameio.VersionStackCreateParams} request
254
236
  * @param {VersionStacksClient.RequestOptions} requestOptions - Request-specific configuration.
255
237
  *
256
238
  * @throws {@link Frameio.BadRequestError}
@@ -262,33 +244,28 @@ class VersionStacksClient {
262
244
  * @throws {@link Frameio.TooManyRequestsError}
263
245
  *
264
246
  * @example
265
- * await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
266
- * copy_metadata: true,
247
+ * await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
267
248
  * data: {
268
- * parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
249
+ * file_ids: ["74849eb1-eb41-4ad9-98f5-bc91b59db044", "07edec4a-c8bb-479b-8dba-10f921b60746"]
269
250
  * }
270
251
  * })
271
252
  */
272
- copy(account_id, version_stack_id, request = {}, requestOptions) {
273
- return core.HttpResponsePromise.fromPromise(this.__copy(account_id, version_stack_id, request, requestOptions));
253
+ create(account_id, folder_id, request, requestOptions) {
254
+ return core.HttpResponsePromise.fromPromise(this.__create(account_id, folder_id, request, requestOptions));
274
255
  }
275
- __copy(account_id_1, version_stack_id_1) {
276
- return __awaiter(this, arguments, void 0, function* (account_id, version_stack_id, request = {}, requestOptions) {
256
+ __create(account_id, folder_id, request, requestOptions) {
257
+ return __awaiter(this, void 0, void 0, function* () {
277
258
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
278
- const { copy_metadata: copyMetadata } = request, _body = __rest(request, ["copy_metadata"]);
279
- const _queryParams = {
280
- copy_metadata: copyMetadata,
281
- };
282
259
  const _authRequest = yield this._options.authProvider.getAuthRequest();
283
260
  const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
284
261
  const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
285
- url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/version_stacks/${core.url.encodePathParam(version_stack_id)}/copy`),
262
+ url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/version_stacks`),
286
263
  method: "POST",
287
264
  headers: _headers,
288
265
  contentType: "application/json",
289
- queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
266
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
290
267
  requestType: "json",
291
- body: _body,
268
+ body: request,
292
269
  timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
293
270
  maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
294
271
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -296,7 +273,10 @@ class VersionStacksClient {
296
273
  logging: this._options.logging,
297
274
  });
298
275
  if (_response.ok) {
299
- return { data: _response.body, rawResponse: _response.rawResponse };
276
+ return {
277
+ data: _response.body,
278
+ rawResponse: _response.rawResponse,
279
+ };
300
280
  }
301
281
  if (_response.error.reason === "status-code") {
302
282
  switch (_response.error.statusCode) {
@@ -322,15 +302,15 @@ class VersionStacksClient {
322
302
  });
323
303
  }
324
304
  }
325
- return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/version_stacks/{version_stack_id}/copy");
305
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/version_stacks");
326
306
  });
327
307
  }
328
308
  /**
329
- * List version stacks in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
309
+ * Show version stack details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
330
310
  *
331
311
  * @param {Frameio.FrameOrAdobeId} account_id
332
- * @param {Frameio.FrameOrAdobeId} folder_id
333
- * @param {Frameio.VersionStacksListRequest} request
312
+ * @param {Frameio.FrameOrAdobeId} version_stack_id
313
+ * @param {Frameio.VersionStacksShowRequest} request
334
314
  * @param {VersionStacksClient.RequestOptions} requestOptions - Request-specific configuration.
335
315
  *
336
316
  * @throws {@link Frameio.BadRequestError}
@@ -342,30 +322,24 @@ class VersionStacksClient {
342
322
  * @throws {@link Frameio.TooManyRequestsError}
343
323
  *
344
324
  * @example
345
- * await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
346
- * include: "media_links.original",
347
- * after: "<opaque_cursor>",
348
- * page_size: 10,
349
- * include_total_count: false
325
+ * await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
326
+ * include: "media_links.original"
350
327
  * })
351
328
  */
352
- list(account_id, folder_id, request = {}, requestOptions) {
353
- return core.HttpResponsePromise.fromPromise(this.__list(account_id, folder_id, request, requestOptions));
329
+ show(account_id, version_stack_id, request = {}, requestOptions) {
330
+ return core.HttpResponsePromise.fromPromise(this.__show(account_id, version_stack_id, request, requestOptions));
354
331
  }
355
- __list(account_id_1, folder_id_1) {
356
- return __awaiter(this, arguments, void 0, function* (account_id, folder_id, request = {}, requestOptions) {
332
+ __show(account_id_1, version_stack_id_1) {
333
+ return __awaiter(this, arguments, void 0, function* (account_id, version_stack_id, request = {}, requestOptions) {
357
334
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
358
- const { include, after, page_size: pageSize, include_total_count: includeTotalCount } = request;
335
+ const { include } = request;
359
336
  const _queryParams = {
360
337
  include: include != null ? include : undefined,
361
- after,
362
- page_size: pageSize,
363
- include_total_count: includeTotalCount,
364
338
  };
365
339
  const _authRequest = yield this._options.authProvider.getAuthRequest();
366
340
  const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
367
341
  const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
368
- url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/version_stacks`),
342
+ url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/version_stacks/${core.url.encodePathParam(version_stack_id)}`),
369
343
  method: "GET",
370
344
  headers: _headers,
371
345
  queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
@@ -405,15 +379,27 @@ class VersionStacksClient {
405
379
  });
406
380
  }
407
381
  }
408
- return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/folders/{folder_id}/version_stacks");
382
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/version_stacks/{version_stack_id}");
409
383
  });
410
384
  }
411
385
  /**
412
- * Create a new Version Stack under the parent folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
386
+ * List the children (files) in a given version stack.
387
+ * <br/>
388
+ * Use the `include` query parameter to selectively include additional properties in the response.
389
+ * <br/>
390
+ * Note: if you include `media_links.original` and the user does not have permission to download files
391
+ * in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
392
+ * If the content is inaccessible because watermarking is required for this user and isn't supported by
393
+ * the requested media_links, then the request will succeed but the unsupported media links will be set to null.
394
+ * Similarly, if a requested transcode link does not exist for a particular file (e.g. including
395
+ * `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
396
+ * (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
397
+ * null in the response payload. In short, the client must handle null media links gracefully.
398
+ * <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
413
399
  *
414
400
  * @param {Frameio.FrameOrAdobeId} account_id
415
- * @param {Frameio.FrameOrAdobeId} folder_id
416
- * @param {Frameio.VersionStackCreateParams} request
401
+ * @param {Frameio.FrameOrAdobeId} version_stack_id
402
+ * @param {Frameio.VersionStacksIndexRequest} request
417
403
  * @param {VersionStacksClient.RequestOptions} requestOptions - Request-specific configuration.
418
404
  *
419
405
  * @throws {@link Frameio.BadRequestError}
@@ -425,28 +411,33 @@ class VersionStacksClient {
425
411
  * @throws {@link Frameio.TooManyRequestsError}
426
412
  *
427
413
  * @example
428
- * await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
429
- * data: {
430
- * file_ids: ["55d3fe55-a296-440b-ad38-4aab4db352a4", "d643846f-b4b1-4958-83e2-e762e4b112ec"]
431
- * }
414
+ * await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
415
+ * include: "media_links.original",
416
+ * after: "<opaque_cursor>",
417
+ * page_size: 10,
418
+ * include_total_count: false
432
419
  * })
433
420
  */
434
- create(account_id, folder_id, request, requestOptions) {
435
- return core.HttpResponsePromise.fromPromise(this.__create(account_id, folder_id, request, requestOptions));
421
+ index(account_id, version_stack_id, request = {}, requestOptions) {
422
+ return core.HttpResponsePromise.fromPromise(this.__index(account_id, version_stack_id, request, requestOptions));
436
423
  }
437
- __create(account_id, folder_id, request, requestOptions) {
438
- return __awaiter(this, void 0, void 0, function* () {
424
+ __index(account_id_1, version_stack_id_1) {
425
+ return __awaiter(this, arguments, void 0, function* (account_id, version_stack_id, request = {}, requestOptions) {
439
426
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
427
+ const { include, after, page_size: pageSize, include_total_count: includeTotalCount } = request;
428
+ const _queryParams = {
429
+ include: include != null ? include : undefined,
430
+ after,
431
+ page_size: pageSize,
432
+ include_total_count: includeTotalCount,
433
+ };
440
434
  const _authRequest = yield this._options.authProvider.getAuthRequest();
441
435
  const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
442
436
  const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
443
- url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/version_stacks`),
444
- method: "POST",
437
+ url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/version_stacks/${core.url.encodePathParam(version_stack_id)}/children`),
438
+ method: "GET",
445
439
  headers: _headers,
446
- contentType: "application/json",
447
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
448
- requestType: "json",
449
- body: request,
440
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
450
441
  timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
451
442
  maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
452
443
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -483,15 +474,19 @@ class VersionStacksClient {
483
474
  });
484
475
  }
485
476
  }
486
- return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/version_stacks");
477
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/version_stacks/{version_stack_id}/children");
487
478
  });
488
479
  }
489
480
  /**
490
- * Move version stack to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
481
+ * Copy version stack. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user<br><br>
482
+ *
483
+ * Currently, copying version stacks between Adobe storage backed projects is not supported. Copying individual
484
+ * files within a version stack and then restacking them is currently the supported method for copying version
485
+ * stacks for these projects.
491
486
  *
492
487
  * @param {Frameio.FrameOrAdobeId} account_id
493
488
  * @param {Frameio.FrameOrAdobeId} version_stack_id
494
- * @param {Frameio.VersionStackMoveParams} request
489
+ * @param {Frameio.VersionStackCopyParams} request
495
490
  * @param {VersionStacksClient.RequestOptions} requestOptions - Request-specific configuration.
496
491
  *
497
492
  * @throws {@link Frameio.BadRequestError}
@@ -503,28 +498,33 @@ class VersionStacksClient {
503
498
  * @throws {@link Frameio.TooManyRequestsError}
504
499
  *
505
500
  * @example
506
- * await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
501
+ * await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
502
+ * copy_metadata: true,
507
503
  * data: {
508
504
  * parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
509
505
  * }
510
506
  * })
511
507
  */
512
- move(account_id, version_stack_id, request, requestOptions) {
513
- return core.HttpResponsePromise.fromPromise(this.__move(account_id, version_stack_id, request, requestOptions));
508
+ copy(account_id, version_stack_id, request = {}, requestOptions) {
509
+ return core.HttpResponsePromise.fromPromise(this.__copy(account_id, version_stack_id, request, requestOptions));
514
510
  }
515
- __move(account_id, version_stack_id, request, requestOptions) {
516
- return __awaiter(this, void 0, void 0, function* () {
511
+ __copy(account_id_1, version_stack_id_1) {
512
+ return __awaiter(this, arguments, void 0, function* (account_id, version_stack_id, request = {}, requestOptions) {
517
513
  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
514
+ const { copy_metadata: copyMetadata } = request, _body = __rest(request, ["copy_metadata"]);
515
+ const _queryParams = {
516
+ copy_metadata: copyMetadata,
517
+ };
518
518
  const _authRequest = yield this._options.authProvider.getAuthRequest();
519
519
  const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
520
520
  const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
521
- url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/version_stacks/${core.url.encodePathParam(version_stack_id)}/move`),
522
- method: "PATCH",
521
+ url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/version_stacks/${core.url.encodePathParam(version_stack_id)}/copy`),
522
+ method: "POST",
523
523
  headers: _headers,
524
524
  contentType: "application/json",
525
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
525
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
526
526
  requestType: "json",
527
- body: request,
527
+ body: _body,
528
528
  timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
529
529
  maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
530
530
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -558,7 +558,7 @@ class VersionStacksClient {
558
558
  });
559
559
  }
560
560
  }
561
- return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/v4/accounts/{account_id}/version_stacks/{version_stack_id}/move");
561
+ return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/version_stacks/{version_stack_id}/copy");
562
562
  });
563
563
  }
564
564
  }
@@ -3,7 +3,7 @@ import type * as Frameio from "../../../../index.js";
3
3
  * @example
4
4
  * {
5
5
  * data: {
6
- * file_ids: ["55d3fe55-a296-440b-ad38-4aab4db352a4", "d643846f-b4b1-4958-83e2-e762e4b112ec"]
6
+ * file_ids: ["74849eb1-eb41-4ad9-98f5-bc91b59db044", "07edec4a-c8bb-479b-8dba-10f921b60746"]
7
7
  * }
8
8
  * }
9
9
  */
@@ -14,11 +14,11 @@ export declare class WorkspacePermissionsClient {
14
14
  protected readonly _options: NormalizedClientOptionsWithAuth<WorkspacePermissionsClient.Options>;
15
15
  constructor(options: WorkspacePermissionsClient.Options);
16
16
  /**
17
- * List user roles for a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
17
+ * Remove a user from a given workspace. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
18
18
  *
19
19
  * @param {Frameio.FrameOrAdobeId} account_id
20
20
  * @param {Frameio.Uuid} workspace_id
21
- * @param {Frameio.WorkspacePermissionsIndexRequest} request
21
+ * @param {Frameio.Uuid} user_id
22
22
  * @param {WorkspacePermissionsClient.RequestOptions} requestOptions - Request-specific configuration.
23
23
  *
24
24
  * @throws {@link Frameio.BadRequestError}
@@ -30,21 +30,18 @@ export declare class WorkspacePermissionsClient {
30
30
  * @throws {@link Frameio.TooManyRequestsError}
31
31
  *
32
32
  * @example
33
- * await client.workspacePermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
34
- * include_deactivated: true,
35
- * sort: "role_asc",
36
- * after: "<opaque_cursor>",
37
- * page_size: 10,
38
- * include_total_count: false
39
- * })
33
+ * await client.workspacePermissions.workspaceUserRolesDelete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
40
34
  */
41
- index(account_id: Frameio.FrameOrAdobeId, workspace_id: Frameio.Uuid, _request?: Frameio.WorkspacePermissionsIndexRequest, requestOptions?: WorkspacePermissionsClient.RequestOptions): Promise<core.Page<Frameio.WorkspaceUserRole, Frameio.WorkspaceUserRolesResponse>>;
35
+ workspaceUserRolesDelete(account_id: Frameio.FrameOrAdobeId, workspace_id: Frameio.Uuid, user_id: Frameio.Uuid, requestOptions?: WorkspacePermissionsClient.RequestOptions): core.HttpResponsePromise<void>;
36
+ private __workspaceUserRolesDelete;
42
37
  /**
43
- * Remove a user from a given workspace. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
38
+ * Update user roles for the given workspace if the user is already added to the workspace. If the user is
39
+ * not added to the workspace, the user will be added with the given role. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
44
40
  *
45
41
  * @param {Frameio.FrameOrAdobeId} account_id
46
42
  * @param {Frameio.Uuid} workspace_id
47
43
  * @param {Frameio.Uuid} user_id
44
+ * @param {Frameio.UpdateWorkspaceRoleParams} request
48
45
  * @param {WorkspacePermissionsClient.RequestOptions} requestOptions - Request-specific configuration.
49
46
  *
50
47
  * @throws {@link Frameio.BadRequestError}
@@ -56,18 +53,20 @@ export declare class WorkspacePermissionsClient {
56
53
  * @throws {@link Frameio.TooManyRequestsError}
57
54
  *
58
55
  * @example
59
- * await client.workspacePermissions.workspaceUserRolesDelete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
56
+ * await client.workspacePermissions.workspaceUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
57
+ * data: {
58
+ * role: "editor"
59
+ * }
60
+ * })
60
61
  */
61
- workspaceUserRolesDelete(account_id: Frameio.FrameOrAdobeId, workspace_id: Frameio.Uuid, user_id: Frameio.Uuid, requestOptions?: WorkspacePermissionsClient.RequestOptions): core.HttpResponsePromise<void>;
62
- private __workspaceUserRolesDelete;
62
+ workspaceUserRolesUpdate(account_id: Frameio.FrameOrAdobeId, workspace_id: Frameio.Uuid, user_id: Frameio.Uuid, request: Frameio.UpdateWorkspaceRoleParams, requestOptions?: WorkspacePermissionsClient.RequestOptions): core.HttpResponsePromise<Frameio.UpdateWorkspaceRoleResponse>;
63
+ private __workspaceUserRolesUpdate;
63
64
  /**
64
- * Update user roles for the given workspace if the user is already added to the workspace. If the user is
65
- * not added to the workspace, the user will be added with the given role. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
65
+ * List user roles for a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
66
66
  *
67
67
  * @param {Frameio.FrameOrAdobeId} account_id
68
68
  * @param {Frameio.Uuid} workspace_id
69
- * @param {Frameio.Uuid} user_id
70
- * @param {Frameio.UpdateWorkspaceRoleParams} request
69
+ * @param {Frameio.WorkspacePermissionsIndexRequest} request
71
70
  * @param {WorkspacePermissionsClient.RequestOptions} requestOptions - Request-specific configuration.
72
71
  *
73
72
  * @throws {@link Frameio.BadRequestError}
@@ -79,12 +78,13 @@ export declare class WorkspacePermissionsClient {
79
78
  * @throws {@link Frameio.TooManyRequestsError}
80
79
  *
81
80
  * @example
82
- * await client.workspacePermissions.workspaceUserRolesUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
83
- * data: {
84
- * role: "editor"
85
- * }
81
+ * await client.workspacePermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
82
+ * include_deactivated: true,
83
+ * sort: "role_asc",
84
+ * after: "<opaque_cursor>",
85
+ * page_size: 10,
86
+ * include_total_count: false
86
87
  * })
87
88
  */
88
- workspaceUserRolesUpdate(account_id: Frameio.FrameOrAdobeId, workspace_id: Frameio.Uuid, user_id: Frameio.Uuid, request: Frameio.UpdateWorkspaceRoleParams, requestOptions?: WorkspacePermissionsClient.RequestOptions): core.HttpResponsePromise<Frameio.UpdateWorkspaceRoleResponse>;
89
- private __workspaceUserRolesUpdate;
89
+ index(account_id: Frameio.FrameOrAdobeId, workspace_id: Frameio.Uuid, _request?: Frameio.WorkspacePermissionsIndexRequest, requestOptions?: WorkspacePermissionsClient.RequestOptions): Promise<core.Page<Frameio.WorkspaceUserRole, Frameio.WorkspaceUserRolesResponse>>;
90
90
  }