@spaciv/sdk 0.1.24 → 0.1.26
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/.openapi-generator/FILES +1 -0
- package/README.md +2 -2
- package/dist/apis/AccountsApi.d.ts +37 -10
- package/dist/apis/AccountsApi.js +49 -4
- package/dist/apis/InternalApi.d.ts +4 -4
- package/dist/apis/InternalApi.js +2 -2
- package/dist/apis/ObjectGroupsApi.d.ts +8 -8
- package/dist/apis/ObjectGroupsApi.js +4 -4
- package/dist/esm/apis/AccountsApi.d.ts +37 -10
- package/dist/esm/apis/AccountsApi.js +50 -5
- package/dist/esm/apis/InternalApi.d.ts +4 -4
- package/dist/esm/apis/InternalApi.js +2 -2
- package/dist/esm/apis/ObjectGroupsApi.d.ts +8 -8
- package/dist/esm/apis/ObjectGroupsApi.js +4 -4
- package/dist/esm/models/AccountDuplicateReqBody.d.ts +32 -0
- package/dist/esm/models/AccountDuplicateReqBody.js +43 -0
- package/dist/esm/models/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/models/AccountDuplicateReqBody.d.ts +32 -0
- package/dist/models/AccountDuplicateReqBody.js +50 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +1 -1
- package/src/apis/AccountsApi.ts +85 -9
- package/src/apis/InternalApi.ts +4 -4
- package/src/apis/ObjectGroupsApi.ts +8 -8
- package/src/models/AccountDuplicateReqBody.ts +66 -0
- package/src/models/index.ts +1 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -42,6 +42,7 @@ src/models/AccountCalculationUsageDay.ts
|
|
|
42
42
|
src/models/AccountDetailsResBody.ts
|
|
43
43
|
src/models/AccountDirectoryPatchBody.ts
|
|
44
44
|
src/models/AccountDirectoryPostBody.ts
|
|
45
|
+
src/models/AccountDuplicateReqBody.ts
|
|
45
46
|
src/models/AccountFilePatchBody.ts
|
|
46
47
|
src/models/AccountGetAuthOptionsResBody.ts
|
|
47
48
|
src/models/AccountOIDCProvider.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @spaciv/sdk@0.1.
|
|
1
|
+
## @spaciv/sdk@0.1.26
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @spaciv/sdk@0.1.
|
|
39
|
+
npm install @spaciv/sdk@0.1.26 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -10,13 +10,16 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { Account, AccountAuthOption, AccountCalculationUsageBody, AccountDetailsResBody, AccountGetAuthOptionsResBody, AccountOIDCProvider, AccountOIDCProviderPatch, AccountPatchAuthOptionsReqBody, AccountPostOIDCProviderReqBody, AccountPostReqBody, AccountPutOIDCClientSecretReqBody, AccountPutReqBody, AccountUsageResBody, ListAccountsForUserRow } from '../models/index';
|
|
13
|
+
import type { Account, AccountAuthOption, AccountCalculationUsageBody, AccountDetailsResBody, AccountDuplicateReqBody, AccountGetAuthOptionsResBody, AccountOIDCProvider, AccountOIDCProviderPatch, AccountPatchAuthOptionsReqBody, AccountPostOIDCProviderReqBody, AccountPostReqBody, AccountPutOIDCClientSecretReqBody, AccountPutReqBody, AccountUsageResBody, ListAccountsForUserRow } from '../models/index';
|
|
14
14
|
export interface AccountsApiCreateRequest {
|
|
15
15
|
accountPostReqBody: AccountPostReqBody;
|
|
16
16
|
}
|
|
17
17
|
export interface AccountsApiCreateOidcProviderRequest {
|
|
18
18
|
accountPostOIDCProviderReqBody: AccountPostOIDCProviderReqBody;
|
|
19
19
|
}
|
|
20
|
+
export interface AccountsApiDuplicateRequest {
|
|
21
|
+
accountDuplicateReqBody: AccountDuplicateReqBody;
|
|
22
|
+
}
|
|
20
23
|
export interface AccountsApiGetAuthOptionsRequest {
|
|
21
24
|
hostname: string;
|
|
22
25
|
}
|
|
@@ -49,7 +52,7 @@ export interface AccountsApiUpdateOidcProviderClientSecretRequest {
|
|
|
49
52
|
*/
|
|
50
53
|
export interface AccountsApiInterface {
|
|
51
54
|
/**
|
|
52
|
-
* Creates an account owned by the authenticated user and returns its identifier.
|
|
55
|
+
* Creates an account owned by the authenticated user and returns its identifier. The account is seeded from the prebuilt account for the chosen template (`blank` starts almost empty). Seeding runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account. Account names are unique; reusing one returns `400 account-name-in-use`. Requires the *Manage my account* permission.
|
|
53
56
|
* @summary Create an account
|
|
54
57
|
* @param {AccountPostReqBody} accountPostReqBody
|
|
55
58
|
* @param {*} [options] Override http request option.
|
|
@@ -58,7 +61,7 @@ export interface AccountsApiInterface {
|
|
|
58
61
|
*/
|
|
59
62
|
createRaw(requestParameters: AccountsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<number>>;
|
|
60
63
|
/**
|
|
61
|
-
* Creates an account owned by the authenticated user and returns its identifier.
|
|
64
|
+
* Creates an account owned by the authenticated user and returns its identifier. The account is seeded from the prebuilt account for the chosen template (`blank` starts almost empty). Seeding runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account. Account names are unique; reusing one returns `400 account-name-in-use`. Requires the *Manage my account* permission.
|
|
62
65
|
* Create an account
|
|
63
66
|
*/
|
|
64
67
|
create(requestParameters: AccountsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
|
|
@@ -102,6 +105,20 @@ export interface AccountsApiInterface {
|
|
|
102
105
|
* Delete the current account\'s OIDC provider
|
|
103
106
|
*/
|
|
104
107
|
deleteOidcProvider(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
108
|
+
/**
|
|
109
|
+
* Creates a new account owned by the authenticated user and copies the current account\'s content into it: projects, dashboards, floor plans, properties, object groups, top-down models, scenarios, datasets, space rulesets, variables, and files with their folders. Archived projects, object groups, scenarios and top-down models are copied and stay archived. Data collections are copied as drafts without their contributors. Members and their roles, sign-in settings, API keys, scripts, assistant conversations and the audit log are not copied; the caller is the new account\'s only member. Returns the new account\'s identifier. Copying runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account; it returns `500 account-setup-failed` if the content could not be copied, and the incomplete account is then deleted, after which polling it returns `403`. Account names are unique; reusing one returns `400 account-name-in-use`. Requires a token for the account being duplicated, holding the *Manage my account* permission; a token for no account returns `400`. A script\'s own API key cannot duplicate an account.
|
|
110
|
+
* @summary Duplicate the current account
|
|
111
|
+
* @param {AccountDuplicateReqBody} accountDuplicateReqBody
|
|
112
|
+
* @param {*} [options] Override http request option.
|
|
113
|
+
* @throws {RequiredError}
|
|
114
|
+
* @memberof AccountsApiInterface
|
|
115
|
+
*/
|
|
116
|
+
duplicateRaw(requestParameters: AccountsApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<number>>;
|
|
117
|
+
/**
|
|
118
|
+
* Creates a new account owned by the authenticated user and copies the current account\'s content into it: projects, dashboards, floor plans, properties, object groups, top-down models, scenarios, datasets, space rulesets, variables, and files with their folders. Archived projects, object groups, scenarios and top-down models are copied and stay archived. Data collections are copied as drafts without their contributors. Members and their roles, sign-in settings, API keys, scripts, assistant conversations and the audit log are not copied; the caller is the new account\'s only member. Returns the new account\'s identifier. Copying runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account; it returns `500 account-setup-failed` if the content could not be copied, and the incomplete account is then deleted, after which polling it returns `403`. Account names are unique; reusing one returns `400 account-name-in-use`. Requires a token for the account being duplicated, holding the *Manage my account* permission; a token for no account returns `400`. A script\'s own API key cannot duplicate an account.
|
|
119
|
+
* Duplicate the current account
|
|
120
|
+
*/
|
|
121
|
+
duplicate(requestParameters: AccountsApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
|
|
105
122
|
/**
|
|
106
123
|
* Returns the account the access token was issued for. Use `GET /v1/account/profile` for the full profile, including address and notification preferences. Requires the *View account overview* permission.
|
|
107
124
|
* @summary Get the current account
|
|
@@ -170,16 +187,16 @@ export interface AccountsApiInterface {
|
|
|
170
187
|
*/
|
|
171
188
|
getProfile(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountDetailsResBody>;
|
|
172
189
|
/**
|
|
173
|
-
* Long-polls until the account created by `POST /v1/accounts` has finished being seeded
|
|
190
|
+
* Long-polls until the account created by `POST /v1/accounts` or `POST /v1/account/duplicate` has finished being seeded with its starting content, then returns `204`. The request is held open for up to 90 seconds and returns `408` if setup has not completed by then; call it again to keep waiting. Returns `500 account-setup-failed` if the content could not be copied; the account exists but is incomplete. The caller must be a member of the account and hold the *Manage my account* permission.
|
|
174
191
|
* @summary Wait for account setup to finish
|
|
175
|
-
* @param {number} id Identifier returned by POST /v1/accounts.
|
|
192
|
+
* @param {number} id Identifier returned by POST /v1/accounts or POST /v1/account/duplicate.
|
|
176
193
|
* @param {*} [options] Override http request option.
|
|
177
194
|
* @throws {RequiredError}
|
|
178
195
|
* @memberof AccountsApiInterface
|
|
179
196
|
*/
|
|
180
197
|
getSetupStatusRaw(requestParameters: AccountsApiGetSetupStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
181
198
|
/**
|
|
182
|
-
* Long-polls until the account created by `POST /v1/accounts` has finished being seeded
|
|
199
|
+
* Long-polls until the account created by `POST /v1/accounts` or `POST /v1/account/duplicate` has finished being seeded with its starting content, then returns `204`. The request is held open for up to 90 seconds and returns `408` if setup has not completed by then; call it again to keep waiting. Returns `500 account-setup-failed` if the content could not be copied; the account exists but is incomplete. The caller must be a member of the account and hold the *Manage my account* permission.
|
|
183
200
|
* Wait for account setup to finish
|
|
184
201
|
*/
|
|
185
202
|
getSetupStatus(requestParameters: AccountsApiGetSetupStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -298,12 +315,12 @@ export interface AccountsApiInterface {
|
|
|
298
315
|
*/
|
|
299
316
|
export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface {
|
|
300
317
|
/**
|
|
301
|
-
* Creates an account owned by the authenticated user and returns its identifier.
|
|
318
|
+
* Creates an account owned by the authenticated user and returns its identifier. The account is seeded from the prebuilt account for the chosen template (`blank` starts almost empty). Seeding runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account. Account names are unique; reusing one returns `400 account-name-in-use`. Requires the *Manage my account* permission.
|
|
302
319
|
* Create an account
|
|
303
320
|
*/
|
|
304
321
|
createRaw(requestParameters: AccountsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<number>>;
|
|
305
322
|
/**
|
|
306
|
-
* Creates an account owned by the authenticated user and returns its identifier.
|
|
323
|
+
* Creates an account owned by the authenticated user and returns its identifier. The account is seeded from the prebuilt account for the chosen template (`blank` starts almost empty). Seeding runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account. Account names are unique; reusing one returns `400 account-name-in-use`. Requires the *Manage my account* permission.
|
|
307
324
|
* Create an account
|
|
308
325
|
*/
|
|
309
326
|
create(requestParameters: AccountsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
|
|
@@ -337,6 +354,16 @@ export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiI
|
|
|
337
354
|
* Delete the current account\'s OIDC provider
|
|
338
355
|
*/
|
|
339
356
|
deleteOidcProvider(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
357
|
+
/**
|
|
358
|
+
* Creates a new account owned by the authenticated user and copies the current account\'s content into it: projects, dashboards, floor plans, properties, object groups, top-down models, scenarios, datasets, space rulesets, variables, and files with their folders. Archived projects, object groups, scenarios and top-down models are copied and stay archived. Data collections are copied as drafts without their contributors. Members and their roles, sign-in settings, API keys, scripts, assistant conversations and the audit log are not copied; the caller is the new account\'s only member. Returns the new account\'s identifier. Copying runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account; it returns `500 account-setup-failed` if the content could not be copied, and the incomplete account is then deleted, after which polling it returns `403`. Account names are unique; reusing one returns `400 account-name-in-use`. Requires a token for the account being duplicated, holding the *Manage my account* permission; a token for no account returns `400`. A script\'s own API key cannot duplicate an account.
|
|
359
|
+
* Duplicate the current account
|
|
360
|
+
*/
|
|
361
|
+
duplicateRaw(requestParameters: AccountsApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<number>>;
|
|
362
|
+
/**
|
|
363
|
+
* Creates a new account owned by the authenticated user and copies the current account\'s content into it: projects, dashboards, floor plans, properties, object groups, top-down models, scenarios, datasets, space rulesets, variables, and files with their folders. Archived projects, object groups, scenarios and top-down models are copied and stay archived. Data collections are copied as drafts without their contributors. Members and their roles, sign-in settings, API keys, scripts, assistant conversations and the audit log are not copied; the caller is the new account\'s only member. Returns the new account\'s identifier. Copying runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account; it returns `500 account-setup-failed` if the content could not be copied, and the incomplete account is then deleted, after which polling it returns `403`. Account names are unique; reusing one returns `400 account-name-in-use`. Requires a token for the account being duplicated, holding the *Manage my account* permission; a token for no account returns `400`. A script\'s own API key cannot duplicate an account.
|
|
364
|
+
* Duplicate the current account
|
|
365
|
+
*/
|
|
366
|
+
duplicate(requestParameters: AccountsApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
|
|
340
367
|
/**
|
|
341
368
|
* Returns the account the access token was issued for. Use `GET /v1/account/profile` for the full profile, including address and notification preferences. Requires the *View account overview* permission.
|
|
342
369
|
* Get the current account
|
|
@@ -388,12 +415,12 @@ export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiI
|
|
|
388
415
|
*/
|
|
389
416
|
getProfile(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountDetailsResBody>;
|
|
390
417
|
/**
|
|
391
|
-
* Long-polls until the account created by `POST /v1/accounts` has finished being seeded
|
|
418
|
+
* Long-polls until the account created by `POST /v1/accounts` or `POST /v1/account/duplicate` has finished being seeded with its starting content, then returns `204`. The request is held open for up to 90 seconds and returns `408` if setup has not completed by then; call it again to keep waiting. Returns `500 account-setup-failed` if the content could not be copied; the account exists but is incomplete. The caller must be a member of the account and hold the *Manage my account* permission.
|
|
392
419
|
* Wait for account setup to finish
|
|
393
420
|
*/
|
|
394
421
|
getSetupStatusRaw(requestParameters: AccountsApiGetSetupStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
395
422
|
/**
|
|
396
|
-
* Long-polls until the account created by `POST /v1/accounts` has finished being seeded
|
|
423
|
+
* Long-polls until the account created by `POST /v1/accounts` or `POST /v1/account/duplicate` has finished being seeded with its starting content, then returns `204`. The request is held open for up to 90 seconds and returns `408` if setup has not completed by then; call it again to keep waiting. Returns `500 account-setup-failed` if the content could not be copied; the account exists but is incomplete. The caller must be a member of the account and hold the *Manage my account* permission.
|
|
397
424
|
* Wait for account setup to finish
|
|
398
425
|
*/
|
|
399
426
|
getSetupStatus(requestParameters: AccountsApiGetSetupStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
package/dist/apis/AccountsApi.js
CHANGED
|
@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
|
|
|
30
30
|
*/
|
|
31
31
|
class AccountsApi extends runtime.BaseAPI {
|
|
32
32
|
/**
|
|
33
|
-
* Creates an account owned by the authenticated user and returns its identifier.
|
|
33
|
+
* Creates an account owned by the authenticated user and returns its identifier. The account is seeded from the prebuilt account for the chosen template (`blank` starts almost empty). Seeding runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account. Account names are unique; reusing one returns `400 account-name-in-use`. Requires the *Manage my account* permission.
|
|
34
34
|
* Create an account
|
|
35
35
|
*/
|
|
36
36
|
createRaw(requestParameters, initOverrides) {
|
|
@@ -65,7 +65,7 @@ class AccountsApi extends runtime.BaseAPI {
|
|
|
65
65
|
});
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
|
-
* Creates an account owned by the authenticated user and returns its identifier.
|
|
68
|
+
* Creates an account owned by the authenticated user and returns its identifier. The account is seeded from the prebuilt account for the chosen template (`blank` starts almost empty). Seeding runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account. Account names are unique; reusing one returns `400 account-name-in-use`. Requires the *Manage my account* permission.
|
|
69
69
|
* Create an account
|
|
70
70
|
*/
|
|
71
71
|
create(requestParameters, initOverrides) {
|
|
@@ -182,6 +182,51 @@ class AccountsApi extends runtime.BaseAPI {
|
|
|
182
182
|
yield this.deleteOidcProviderRaw(initOverrides);
|
|
183
183
|
});
|
|
184
184
|
}
|
|
185
|
+
/**
|
|
186
|
+
* Creates a new account owned by the authenticated user and copies the current account\'s content into it: projects, dashboards, floor plans, properties, object groups, top-down models, scenarios, datasets, space rulesets, variables, and files with their folders. Archived projects, object groups, scenarios and top-down models are copied and stay archived. Data collections are copied as drafts without their contributors. Members and their roles, sign-in settings, API keys, scripts, assistant conversations and the audit log are not copied; the caller is the new account\'s only member. Returns the new account\'s identifier. Copying runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account; it returns `500 account-setup-failed` if the content could not be copied, and the incomplete account is then deleted, after which polling it returns `403`. Account names are unique; reusing one returns `400 account-name-in-use`. Requires a token for the account being duplicated, holding the *Manage my account* permission; a token for no account returns `400`. A script\'s own API key cannot duplicate an account.
|
|
187
|
+
* Duplicate the current account
|
|
188
|
+
*/
|
|
189
|
+
duplicateRaw(requestParameters, initOverrides) {
|
|
190
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
191
|
+
if (requestParameters['accountDuplicateReqBody'] == null) {
|
|
192
|
+
throw new runtime.RequiredError('accountDuplicateReqBody', 'Required parameter "accountDuplicateReqBody" was null or undefined when calling duplicate().');
|
|
193
|
+
}
|
|
194
|
+
const queryParameters = {};
|
|
195
|
+
const headerParameters = {};
|
|
196
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
197
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
198
|
+
const token = this.configuration.accessToken;
|
|
199
|
+
const tokenString = yield token("accessToken", []);
|
|
200
|
+
if (tokenString) {
|
|
201
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
let urlPath = `/v1/account/duplicate`;
|
|
205
|
+
const response = yield this.request({
|
|
206
|
+
path: urlPath,
|
|
207
|
+
method: 'POST',
|
|
208
|
+
headers: headerParameters,
|
|
209
|
+
query: queryParameters,
|
|
210
|
+
body: (0, index_1.AccountDuplicateReqBodyToJSON)(requestParameters['accountDuplicateReqBody']),
|
|
211
|
+
}, initOverrides);
|
|
212
|
+
if (this.isJsonMime(response.headers.get('content-type'))) {
|
|
213
|
+
return new runtime.JSONApiResponse(response);
|
|
214
|
+
}
|
|
215
|
+
else {
|
|
216
|
+
return new runtime.TextApiResponse(response);
|
|
217
|
+
}
|
|
218
|
+
});
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* Creates a new account owned by the authenticated user and copies the current account\'s content into it: projects, dashboards, floor plans, properties, object groups, top-down models, scenarios, datasets, space rulesets, variables, and files with their folders. Archived projects, object groups, scenarios and top-down models are copied and stay archived. Data collections are copied as drafts without their contributors. Members and their roles, sign-in settings, API keys, scripts, assistant conversations and the audit log are not copied; the caller is the new account\'s only member. Returns the new account\'s identifier. Copying runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account; it returns `500 account-setup-failed` if the content could not be copied, and the incomplete account is then deleted, after which polling it returns `403`. Account names are unique; reusing one returns `400 account-name-in-use`. Requires a token for the account being duplicated, holding the *Manage my account* permission; a token for no account returns `400`. A script\'s own API key cannot duplicate an account.
|
|
222
|
+
* Duplicate the current account
|
|
223
|
+
*/
|
|
224
|
+
duplicate(requestParameters, initOverrides) {
|
|
225
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
226
|
+
const response = yield this.duplicateRaw(requestParameters, initOverrides);
|
|
227
|
+
return yield response.value();
|
|
228
|
+
});
|
|
229
|
+
}
|
|
185
230
|
/**
|
|
186
231
|
* Returns the account the access token was issued for. Use `GET /v1/account/profile` for the full profile, including address and notification preferences. Requires the *View account overview* permission.
|
|
187
232
|
* Get the current account
|
|
@@ -357,7 +402,7 @@ class AccountsApi extends runtime.BaseAPI {
|
|
|
357
402
|
});
|
|
358
403
|
}
|
|
359
404
|
/**
|
|
360
|
-
* Long-polls until the account created by `POST /v1/accounts` has finished being seeded
|
|
405
|
+
* Long-polls until the account created by `POST /v1/accounts` or `POST /v1/account/duplicate` has finished being seeded with its starting content, then returns `204`. The request is held open for up to 90 seconds and returns `408` if setup has not completed by then; call it again to keep waiting. Returns `500 account-setup-failed` if the content could not be copied; the account exists but is incomplete. The caller must be a member of the account and hold the *Manage my account* permission.
|
|
361
406
|
* Wait for account setup to finish
|
|
362
407
|
*/
|
|
363
408
|
getSetupStatusRaw(requestParameters, initOverrides) {
|
|
@@ -386,7 +431,7 @@ class AccountsApi extends runtime.BaseAPI {
|
|
|
386
431
|
});
|
|
387
432
|
}
|
|
388
433
|
/**
|
|
389
|
-
* Long-polls until the account created by `POST /v1/accounts` has finished being seeded
|
|
434
|
+
* Long-polls until the account created by `POST /v1/accounts` or `POST /v1/account/duplicate` has finished being seeded with its starting content, then returns `204`. The request is held open for up to 90 seconds and returns `408` if setup has not completed by then; call it again to keep waiting. Returns `500 account-setup-failed` if the content could not be copied; the account exists but is incomplete. The caller must be a member of the account and hold the *Manage my account* permission.
|
|
390
435
|
* Wait for account setup to finish
|
|
391
436
|
*/
|
|
392
437
|
getSetupStatus(requestParameters, initOverrides) {
|
|
@@ -68,7 +68,7 @@ export interface InternalApiInterface {
|
|
|
68
68
|
*/
|
|
69
69
|
createAdminFlushDeadLetters(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
70
70
|
/**
|
|
71
|
-
* Copies all scenarios, properties, object groups, top-down models, datasets, space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
|
|
71
|
+
* Copies all files and their folders, scenarios, properties, object groups and their images, top-down models, datasets, data collections (as drafts without contributors), space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
|
|
72
72
|
* @summary Populate account from template
|
|
73
73
|
* @param {number} body
|
|
74
74
|
* @param {*} [options] Override http request option.
|
|
@@ -77,7 +77,7 @@ export interface InternalApiInterface {
|
|
|
77
77
|
*/
|
|
78
78
|
createAdminPopulateRaw(requestParameters: InternalApiCreateAdminPopulateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
79
79
|
/**
|
|
80
|
-
* Copies all scenarios, properties, object groups, top-down models, datasets, space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
|
|
80
|
+
* Copies all files and their folders, scenarios, properties, object groups and their images, top-down models, datasets, data collections (as drafts without contributors), space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
|
|
81
81
|
* Populate account from template
|
|
82
82
|
*/
|
|
83
83
|
createAdminPopulate(requestParameters: InternalApiCreateAdminPopulateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -245,12 +245,12 @@ export declare class InternalApi extends runtime.BaseAPI implements InternalApiI
|
|
|
245
245
|
*/
|
|
246
246
|
createAdminFlushDeadLetters(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
247
247
|
/**
|
|
248
|
-
* Copies all scenarios, properties, object groups, top-down models, datasets, space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
|
|
248
|
+
* Copies all files and their folders, scenarios, properties, object groups and their images, top-down models, datasets, data collections (as drafts without contributors), space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
|
|
249
249
|
* Populate account from template
|
|
250
250
|
*/
|
|
251
251
|
createAdminPopulateRaw(requestParameters: InternalApiCreateAdminPopulateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
252
252
|
/**
|
|
253
|
-
* Copies all scenarios, properties, object groups, top-down models, datasets, space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
|
|
253
|
+
* Copies all files and their folders, scenarios, properties, object groups and their images, top-down models, datasets, data collections (as drafts without contributors), space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
|
|
254
254
|
* Populate account from template
|
|
255
255
|
*/
|
|
256
256
|
createAdminPopulate(requestParameters: InternalApiCreateAdminPopulateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
package/dist/apis/InternalApi.js
CHANGED
|
@@ -105,7 +105,7 @@ class InternalApi extends runtime.BaseAPI {
|
|
|
105
105
|
});
|
|
106
106
|
}
|
|
107
107
|
/**
|
|
108
|
-
* Copies all scenarios, properties, object groups, top-down models, datasets, space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
|
|
108
|
+
* Copies all files and their folders, scenarios, properties, object groups and their images, top-down models, datasets, data collections (as drafts without contributors), space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
|
|
109
109
|
* Populate account from template
|
|
110
110
|
*/
|
|
111
111
|
createAdminPopulateRaw(requestParameters, initOverrides) {
|
|
@@ -135,7 +135,7 @@ class InternalApi extends runtime.BaseAPI {
|
|
|
135
135
|
});
|
|
136
136
|
}
|
|
137
137
|
/**
|
|
138
|
-
* Copies all scenarios, properties, object groups, top-down models, datasets, space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
|
|
138
|
+
* Copies all files and their folders, scenarios, properties, object groups and their images, top-down models, datasets, data collections (as drafts without contributors), space rulesets, projects, dashboards, floor plans, and account variables from a named template account into the caller\'s account. Local development uses the seeded local template account for both data and files, and returns 409 until its data and available files are imported. Populating an account from itself is rejected. Requires the *Project admin controls* and *Sys admin* permissions.
|
|
139
139
|
* Populate account from template
|
|
140
140
|
*/
|
|
141
141
|
createAdminPopulate(requestParameters, initOverrides) {
|
|
@@ -252,7 +252,7 @@ export interface ObjectGroupsApiInterface {
|
|
|
252
252
|
*/
|
|
253
253
|
listEntries(requestParameters: ObjectGroupsApiListEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectGroupEntriesRes>;
|
|
254
254
|
/**
|
|
255
|
-
* Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission.
|
|
255
|
+
* Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission, and *View file storage* to link a File property to a file it was not already linked to.
|
|
256
256
|
* @summary Upsert entries in an object group
|
|
257
257
|
* @param {string} id
|
|
258
258
|
* @param {Array<ObjectGroupEntryUpdate>} objectGroupEntryUpdate
|
|
@@ -262,7 +262,7 @@ export interface ObjectGroupsApiInterface {
|
|
|
262
262
|
*/
|
|
263
263
|
replaceEntriesRaw(requestParameters: ObjectGroupsApiReplaceEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
264
264
|
/**
|
|
265
|
-
* Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission.
|
|
265
|
+
* Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission, and *View file storage* to link a File property to a file it was not already linked to.
|
|
266
266
|
* Upsert entries in an object group
|
|
267
267
|
*/
|
|
268
268
|
replaceEntries(requestParameters: ObjectGroupsApiReplaceEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -300,7 +300,7 @@ export interface ObjectGroupsApiInterface {
|
|
|
300
300
|
*/
|
|
301
301
|
update(requestParameters: ObjectGroupsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
302
302
|
/**
|
|
303
|
-
* Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them. Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is. Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission.
|
|
303
|
+
* Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them. Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is. Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission, and *View file storage* to link a File property to a file it was not already linked to.
|
|
304
304
|
* @summary Partially update entries in an object group
|
|
305
305
|
* @param {string} id
|
|
306
306
|
* @param {Array<EntryPatch>} entryPatch
|
|
@@ -310,7 +310,7 @@ export interface ObjectGroupsApiInterface {
|
|
|
310
310
|
*/
|
|
311
311
|
updateEntriesRaw(requestParameters: ObjectGroupsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
312
312
|
/**
|
|
313
|
-
* Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them. Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is. Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission.
|
|
313
|
+
* Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them. Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is. Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission, and *View file storage* to link a File property to a file it was not already linked to.
|
|
314
314
|
* Partially update entries in an object group
|
|
315
315
|
*/
|
|
316
316
|
updateEntries(requestParameters: ObjectGroupsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -463,12 +463,12 @@ export declare class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGr
|
|
|
463
463
|
*/
|
|
464
464
|
listEntries(requestParameters: ObjectGroupsApiListEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ObjectGroupEntriesRes>;
|
|
465
465
|
/**
|
|
466
|
-
* Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission.
|
|
466
|
+
* Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission, and *View file storage* to link a File property to a file it was not already linked to.
|
|
467
467
|
* Upsert entries in an object group
|
|
468
468
|
*/
|
|
469
469
|
replaceEntriesRaw(requestParameters: ObjectGroupsApiReplaceEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
470
470
|
/**
|
|
471
|
-
* Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission.
|
|
471
|
+
* Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission, and *View file storage* to link a File property to a file it was not already linked to.
|
|
472
472
|
* Upsert entries in an object group
|
|
473
473
|
*/
|
|
474
474
|
replaceEntries(requestParameters: ObjectGroupsApiReplaceEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -493,12 +493,12 @@ export declare class ObjectGroupsApi extends runtime.BaseAPI implements ObjectGr
|
|
|
493
493
|
*/
|
|
494
494
|
update(requestParameters: ObjectGroupsApiUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
495
495
|
/**
|
|
496
|
-
* Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them. Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is. Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission.
|
|
496
|
+
* Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them. Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is. Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission, and *View file storage* to link a File property to a file it was not already linked to.
|
|
497
497
|
* Partially update entries in an object group
|
|
498
498
|
*/
|
|
499
499
|
updateEntriesRaw(requestParameters: ObjectGroupsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
500
500
|
/**
|
|
501
|
-
* Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them. Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is. Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission.
|
|
501
|
+
* Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them. Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is. Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission, and *View file storage* to link a File property to a file it was not already linked to.
|
|
502
502
|
* Partially update entries in an object group
|
|
503
503
|
*/
|
|
504
504
|
updateEntries(requestParameters: ObjectGroupsApiUpdateEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -504,7 +504,7 @@ class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
504
504
|
});
|
|
505
505
|
}
|
|
506
506
|
/**
|
|
507
|
-
* Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission.
|
|
507
|
+
* Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission, and *View file storage* to link a File property to a file it was not already linked to.
|
|
508
508
|
* Upsert entries in an object group
|
|
509
509
|
*/
|
|
510
510
|
replaceEntriesRaw(requestParameters, initOverrides) {
|
|
@@ -538,7 +538,7 @@ class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
538
538
|
});
|
|
539
539
|
}
|
|
540
540
|
/**
|
|
541
|
-
* Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission.
|
|
541
|
+
* Creates or updates one or more entries within the specified object group in a single request. Each item in the body must include an `id`; if an entry with that ID already exists it is updated, otherwise a new entry is created. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely; entries are written one at a time, so a failure part way through leaves the earlier ones written. Requires the *Edit objects* permission, and *View file storage* to link a File property to a file it was not already linked to.
|
|
542
542
|
* Upsert entries in an object group
|
|
543
543
|
*/
|
|
544
544
|
replaceEntries(requestParameters, initOverrides) {
|
|
@@ -638,7 +638,7 @@ class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
638
638
|
});
|
|
639
639
|
}
|
|
640
640
|
/**
|
|
641
|
-
* Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them. Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is. Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission.
|
|
641
|
+
* Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them. Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is. Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission, and *View file storage* to link a File property to a file it was not already linked to.
|
|
642
642
|
* Partially update entries in an object group
|
|
643
643
|
*/
|
|
644
644
|
updateEntriesRaw(requestParameters, initOverrides) {
|
|
@@ -672,7 +672,7 @@ class ObjectGroupsApi extends runtime.BaseAPI {
|
|
|
672
672
|
});
|
|
673
673
|
}
|
|
674
674
|
/**
|
|
675
|
-
* Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them. Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is. Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission.
|
|
675
|
+
* Applies a partial update to one or more existing entries within the specified object group. Each item in the body must include the `id` of an entry that already exists, and the same `id` cannot be listed twice; use `PUT` to create entries and `DELETE` to remove them. Only the fields present in an item are changed, and `properties` merges one property at a time: a property named in the request replaces that property\'s nodes, a property named with a `null` value or an empty `nodes` map is removed from the entry, and a property the request does not name is left as-is. Every entry is resolved before any of them is written, so a `404` means nothing was changed; an entry deleted after that point reports as a `409` instead. Writing is one transaction per entry rather than a single atomic batch, so a failure once writing has begun leaves the earlier entries updated; the error names them. Re-sending the same request finishes the job, since applying a patch twice is a no-op. Returns `409` if an entry is being changed concurrently and the write cannot be retried safely. Requires the *Edit objects* permission, and *View file storage* to link a File property to a file it was not already linked to.
|
|
676
676
|
* Partially update entries in an object group
|
|
677
677
|
*/
|
|
678
678
|
updateEntries(requestParameters, initOverrides) {
|
|
@@ -10,13 +10,16 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { Account, AccountAuthOption, AccountCalculationUsageBody, AccountDetailsResBody, AccountGetAuthOptionsResBody, AccountOIDCProvider, AccountOIDCProviderPatch, AccountPatchAuthOptionsReqBody, AccountPostOIDCProviderReqBody, AccountPostReqBody, AccountPutOIDCClientSecretReqBody, AccountPutReqBody, AccountUsageResBody, ListAccountsForUserRow } from '../models/index';
|
|
13
|
+
import type { Account, AccountAuthOption, AccountCalculationUsageBody, AccountDetailsResBody, AccountDuplicateReqBody, AccountGetAuthOptionsResBody, AccountOIDCProvider, AccountOIDCProviderPatch, AccountPatchAuthOptionsReqBody, AccountPostOIDCProviderReqBody, AccountPostReqBody, AccountPutOIDCClientSecretReqBody, AccountPutReqBody, AccountUsageResBody, ListAccountsForUserRow } from '../models/index';
|
|
14
14
|
export interface AccountsApiCreateRequest {
|
|
15
15
|
accountPostReqBody: AccountPostReqBody;
|
|
16
16
|
}
|
|
17
17
|
export interface AccountsApiCreateOidcProviderRequest {
|
|
18
18
|
accountPostOIDCProviderReqBody: AccountPostOIDCProviderReqBody;
|
|
19
19
|
}
|
|
20
|
+
export interface AccountsApiDuplicateRequest {
|
|
21
|
+
accountDuplicateReqBody: AccountDuplicateReqBody;
|
|
22
|
+
}
|
|
20
23
|
export interface AccountsApiGetAuthOptionsRequest {
|
|
21
24
|
hostname: string;
|
|
22
25
|
}
|
|
@@ -49,7 +52,7 @@ export interface AccountsApiUpdateOidcProviderClientSecretRequest {
|
|
|
49
52
|
*/
|
|
50
53
|
export interface AccountsApiInterface {
|
|
51
54
|
/**
|
|
52
|
-
* Creates an account owned by the authenticated user and returns its identifier.
|
|
55
|
+
* Creates an account owned by the authenticated user and returns its identifier. The account is seeded from the prebuilt account for the chosen template (`blank` starts almost empty). Seeding runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account. Account names are unique; reusing one returns `400 account-name-in-use`. Requires the *Manage my account* permission.
|
|
53
56
|
* @summary Create an account
|
|
54
57
|
* @param {AccountPostReqBody} accountPostReqBody
|
|
55
58
|
* @param {*} [options] Override http request option.
|
|
@@ -58,7 +61,7 @@ export interface AccountsApiInterface {
|
|
|
58
61
|
*/
|
|
59
62
|
createRaw(requestParameters: AccountsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<number>>;
|
|
60
63
|
/**
|
|
61
|
-
* Creates an account owned by the authenticated user and returns its identifier.
|
|
64
|
+
* Creates an account owned by the authenticated user and returns its identifier. The account is seeded from the prebuilt account for the chosen template (`blank` starts almost empty). Seeding runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account. Account names are unique; reusing one returns `400 account-name-in-use`. Requires the *Manage my account* permission.
|
|
62
65
|
* Create an account
|
|
63
66
|
*/
|
|
64
67
|
create(requestParameters: AccountsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
|
|
@@ -102,6 +105,20 @@ export interface AccountsApiInterface {
|
|
|
102
105
|
* Delete the current account\'s OIDC provider
|
|
103
106
|
*/
|
|
104
107
|
deleteOidcProvider(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
108
|
+
/**
|
|
109
|
+
* Creates a new account owned by the authenticated user and copies the current account\'s content into it: projects, dashboards, floor plans, properties, object groups, top-down models, scenarios, datasets, space rulesets, variables, and files with their folders. Archived projects, object groups, scenarios and top-down models are copied and stay archived. Data collections are copied as drafts without their contributors. Members and their roles, sign-in settings, API keys, scripts, assistant conversations and the audit log are not copied; the caller is the new account\'s only member. Returns the new account\'s identifier. Copying runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account; it returns `500 account-setup-failed` if the content could not be copied, and the incomplete account is then deleted, after which polling it returns `403`. Account names are unique; reusing one returns `400 account-name-in-use`. Requires a token for the account being duplicated, holding the *Manage my account* permission; a token for no account returns `400`. A script\'s own API key cannot duplicate an account.
|
|
110
|
+
* @summary Duplicate the current account
|
|
111
|
+
* @param {AccountDuplicateReqBody} accountDuplicateReqBody
|
|
112
|
+
* @param {*} [options] Override http request option.
|
|
113
|
+
* @throws {RequiredError}
|
|
114
|
+
* @memberof AccountsApiInterface
|
|
115
|
+
*/
|
|
116
|
+
duplicateRaw(requestParameters: AccountsApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<number>>;
|
|
117
|
+
/**
|
|
118
|
+
* Creates a new account owned by the authenticated user and copies the current account\'s content into it: projects, dashboards, floor plans, properties, object groups, top-down models, scenarios, datasets, space rulesets, variables, and files with their folders. Archived projects, object groups, scenarios and top-down models are copied and stay archived. Data collections are copied as drafts without their contributors. Members and their roles, sign-in settings, API keys, scripts, assistant conversations and the audit log are not copied; the caller is the new account\'s only member. Returns the new account\'s identifier. Copying runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account; it returns `500 account-setup-failed` if the content could not be copied, and the incomplete account is then deleted, after which polling it returns `403`. Account names are unique; reusing one returns `400 account-name-in-use`. Requires a token for the account being duplicated, holding the *Manage my account* permission; a token for no account returns `400`. A script\'s own API key cannot duplicate an account.
|
|
119
|
+
* Duplicate the current account
|
|
120
|
+
*/
|
|
121
|
+
duplicate(requestParameters: AccountsApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
|
|
105
122
|
/**
|
|
106
123
|
* Returns the account the access token was issued for. Use `GET /v1/account/profile` for the full profile, including address and notification preferences. Requires the *View account overview* permission.
|
|
107
124
|
* @summary Get the current account
|
|
@@ -170,16 +187,16 @@ export interface AccountsApiInterface {
|
|
|
170
187
|
*/
|
|
171
188
|
getProfile(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountDetailsResBody>;
|
|
172
189
|
/**
|
|
173
|
-
* Long-polls until the account created by `POST /v1/accounts` has finished being seeded
|
|
190
|
+
* Long-polls until the account created by `POST /v1/accounts` or `POST /v1/account/duplicate` has finished being seeded with its starting content, then returns `204`. The request is held open for up to 90 seconds and returns `408` if setup has not completed by then; call it again to keep waiting. Returns `500 account-setup-failed` if the content could not be copied; the account exists but is incomplete. The caller must be a member of the account and hold the *Manage my account* permission.
|
|
174
191
|
* @summary Wait for account setup to finish
|
|
175
|
-
* @param {number} id Identifier returned by POST /v1/accounts.
|
|
192
|
+
* @param {number} id Identifier returned by POST /v1/accounts or POST /v1/account/duplicate.
|
|
176
193
|
* @param {*} [options] Override http request option.
|
|
177
194
|
* @throws {RequiredError}
|
|
178
195
|
* @memberof AccountsApiInterface
|
|
179
196
|
*/
|
|
180
197
|
getSetupStatusRaw(requestParameters: AccountsApiGetSetupStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
181
198
|
/**
|
|
182
|
-
* Long-polls until the account created by `POST /v1/accounts` has finished being seeded
|
|
199
|
+
* Long-polls until the account created by `POST /v1/accounts` or `POST /v1/account/duplicate` has finished being seeded with its starting content, then returns `204`. The request is held open for up to 90 seconds and returns `408` if setup has not completed by then; call it again to keep waiting. Returns `500 account-setup-failed` if the content could not be copied; the account exists but is incomplete. The caller must be a member of the account and hold the *Manage my account* permission.
|
|
183
200
|
* Wait for account setup to finish
|
|
184
201
|
*/
|
|
185
202
|
getSetupStatus(requestParameters: AccountsApiGetSetupStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -298,12 +315,12 @@ export interface AccountsApiInterface {
|
|
|
298
315
|
*/
|
|
299
316
|
export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiInterface {
|
|
300
317
|
/**
|
|
301
|
-
* Creates an account owned by the authenticated user and returns its identifier.
|
|
318
|
+
* Creates an account owned by the authenticated user and returns its identifier. The account is seeded from the prebuilt account for the chosen template (`blank` starts almost empty). Seeding runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account. Account names are unique; reusing one returns `400 account-name-in-use`. Requires the *Manage my account* permission.
|
|
302
319
|
* Create an account
|
|
303
320
|
*/
|
|
304
321
|
createRaw(requestParameters: AccountsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<number>>;
|
|
305
322
|
/**
|
|
306
|
-
* Creates an account owned by the authenticated user and returns its identifier.
|
|
323
|
+
* Creates an account owned by the authenticated user and returns its identifier. The account is seeded from the prebuilt account for the chosen template (`blank` starts almost empty). Seeding runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account. Account names are unique; reusing one returns `400 account-name-in-use`. Requires the *Manage my account* permission.
|
|
307
324
|
* Create an account
|
|
308
325
|
*/
|
|
309
326
|
create(requestParameters: AccountsApiCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
|
|
@@ -337,6 +354,16 @@ export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiI
|
|
|
337
354
|
* Delete the current account\'s OIDC provider
|
|
338
355
|
*/
|
|
339
356
|
deleteOidcProvider(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
357
|
+
/**
|
|
358
|
+
* Creates a new account owned by the authenticated user and copies the current account\'s content into it: projects, dashboards, floor plans, properties, object groups, top-down models, scenarios, datasets, space rulesets, variables, and files with their folders. Archived projects, object groups, scenarios and top-down models are copied and stay archived. Data collections are copied as drafts without their contributors. Members and their roles, sign-in settings, API keys, scripts, assistant conversations and the audit log are not copied; the caller is the new account\'s only member. Returns the new account\'s identifier. Copying runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account; it returns `500 account-setup-failed` if the content could not be copied, and the incomplete account is then deleted, after which polling it returns `403`. Account names are unique; reusing one returns `400 account-name-in-use`. Requires a token for the account being duplicated, holding the *Manage my account* permission; a token for no account returns `400`. A script\'s own API key cannot duplicate an account.
|
|
359
|
+
* Duplicate the current account
|
|
360
|
+
*/
|
|
361
|
+
duplicateRaw(requestParameters: AccountsApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<number>>;
|
|
362
|
+
/**
|
|
363
|
+
* Creates a new account owned by the authenticated user and copies the current account\'s content into it: projects, dashboards, floor plans, properties, object groups, top-down models, scenarios, datasets, space rulesets, variables, and files with their folders. Archived projects, object groups, scenarios and top-down models are copied and stay archived. Data collections are copied as drafts without their contributors. Members and their roles, sign-in settings, API keys, scripts, assistant conversations and the audit log are not copied; the caller is the new account\'s only member. Returns the new account\'s identifier. Copying runs in the background, so poll `GET /v1/accounts/{id}/setup-status` until it succeeds before sending the user into the new account; it returns `500 account-setup-failed` if the content could not be copied, and the incomplete account is then deleted, after which polling it returns `403`. Account names are unique; reusing one returns `400 account-name-in-use`. Requires a token for the account being duplicated, holding the *Manage my account* permission; a token for no account returns `400`. A script\'s own API key cannot duplicate an account.
|
|
364
|
+
* Duplicate the current account
|
|
365
|
+
*/
|
|
366
|
+
duplicate(requestParameters: AccountsApiDuplicateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<number>;
|
|
340
367
|
/**
|
|
341
368
|
* Returns the account the access token was issued for. Use `GET /v1/account/profile` for the full profile, including address and notification preferences. Requires the *View account overview* permission.
|
|
342
369
|
* Get the current account
|
|
@@ -388,12 +415,12 @@ export declare class AccountsApi extends runtime.BaseAPI implements AccountsApiI
|
|
|
388
415
|
*/
|
|
389
416
|
getProfile(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountDetailsResBody>;
|
|
390
417
|
/**
|
|
391
|
-
* Long-polls until the account created by `POST /v1/accounts` has finished being seeded
|
|
418
|
+
* Long-polls until the account created by `POST /v1/accounts` or `POST /v1/account/duplicate` has finished being seeded with its starting content, then returns `204`. The request is held open for up to 90 seconds and returns `408` if setup has not completed by then; call it again to keep waiting. Returns `500 account-setup-failed` if the content could not be copied; the account exists but is incomplete. The caller must be a member of the account and hold the *Manage my account* permission.
|
|
392
419
|
* Wait for account setup to finish
|
|
393
420
|
*/
|
|
394
421
|
getSetupStatusRaw(requestParameters: AccountsApiGetSetupStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
395
422
|
/**
|
|
396
|
-
* Long-polls until the account created by `POST /v1/accounts` has finished being seeded
|
|
423
|
+
* Long-polls until the account created by `POST /v1/accounts` or `POST /v1/account/duplicate` has finished being seeded with its starting content, then returns `204`. The request is held open for up to 90 seconds and returns `408` if setup has not completed by then; call it again to keep waiting. Returns `500 account-setup-failed` if the content could not be copied; the account exists but is incomplete. The caller must be a member of the account and hold the *Manage my account* permission.
|
|
397
424
|
* Wait for account setup to finish
|
|
398
425
|
*/
|
|
399
426
|
getSetupStatus(requestParameters: AccountsApiGetSetupStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|