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.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +30 -30
- package/dist/cjs/Client.js +38 -38
- package/dist/cjs/api/resources/collections/client/Client.d.ts +17 -17
- package/dist/cjs/api/resources/collections/client/Client.js +30 -30
- package/dist/cjs/api/resources/files/client/Client.d.ts +96 -96
- package/dist/cjs/api/resources/files/client/Client.js +175 -175
- package/dist/cjs/api/resources/folders/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/folders/client/Client.js +29 -29
- package/dist/cjs/api/resources/metadata/client/Client.d.ts +27 -27
- package/dist/cjs/api/resources/metadata/client/Client.js +50 -50
- package/dist/cjs/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.ts +4 -4
- package/dist/cjs/api/resources/projectPermissions/client/Client.d.ts +24 -24
- package/dist/cjs/api/resources/projectPermissions/client/Client.js +87 -87
- package/dist/cjs/api/resources/projects/client/Client.d.ts +56 -0
- package/dist/cjs/api/resources/projects/client/Client.js +166 -0
- package/dist/cjs/api/resources/projects/client/requests/AccountProjectsIndexRequest.d.ts +24 -0
- package/dist/cjs/api/resources/projects/client/requests/AccountProjectsIndexRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/InvitedProjectsIndexRequest.d.ts +24 -0
- package/dist/cjs/api/resources/projects/client/requests/InvitedProjectsIndexRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/projects/types/AccountProjectsIndexRequestSort.d.ts +8 -0
- package/dist/cjs/api/resources/projects/types/AccountProjectsIndexRequestSort.js +11 -0
- package/dist/cjs/api/resources/projects/types/InvitedProjectsIndexRequestSort.d.ts +8 -0
- package/dist/cjs/api/resources/projects/types/InvitedProjectsIndexRequestSort.js +11 -0
- package/dist/cjs/api/resources/projects/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/projects/types/index.js +2 -0
- package/dist/cjs/api/resources/shares/client/Client.d.ts +49 -49
- package/dist/cjs/api/resources/shares/client/Client.js +146 -146
- package/dist/cjs/api/resources/shares/client/requests/AddAssetParams.d.ts +1 -1
- package/dist/cjs/api/resources/shares/client/requests/CreateShareParams.d.ts +2 -2
- package/dist/cjs/api/resources/shares/client/requests/UpdateShareParams.d.ts +1 -1
- package/dist/cjs/api/resources/versionStacks/client/Client.d.ts +64 -64
- package/dist/cjs/api/resources/versionStacks/client/Client.js +121 -121
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.ts +1 -1
- package/dist/cjs/api/resources/workspacePermissions/client/Client.d.ts +24 -24
- package/dist/cjs/api/resources/workspacePermissions/client/Client.js +87 -87
- package/dist/cjs/api/resources/workspaces/client/Client.d.ts +34 -34
- package/dist/cjs/api/resources/workspaces/client/Client.js +141 -141
- package/dist/cjs/api/types/AuditLogwithIncludes.d.ts +6 -0
- package/dist/cjs/api/types/AuditLogwithIncludes.js +6 -0
- package/dist/cjs/api/types/Filters.d.ts +6 -0
- package/dist/cjs/api/types/Filters.js +6 -0
- package/dist/cjs/api/types/LongTextDefinition.d.ts +0 -16
- package/dist/cjs/api/types/LongTextDefinition.js +0 -17
- package/dist/cjs/api/types/NumberDefinition.d.ts +16 -0
- package/dist/cjs/api/types/NumberDefinition.js +13 -0
- package/dist/cjs/api/types/TextDefinition.d.ts +0 -16
- package/dist/cjs/api/types/TextDefinition.js +0 -17
- package/dist/cjs/api/types/ToggleDefinition.d.ts +16 -0
- package/dist/cjs/api/types/ToggleDefinition.js +17 -0
- package/dist/cjs/api/types/UserSingleDefinition.d.ts +0 -16
- package/dist/cjs/api/types/UserSingleDefinition.js +0 -13
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +30 -30
- package/dist/esm/Client.mjs +38 -38
- package/dist/esm/api/resources/collections/client/Client.d.mts +17 -17
- package/dist/esm/api/resources/collections/client/Client.mjs +30 -30
- package/dist/esm/api/resources/files/client/Client.d.mts +96 -96
- package/dist/esm/api/resources/files/client/Client.mjs +175 -175
- package/dist/esm/api/resources/folders/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/folders/client/Client.mjs +29 -29
- package/dist/esm/api/resources/metadata/client/Client.d.mts +27 -27
- package/dist/esm/api/resources/metadata/client/Client.mjs +50 -50
- package/dist/esm/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.mts +4 -4
- package/dist/esm/api/resources/projectPermissions/client/Client.d.mts +24 -24
- package/dist/esm/api/resources/projectPermissions/client/Client.mjs +87 -87
- package/dist/esm/api/resources/projects/client/Client.d.mts +56 -0
- package/dist/esm/api/resources/projects/client/Client.mjs +166 -0
- package/dist/esm/api/resources/projects/client/requests/AccountProjectsIndexRequest.d.mts +24 -0
- package/dist/esm/api/resources/projects/client/requests/AccountProjectsIndexRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/InvitedProjectsIndexRequest.d.mts +24 -0
- package/dist/esm/api/resources/projects/client/requests/InvitedProjectsIndexRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/projects/types/AccountProjectsIndexRequestSort.d.mts +8 -0
- package/dist/esm/api/resources/projects/types/AccountProjectsIndexRequestSort.mjs +8 -0
- package/dist/esm/api/resources/projects/types/InvitedProjectsIndexRequestSort.d.mts +8 -0
- package/dist/esm/api/resources/projects/types/InvitedProjectsIndexRequestSort.mjs +8 -0
- package/dist/esm/api/resources/projects/types/index.d.mts +2 -0
- package/dist/esm/api/resources/projects/types/index.mjs +2 -0
- package/dist/esm/api/resources/shares/client/Client.d.mts +49 -49
- package/dist/esm/api/resources/shares/client/Client.mjs +146 -146
- package/dist/esm/api/resources/shares/client/requests/AddAssetParams.d.mts +1 -1
- package/dist/esm/api/resources/shares/client/requests/CreateShareParams.d.mts +2 -2
- package/dist/esm/api/resources/shares/client/requests/UpdateShareParams.d.mts +1 -1
- package/dist/esm/api/resources/versionStacks/client/Client.d.mts +64 -64
- package/dist/esm/api/resources/versionStacks/client/Client.mjs +121 -121
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.mts +1 -1
- package/dist/esm/api/resources/workspacePermissions/client/Client.d.mts +24 -24
- package/dist/esm/api/resources/workspacePermissions/client/Client.mjs +87 -87
- package/dist/esm/api/resources/workspaces/client/Client.d.mts +34 -34
- package/dist/esm/api/resources/workspaces/client/Client.mjs +141 -141
- package/dist/esm/api/types/AuditLogwithIncludes.d.mts +6 -0
- package/dist/esm/api/types/AuditLogwithIncludes.mjs +6 -0
- package/dist/esm/api/types/Filters.d.mts +6 -0
- package/dist/esm/api/types/Filters.mjs +6 -0
- package/dist/esm/api/types/LongTextDefinition.d.mts +0 -16
- package/dist/esm/api/types/LongTextDefinition.mjs +1 -16
- package/dist/esm/api/types/NumberDefinition.d.mts +16 -0
- package/dist/esm/api/types/NumberDefinition.mjs +13 -0
- package/dist/esm/api/types/TextDefinition.d.mts +0 -16
- package/dist/esm/api/types/TextDefinition.mjs +1 -16
- package/dist/esm/api/types/ToggleDefinition.d.mts +16 -0
- package/dist/esm/api/types/ToggleDefinition.mjs +16 -1
- package/dist/esm/api/types/UserSingleDefinition.d.mts +0 -16
- package/dist/esm/api/types/UserSingleDefinition.mjs +0 -13
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +112 -112
- package/reference.md +1392 -1234
|
@@ -22,93 +22,6 @@ export class WorkspacePermissionsClient {
|
|
|
22
22
|
constructor(options) {
|
|
23
23
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
24
24
|
}
|
|
25
|
-
/**
|
|
26
|
-
* List user roles for a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
27
|
-
*
|
|
28
|
-
* @param {Frameio.FrameOrAdobeId} account_id
|
|
29
|
-
* @param {Frameio.Uuid} workspace_id
|
|
30
|
-
* @param {Frameio.WorkspacePermissionsIndexRequest} request
|
|
31
|
-
* @param {WorkspacePermissionsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
32
|
-
*
|
|
33
|
-
* @throws {@link Frameio.BadRequestError}
|
|
34
|
-
* @throws {@link Frameio.UnauthorizedError}
|
|
35
|
-
* @throws {@link Frameio.ForbiddenError}
|
|
36
|
-
* @throws {@link Frameio.NotFoundError}
|
|
37
|
-
* @throws {@link Frameio.ConflictError}
|
|
38
|
-
* @throws {@link Frameio.UnprocessableEntityError}
|
|
39
|
-
* @throws {@link Frameio.TooManyRequestsError}
|
|
40
|
-
*
|
|
41
|
-
* @example
|
|
42
|
-
* await client.workspacePermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
43
|
-
* include_deactivated: true,
|
|
44
|
-
* sort: "role_asc",
|
|
45
|
-
* after: "<opaque_cursor>",
|
|
46
|
-
* page_size: 10,
|
|
47
|
-
* include_total_count: false
|
|
48
|
-
* })
|
|
49
|
-
*/
|
|
50
|
-
index(account_id_1, workspace_id_1) {
|
|
51
|
-
return __awaiter(this, arguments, void 0, function* (account_id, workspace_id, _request = {}, requestOptions) {
|
|
52
|
-
var _a, _b;
|
|
53
|
-
const list = core.HttpResponsePromise.interceptFunction((_requestUrl) => __awaiter(this, void 0, void 0, function* () {
|
|
54
|
-
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
55
|
-
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
56
|
-
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
57
|
-
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
58
|
-
url: _requestUrl,
|
|
59
|
-
method: "GET",
|
|
60
|
-
headers: _headers,
|
|
61
|
-
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
62
|
-
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
63
|
-
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
64
|
-
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
65
|
-
logging: this._options.logging,
|
|
66
|
-
});
|
|
67
|
-
if (_response.ok) {
|
|
68
|
-
return {
|
|
69
|
-
data: _response.body,
|
|
70
|
-
rawResponse: _response.rawResponse,
|
|
71
|
-
};
|
|
72
|
-
}
|
|
73
|
-
if (_response.error.reason === "status-code") {
|
|
74
|
-
switch (_response.error.statusCode) {
|
|
75
|
-
case 400:
|
|
76
|
-
throw new Frameio.BadRequestError(_response.error.body, _response.rawResponse);
|
|
77
|
-
case 401:
|
|
78
|
-
throw new Frameio.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
79
|
-
case 403:
|
|
80
|
-
throw new Frameio.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
81
|
-
case 404:
|
|
82
|
-
throw new Frameio.NotFoundError(_response.error.body, _response.rawResponse);
|
|
83
|
-
case 409:
|
|
84
|
-
throw new Frameio.ConflictError(_response.error.body, _response.rawResponse);
|
|
85
|
-
case 422:
|
|
86
|
-
throw new Frameio.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
87
|
-
case 429:
|
|
88
|
-
throw new Frameio.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
89
|
-
default:
|
|
90
|
-
throw new errors.FrameioError({
|
|
91
|
-
statusCode: _response.error.statusCode,
|
|
92
|
-
body: _response.error.body,
|
|
93
|
-
rawResponse: _response.rawResponse,
|
|
94
|
-
});
|
|
95
|
-
}
|
|
96
|
-
}
|
|
97
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/workspaces/{workspace_id}/users");
|
|
98
|
-
}));
|
|
99
|
-
const _baseUrl = (_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.FrameioEnvironment.Default;
|
|
100
|
-
const dataWithRawResponse = yield list(core.url.join(_baseUrl, `v4/accounts/${core.url.encodePathParam(account_id)}/workspaces/${core.url.encodePathParam(workspace_id)}/users`)).withRawResponse();
|
|
101
|
-
return new core.Page({
|
|
102
|
-
response: dataWithRawResponse.data,
|
|
103
|
-
rawResponse: dataWithRawResponse.rawResponse,
|
|
104
|
-
hasNextPage: (response) => (response === null || response === void 0 ? void 0 : response.links.next) != null && (response === null || response === void 0 ? void 0 : response.links.next) !== "",
|
|
105
|
-
getItems: (response) => { var _a; return (_a = response === null || response === void 0 ? void 0 : response.data) !== null && _a !== void 0 ? _a : []; },
|
|
106
|
-
loadPage: (response) => {
|
|
107
|
-
return list(core.url.join(_baseUrl, response === null || response === void 0 ? void 0 : response.links.next));
|
|
108
|
-
},
|
|
109
|
-
});
|
|
110
|
-
});
|
|
111
|
-
}
|
|
112
25
|
/**
|
|
113
26
|
* Remove a user from a given workspace. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
114
27
|
*
|
|
@@ -254,4 +167,91 @@ export class WorkspacePermissionsClient {
|
|
|
254
167
|
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/v4/accounts/{account_id}/workspaces/{workspace_id}/users/{user_id}");
|
|
255
168
|
});
|
|
256
169
|
}
|
|
170
|
+
/**
|
|
171
|
+
* List user roles for a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
172
|
+
*
|
|
173
|
+
* @param {Frameio.FrameOrAdobeId} account_id
|
|
174
|
+
* @param {Frameio.Uuid} workspace_id
|
|
175
|
+
* @param {Frameio.WorkspacePermissionsIndexRequest} request
|
|
176
|
+
* @param {WorkspacePermissionsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
177
|
+
*
|
|
178
|
+
* @throws {@link Frameio.BadRequestError}
|
|
179
|
+
* @throws {@link Frameio.UnauthorizedError}
|
|
180
|
+
* @throws {@link Frameio.ForbiddenError}
|
|
181
|
+
* @throws {@link Frameio.NotFoundError}
|
|
182
|
+
* @throws {@link Frameio.ConflictError}
|
|
183
|
+
* @throws {@link Frameio.UnprocessableEntityError}
|
|
184
|
+
* @throws {@link Frameio.TooManyRequestsError}
|
|
185
|
+
*
|
|
186
|
+
* @example
|
|
187
|
+
* await client.workspacePermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
188
|
+
* include_deactivated: true,
|
|
189
|
+
* sort: "role_asc",
|
|
190
|
+
* after: "<opaque_cursor>",
|
|
191
|
+
* page_size: 10,
|
|
192
|
+
* include_total_count: false
|
|
193
|
+
* })
|
|
194
|
+
*/
|
|
195
|
+
index(account_id_1, workspace_id_1) {
|
|
196
|
+
return __awaiter(this, arguments, void 0, function* (account_id, workspace_id, _request = {}, requestOptions) {
|
|
197
|
+
var _a, _b;
|
|
198
|
+
const list = core.HttpResponsePromise.interceptFunction((_requestUrl) => __awaiter(this, void 0, void 0, function* () {
|
|
199
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
200
|
+
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
201
|
+
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
202
|
+
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
203
|
+
url: _requestUrl,
|
|
204
|
+
method: "GET",
|
|
205
|
+
headers: _headers,
|
|
206
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
207
|
+
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
208
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
209
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
210
|
+
logging: this._options.logging,
|
|
211
|
+
});
|
|
212
|
+
if (_response.ok) {
|
|
213
|
+
return {
|
|
214
|
+
data: _response.body,
|
|
215
|
+
rawResponse: _response.rawResponse,
|
|
216
|
+
};
|
|
217
|
+
}
|
|
218
|
+
if (_response.error.reason === "status-code") {
|
|
219
|
+
switch (_response.error.statusCode) {
|
|
220
|
+
case 400:
|
|
221
|
+
throw new Frameio.BadRequestError(_response.error.body, _response.rawResponse);
|
|
222
|
+
case 401:
|
|
223
|
+
throw new Frameio.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
224
|
+
case 403:
|
|
225
|
+
throw new Frameio.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
226
|
+
case 404:
|
|
227
|
+
throw new Frameio.NotFoundError(_response.error.body, _response.rawResponse);
|
|
228
|
+
case 409:
|
|
229
|
+
throw new Frameio.ConflictError(_response.error.body, _response.rawResponse);
|
|
230
|
+
case 422:
|
|
231
|
+
throw new Frameio.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
232
|
+
case 429:
|
|
233
|
+
throw new Frameio.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
234
|
+
default:
|
|
235
|
+
throw new errors.FrameioError({
|
|
236
|
+
statusCode: _response.error.statusCode,
|
|
237
|
+
body: _response.error.body,
|
|
238
|
+
rawResponse: _response.rawResponse,
|
|
239
|
+
});
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/workspaces/{workspace_id}/users");
|
|
243
|
+
}));
|
|
244
|
+
const _baseUrl = (_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.FrameioEnvironment.Default;
|
|
245
|
+
const dataWithRawResponse = yield list(core.url.join(_baseUrl, `v4/accounts/${core.url.encodePathParam(account_id)}/workspaces/${core.url.encodePathParam(workspace_id)}/users`)).withRawResponse();
|
|
246
|
+
return new core.Page({
|
|
247
|
+
response: dataWithRawResponse.data,
|
|
248
|
+
rawResponse: dataWithRawResponse.rawResponse,
|
|
249
|
+
hasNextPage: (response) => (response === null || response === void 0 ? void 0 : response.links.next) != null && (response === null || response === void 0 ? void 0 : response.links.next) !== "",
|
|
250
|
+
getItems: (response) => { var _a; return (_a = response === null || response === void 0 ? void 0 : response.data) !== null && _a !== void 0 ? _a : []; },
|
|
251
|
+
loadPage: (response) => {
|
|
252
|
+
return list(core.url.join(_baseUrl, response === null || response === void 0 ? void 0 : response.links.next));
|
|
253
|
+
},
|
|
254
|
+
});
|
|
255
|
+
});
|
|
256
|
+
}
|
|
257
257
|
}
|
|
@@ -14,11 +14,10 @@ export declare class WorkspacesClient {
|
|
|
14
14
|
protected readonly _options: NormalizedClientOptionsWithAuth<WorkspacesClient.Options>;
|
|
15
15
|
constructor(options: WorkspacesClient.Options);
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* List workspaces for a given account. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
18
18
|
*
|
|
19
19
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
20
|
-
* @param {Frameio.
|
|
21
|
-
* @param {Frameio.WorkspacesShowRequest} request
|
|
20
|
+
* @param {Frameio.WorkspacesIndexRequest} request
|
|
22
21
|
* @param {WorkspacesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
23
22
|
*
|
|
24
23
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -30,17 +29,20 @@ export declare class WorkspacesClient {
|
|
|
30
29
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
31
30
|
*
|
|
32
31
|
* @example
|
|
33
|
-
* await client.workspaces.
|
|
34
|
-
* include: "creator"
|
|
32
|
+
* await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
33
|
+
* include: "creator",
|
|
34
|
+
* sort: "name_asc",
|
|
35
|
+
* after: "<opaque_cursor>",
|
|
36
|
+
* page_size: 10,
|
|
37
|
+
* include_total_count: false
|
|
35
38
|
* })
|
|
36
39
|
*/
|
|
37
|
-
|
|
38
|
-
private __show;
|
|
40
|
+
index(account_id: Frameio.FrameOrAdobeId, _request?: Frameio.WorkspacesIndexRequest, requestOptions?: WorkspacesClient.RequestOptions): Promise<core.Page<Frameio.WorkspaceWithIncludes, Frameio.WorkspacesWithIncludesResponse>>;
|
|
39
41
|
/**
|
|
40
|
-
*
|
|
42
|
+
* Create workspace from an account. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
41
43
|
*
|
|
42
44
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
43
|
-
* @param {Frameio.
|
|
45
|
+
* @param {Frameio.WorkspaceParams} request
|
|
44
46
|
* @param {WorkspacesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
45
47
|
*
|
|
46
48
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -52,16 +54,20 @@ export declare class WorkspacesClient {
|
|
|
52
54
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
53
55
|
*
|
|
54
56
|
* @example
|
|
55
|
-
* await client.workspaces.
|
|
57
|
+
* await client.workspaces.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
58
|
+
* data: {
|
|
59
|
+
* name: "My Workspace"
|
|
60
|
+
* }
|
|
61
|
+
* })
|
|
56
62
|
*/
|
|
57
|
-
|
|
58
|
-
private
|
|
63
|
+
create(account_id: Frameio.FrameOrAdobeId, request: Frameio.WorkspaceParams, requestOptions?: WorkspacesClient.RequestOptions): core.HttpResponsePromise<Frameio.WorkspaceResponse>;
|
|
64
|
+
private __create;
|
|
59
65
|
/**
|
|
60
|
-
*
|
|
66
|
+
* Show workspace details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
61
67
|
*
|
|
62
68
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
63
69
|
* @param {Frameio.Uuid} workspace_id
|
|
64
|
-
* @param {Frameio.
|
|
70
|
+
* @param {Frameio.WorkspacesShowRequest} request
|
|
65
71
|
* @param {WorkspacesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
66
72
|
*
|
|
67
73
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -73,19 +79,17 @@ export declare class WorkspacesClient {
|
|
|
73
79
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
74
80
|
*
|
|
75
81
|
* @example
|
|
76
|
-
* await client.workspaces.
|
|
77
|
-
*
|
|
78
|
-
* name: "My Workspace"
|
|
79
|
-
* }
|
|
82
|
+
* await client.workspaces.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
83
|
+
* include: "creator"
|
|
80
84
|
* })
|
|
81
85
|
*/
|
|
82
|
-
|
|
83
|
-
private
|
|
86
|
+
show(account_id: Frameio.FrameOrAdobeId, workspace_id: Frameio.Uuid, request?: Frameio.WorkspacesShowRequest, requestOptions?: WorkspacesClient.RequestOptions): core.HttpResponsePromise<Frameio.WorkspaceWithIncludesResponse>;
|
|
87
|
+
private __show;
|
|
84
88
|
/**
|
|
85
|
-
*
|
|
89
|
+
* Delete workspace from account. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
86
90
|
*
|
|
87
91
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
88
|
-
* @param {Frameio.
|
|
92
|
+
* @param {Frameio.Uuid} workspace_id
|
|
89
93
|
* @param {WorkspacesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
90
94
|
*
|
|
91
95
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -97,19 +101,15 @@ export declare class WorkspacesClient {
|
|
|
97
101
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
98
102
|
*
|
|
99
103
|
* @example
|
|
100
|
-
* await client.workspaces.
|
|
101
|
-
* include: "creator",
|
|
102
|
-
* sort: "name_asc",
|
|
103
|
-
* after: "<opaque_cursor>",
|
|
104
|
-
* page_size: 10,
|
|
105
|
-
* include_total_count: false
|
|
106
|
-
* })
|
|
104
|
+
* await client.workspaces.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
|
|
107
105
|
*/
|
|
108
|
-
|
|
106
|
+
delete(account_id: Frameio.FrameOrAdobeId, workspace_id: Frameio.Uuid, requestOptions?: WorkspacesClient.RequestOptions): core.HttpResponsePromise<void>;
|
|
107
|
+
private __delete;
|
|
109
108
|
/**
|
|
110
|
-
*
|
|
109
|
+
* Update a workspace. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
111
110
|
*
|
|
112
111
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
112
|
+
* @param {Frameio.Uuid} workspace_id
|
|
113
113
|
* @param {Frameio.WorkspaceParams} request
|
|
114
114
|
* @param {WorkspacesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
115
115
|
*
|
|
@@ -122,12 +122,12 @@ export declare class WorkspacesClient {
|
|
|
122
122
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
123
123
|
*
|
|
124
124
|
* @example
|
|
125
|
-
* await client.workspaces.
|
|
125
|
+
* await client.workspaces.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
126
126
|
* data: {
|
|
127
127
|
* name: "My Workspace"
|
|
128
128
|
* }
|
|
129
129
|
* })
|
|
130
130
|
*/
|
|
131
|
-
|
|
132
|
-
private
|
|
131
|
+
update(account_id: Frameio.FrameOrAdobeId, workspace_id: Frameio.Uuid, request: Frameio.WorkspaceParams, requestOptions?: WorkspacesClient.RequestOptions): core.HttpResponsePromise<Frameio.WorkspaceResponse>;
|
|
132
|
+
private __update;
|
|
133
133
|
}
|