@space-df/sdk 0.0.1-dev.12 → 0.0.1-dev.14
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/api.doc.md +250 -217
- package/dist/package.json +1 -1
- package/dist/resources/auth/auth.d.ts +0 -1
- package/dist/resources/auth/auth.d.ts.map +1 -1
- package/dist/resources/auth/space-policies.d.ts +6 -3
- package/dist/resources/auth/space-policies.d.ts.map +1 -1
- package/dist/resources/auth/space-policies.js +16 -5
- package/dist/resources/auth/space-policies.js.map +1 -1
- package/dist/resources/auth/space-policies.mjs +16 -5
- package/dist/resources/auth/space-policies.mjs.map +1 -1
- package/dist/resources/auth/space-role-users.d.ts +11 -6
- package/dist/resources/auth/space-role-users.d.ts.map +1 -1
- package/dist/resources/auth/space-role-users.js +19 -10
- package/dist/resources/auth/space-role-users.js.map +1 -1
- package/dist/resources/auth/space-role-users.mjs +19 -10
- package/dist/resources/auth/space-role-users.mjs.map +1 -1
- package/dist/resources/auth/space-roles.d.ts +14 -3
- package/dist/resources/auth/space-roles.d.ts.map +1 -1
- package/dist/resources/auth/space-roles.js +14 -12
- package/dist/resources/auth/space-roles.js.map +1 -1
- package/dist/resources/auth/space-roles.mjs +14 -12
- package/dist/resources/auth/space-roles.mjs.map +1 -1
- package/dist/resources/auth/spaces.d.ts +11 -3
- package/dist/resources/auth/spaces.d.ts.map +1 -1
- package/dist/resources/auth/spaces.js +14 -8
- package/dist/resources/auth/spaces.js.map +1 -1
- package/dist/resources/auth/spaces.mjs +14 -8
- package/dist/resources/auth/spaces.mjs.map +1 -1
- package/dist/src/resources/auth/auth.ts +0 -2
- package/dist/src/resources/auth/space-policies.ts +22 -7
- package/dist/src/resources/auth/space-role-users.ts +29 -14
- package/dist/src/resources/auth/space-roles.ts +27 -12
- package/dist/src/resources/auth/spaces.ts +26 -11
- package/dist/src/version.ts +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/version.mjs +1 -1
- package/package.json +1 -1
- package/src/resources/auth/auth.ts +0 -2
- package/src/resources/auth/space-policies.ts +22 -7
- package/src/resources/auth/space-role-users.ts +29 -14
- package/src/resources/auth/space-roles.ts +27 -12
- package/src/resources/auth/spaces.ts +26 -11
- package/src/version.ts +1 -1
package/api.doc.md
CHANGED
|
@@ -9,16 +9,16 @@
|
|
|
9
9
|
|
|
10
10
|
# Table of Contents
|
|
11
11
|
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
12
|
+
- [Auth](#Auth)
|
|
13
|
+
- [Credentials](#credentials)
|
|
14
|
+
- [Space Policies](#space-policies)
|
|
15
|
+
- [Space Role Users](#space-role-users)
|
|
16
|
+
- [Space Roles](#space-roles)
|
|
17
|
+
- [Spaces](#spaces)
|
|
18
|
+
- [Oauth2](#oauth2)
|
|
19
|
+
- [Dashboards](#dashboards)
|
|
20
|
+
- [Device States](#deviceStates)
|
|
21
|
+
- [Users](#users)
|
|
22
22
|
|
|
23
23
|
# Auth
|
|
24
24
|
|
|
@@ -41,10 +41,10 @@ login(body: AuthLoginParams, options?: Core.RequestOptions): Core.APIPromise<Tok
|
|
|
41
41
|
|
|
42
42
|
**Parameters:**
|
|
43
43
|
|
|
44
|
-
-
|
|
45
|
-
-
|
|
46
|
-
-
|
|
47
|
-
-
|
|
44
|
+
- `body` _(AuthLoginParams)_: Object containing user credentials.
|
|
45
|
+
- `email` _(string)_: User's email address.
|
|
46
|
+
- `password` _(string)_: User's password.
|
|
47
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
48
48
|
|
|
49
49
|
**Returns:** `Promise<TokenPair>`
|
|
50
50
|
|
|
@@ -72,9 +72,9 @@ oauth2Google(body: AuthOauth2GoogleParams, options?: Core.RequestOptions): Core.
|
|
|
72
72
|
|
|
73
73
|
**Parameters:**
|
|
74
74
|
|
|
75
|
-
-
|
|
76
|
-
-
|
|
77
|
-
-
|
|
75
|
+
- `body` _(AuthOauth2GoogleParams)_: Object containing OAuth2 parameters.
|
|
76
|
+
- `authorization_code` _(string)_: The authorization code obtained from Google.
|
|
77
|
+
- `code_verifier` _(string)_: The code verifier for PKCE.
|
|
78
78
|
|
|
79
79
|
**Returns:** `Promise<OAuthLogin>`
|
|
80
80
|
|
|
@@ -102,8 +102,8 @@ googleLogin(body: GoogleLogin, options?: Core.RequestOptions): Core.APIPromise<A
|
|
|
102
102
|
|
|
103
103
|
**Parameters:**
|
|
104
104
|
|
|
105
|
-
-
|
|
106
|
-
-
|
|
105
|
+
- `body` _(GoogleLogin)_: Object containing the Google authorization code.
|
|
106
|
+
- `authorization_code` _(string)_: The authorization code received from Google OAuth2.
|
|
107
107
|
|
|
108
108
|
**Returns:** `Promise<AuthTokenPair>`
|
|
109
109
|
|
|
@@ -130,9 +130,9 @@ oauthSendOtp(body: OAuthSendOtp, options?: Core.RequestOptions): Core.APIPromise
|
|
|
130
130
|
|
|
131
131
|
**Parameters:**
|
|
132
132
|
|
|
133
|
-
-
|
|
134
|
-
-
|
|
135
|
-
-
|
|
133
|
+
- `body` _(OAuthSendOtp)_: Object containing user email.
|
|
134
|
+
- `email` _(string)_: The email address to send the OTP to.
|
|
135
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
136
136
|
|
|
137
137
|
**Returns:** `Promise<OAuthSendOtp>`
|
|
138
138
|
|
|
@@ -159,10 +159,10 @@ forgetPassword(body: ForgetPasswordParams, options?: Core.RequestOptions): Core.
|
|
|
159
159
|
|
|
160
160
|
**Parameters:**
|
|
161
161
|
|
|
162
|
-
-
|
|
163
|
-
-
|
|
164
|
-
-
|
|
165
|
-
-
|
|
162
|
+
- `body` _(ForgetPasswordParams)_: Object containing user credentials.
|
|
163
|
+
- `token` _(string)_: The token associated with the user's account.
|
|
164
|
+
- `password` _(string)_: The new password to set for the account.
|
|
165
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
166
166
|
|
|
167
167
|
**Returns:** `Promise<ForgetPasswordParams>`
|
|
168
168
|
|
|
@@ -190,9 +190,9 @@ sendEmailConfirm(body: OAuthSendEmail, options?: Core.RequestOptions): Core.APIP
|
|
|
190
190
|
|
|
191
191
|
**Parameters:**
|
|
192
192
|
|
|
193
|
-
-
|
|
194
|
-
-
|
|
195
|
-
-
|
|
193
|
+
- `body` _(OAuthSendEmail)_: Object containing user email.
|
|
194
|
+
- `email` _(string)_: The email address to send the confirmation link to.
|
|
195
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
196
196
|
|
|
197
197
|
**Returns:** `Promise<OAuthSendEmail>`
|
|
198
198
|
|
|
@@ -219,9 +219,8 @@ refreshToken(body: AuthRefreshTokenParams, options?: Core.RequestOptions): Core.
|
|
|
219
219
|
|
|
220
220
|
**Parameters:**
|
|
221
221
|
|
|
222
|
-
-
|
|
223
|
-
-
|
|
224
|
-
- `space_slug_name` _(string)_: The slug name of the workspace to refresh the token for.
|
|
222
|
+
- `body` _(AuthRefreshTokenParams)_: Object containing the refresh token.
|
|
223
|
+
- `refresh` _(string)_: Refresh token.
|
|
225
224
|
|
|
226
225
|
**Returns:** `Promise<CustomTokenRefresh>`
|
|
227
226
|
|
|
@@ -249,12 +248,12 @@ register(body: AuthRegisterParams, options?: Core.RequestOptions): Core.APIPromi
|
|
|
249
248
|
|
|
250
249
|
**Parameters:**
|
|
251
250
|
|
|
252
|
-
-
|
|
253
|
-
-
|
|
254
|
-
-
|
|
255
|
-
-
|
|
256
|
-
-
|
|
257
|
-
-
|
|
251
|
+
- `body` _(AuthRegisterParams)_: Object containing user registration details.
|
|
252
|
+
- `email` _(string)_: User's email address.
|
|
253
|
+
- `password` _(string)_: User's chosen password.
|
|
254
|
+
- `first_name` _(string)_: User's first name (optional).
|
|
255
|
+
- `last_name` _(string)_: User's last name (optional).
|
|
256
|
+
- `otp` _(string)_: User's OTP code (optional).
|
|
258
257
|
|
|
259
258
|
**Returns:** `Promise<Registration>`
|
|
260
259
|
|
|
@@ -284,11 +283,11 @@ oauth2SpaceDF(body: OAuthSpaceDF, options?: Core.RequestOptions): Core.APIPromis
|
|
|
284
283
|
|
|
285
284
|
**Parameters:**
|
|
286
285
|
|
|
287
|
-
-
|
|
288
|
-
-
|
|
289
|
-
-
|
|
290
|
-
-
|
|
291
|
-
-
|
|
286
|
+
- `body` _(OAuthSpaceDF)_: Object containing OAuth2 parameters.
|
|
287
|
+
- `code_verifier` _(string)_: The code verifier for PKCE.
|
|
288
|
+
- `code` _(string)_: The authorization code obtained from SpaceDF Console.
|
|
289
|
+
- `client_id` _(string)_: The client ID of the application.
|
|
290
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
292
291
|
|
|
293
292
|
**Returns:** `Promise<OAuthSpaceDF>`
|
|
294
293
|
|
|
@@ -317,10 +316,10 @@ switchSpaces(body: AuthRefreshTokenParams, options?: Core.RequestOptions): Core.
|
|
|
317
316
|
|
|
318
317
|
**Parameters:**
|
|
319
318
|
|
|
320
|
-
-
|
|
321
|
-
-
|
|
322
|
-
-
|
|
323
|
-
-
|
|
319
|
+
- `body` _(AuthRefreshTokenParams)_: Object containing the refresh token and target space.
|
|
320
|
+
- `refresh` _(string)_: Refresh token.
|
|
321
|
+
- `space` _(string)_: Target space to switch to.
|
|
322
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
324
323
|
|
|
325
324
|
**Returns:** `Promise<CustomTokenRefresh>`
|
|
326
325
|
|
|
@@ -358,8 +357,8 @@ retrieve(id: number, options?: Core.RequestOptions): Core.APIPromise<SpacePolicy
|
|
|
358
357
|
|
|
359
358
|
**Parameters:**
|
|
360
359
|
|
|
361
|
-
-
|
|
362
|
-
-
|
|
360
|
+
- `id` _(number)_: The ID of the space policy to retrieve.
|
|
361
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
363
362
|
|
|
364
363
|
**Returns:** `Promise<SpacePolicy>`
|
|
365
364
|
|
|
@@ -379,22 +378,23 @@ List all space policies or filter them based on query parameters.
|
|
|
379
378
|
**Signature:**
|
|
380
379
|
|
|
381
380
|
```typescript
|
|
382
|
-
list(query?: SpacePolicyListParams, options?: Core.RequestOptions): Core.APIPromise<SpacePolicyListResponse>;
|
|
383
|
-
list(options?: Core.RequestOptions): Core.APIPromise<SpacePolicyListResponse>;
|
|
384
|
-
list(query: SpacePolicyListParams | Core.RequestOptions = {}, options?: Core.RequestOptions): Core.APIPromise<SpacePolicyListResponse>
|
|
381
|
+
list(spaceName: string, query?: SpacePolicyListParams, options?: Core.RequestOptions): Core.APIPromise<SpacePolicyListResponse>;
|
|
382
|
+
list(spaceName: string, options?: Core.RequestOptions): Core.APIPromise<SpacePolicyListResponse>;
|
|
383
|
+
list(spaceName: string, query: SpacePolicyListParams | Core.RequestOptions = {}, options?: Core.RequestOptions): Core.APIPromise<SpacePolicyListResponse>
|
|
385
384
|
```
|
|
386
385
|
|
|
387
386
|
**Parameters:**
|
|
388
387
|
|
|
389
|
-
-
|
|
390
|
-
-
|
|
388
|
+
- `spaceName` _string_: The space slug name.
|
|
389
|
+
- `query` _(SpacePolicyListParams)_: (optional) Filters to apply when listing policies.
|
|
390
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
391
391
|
|
|
392
392
|
**Returns:** `Promise<SpacePolicyListResponse>`
|
|
393
393
|
|
|
394
394
|
**Example:**
|
|
395
395
|
|
|
396
396
|
```typescript
|
|
397
|
-
const spacePolicies = await client.spacePolicies.list({ page: 1, limit: 10 });
|
|
397
|
+
const spacePolicies = await client.spacePolicies.list('your-space-slug', { page: 1, limit: 10 });
|
|
398
398
|
```
|
|
399
399
|
|
|
400
400
|
</details>
|
|
@@ -417,15 +417,15 @@ Retrieve a specific space role user by their ID.
|
|
|
417
417
|
**Signature:**
|
|
418
418
|
|
|
419
419
|
```typescript
|
|
420
|
-
retrieve(id: number, params:
|
|
420
|
+
retrieve(id: number, params: SpaceRoleUsersParams, options?: Core.RequestOptions): Core.APIPromise<SpaceRoleUser>
|
|
421
421
|
```
|
|
422
422
|
|
|
423
423
|
**Parameters:**
|
|
424
424
|
|
|
425
|
-
-
|
|
426
|
-
-
|
|
427
|
-
-
|
|
428
|
-
-
|
|
425
|
+
- `id` _(number)_: The ID of the space role user to retrieve.
|
|
426
|
+
- `params` _(SpaceRoleUsersParams)_: Parameters containing the space slug.
|
|
427
|
+
- `X-Space`: _(string)_: Space slug name.
|
|
428
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
429
429
|
|
|
430
430
|
**Returns:** `Promise<SpaceRoleUser>`
|
|
431
431
|
|
|
@@ -445,21 +445,21 @@ List all space role users or filter them based on query parameters.
|
|
|
445
445
|
**Signature:**
|
|
446
446
|
|
|
447
447
|
```typescript
|
|
448
|
-
list(params:
|
|
448
|
+
list(spaceName: string, params: ListParamsResponse, options?: Core.RequestOptions): Core.APIPromise<SpaceRoleUserListResponse>
|
|
449
449
|
```
|
|
450
450
|
|
|
451
451
|
**Parameters:**
|
|
452
452
|
|
|
453
|
-
-
|
|
454
|
-
|
|
455
|
-
-
|
|
453
|
+
- `spaceName`: _(string)_: Header param for space slug name.
|
|
454
|
+
- `params` _(SpaceRoleUserListParams)_: Parameters containing any additional filters.
|
|
455
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
456
456
|
|
|
457
457
|
**Returns:** `Promise<SpaceRoleUserListResponse>`
|
|
458
458
|
|
|
459
459
|
**Example:**
|
|
460
460
|
|
|
461
461
|
```typescript
|
|
462
|
-
const spaceRoleUsers = await client.spaceRoleUsers.list(
|
|
462
|
+
const spaceRoleUsers = await client.spaceRoleUsers.list('example-space', { page: 1, limit: 10 });
|
|
463
463
|
console.log(spaceRoleUsers);
|
|
464
464
|
```
|
|
465
465
|
|
|
@@ -478,17 +478,18 @@ update(id: number, params: SpaceRoleParams, options?: Core.RequestOptions): Core
|
|
|
478
478
|
|
|
479
479
|
**Parameters:**
|
|
480
480
|
|
|
481
|
-
-
|
|
482
|
-
-
|
|
483
|
-
-
|
|
484
|
-
-
|
|
481
|
+
- `id` _(number)_: The ID of the space role user to update.
|
|
482
|
+
- `params` _(SpaceRoleParams)_: Parameters containing updated space role details.
|
|
483
|
+
- `space_role`: _(string)_: The updated space role for the user.
|
|
484
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
485
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
485
486
|
|
|
486
487
|
**Returns:** `Promise<SpaceRoleParams>`
|
|
487
488
|
|
|
488
489
|
**Example:**
|
|
489
490
|
|
|
490
491
|
```typescript
|
|
491
|
-
const updatedRole = await client.spaceRoleUsers.update(1, { space_role: 'new-role' });
|
|
492
|
+
const updatedRole = await client.spaceRoleUsers.update(1, { space_role: 'new-role', 'X-Space': 'your-space-slug' });
|
|
492
493
|
console.log(updatedRole);
|
|
493
494
|
```
|
|
494
495
|
|
|
@@ -507,22 +508,52 @@ partialUpdate(id: number, params: SpaceRoleParams, options?: Core.RequestOptions
|
|
|
507
508
|
|
|
508
509
|
**Parameters:**
|
|
509
510
|
|
|
510
|
-
-
|
|
511
|
-
-
|
|
512
|
-
-
|
|
513
|
-
-
|
|
511
|
+
- `id` _(number)_: The ID of the space role user to partially update.
|
|
512
|
+
- `params` _(SpaceRoleParams)_: Parameters containing updated space role details.
|
|
513
|
+
- `space_role`: _(string)_: The updated space role for the user.
|
|
514
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
515
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
514
516
|
|
|
515
517
|
**Returns:** `Promise<SpaceRoleParams>`
|
|
516
518
|
|
|
517
519
|
**Example:**
|
|
518
520
|
|
|
519
521
|
```typescript
|
|
520
|
-
const partialUpdatedRole = await client.spaceRoleUsers.partialUpdate(1, { space_role: 'another-role' });
|
|
522
|
+
const partialUpdatedRole = await client.spaceRoleUsers.partialUpdate(1, { space_role: 'another-role', 'X-Space': 'your-space-slug' });
|
|
521
523
|
console.log(partialUpdatedRole);
|
|
522
524
|
```
|
|
523
525
|
|
|
524
526
|
</details>
|
|
525
527
|
|
|
528
|
+
<details>
|
|
529
|
+
<summary><strong>setSpaceDefault</strong></summary>
|
|
530
|
+
|
|
531
|
+
Set a specific space role user as the default for their space.
|
|
532
|
+
|
|
533
|
+
**Signature:**
|
|
534
|
+
|
|
535
|
+
```typescript
|
|
536
|
+
setSpaceDefault(id: String, params: SpaceRoleUsersParams, options?: Core.RequestOptions): Core.APIPromise<void>
|
|
537
|
+
```
|
|
538
|
+
|
|
539
|
+
**Parameters:**
|
|
540
|
+
|
|
541
|
+
- `id` _(string)_: The ID of the space role user to set as default.
|
|
542
|
+
- `params` _(SpaceRoleUsersParams)_: Parameters containing the space slug.
|
|
543
|
+
- `X-Space`: _(string)_: Space slug name.
|
|
544
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
545
|
+
|
|
546
|
+
**Returns:** `Promise<void>`
|
|
547
|
+
|
|
548
|
+
**Example:**
|
|
549
|
+
|
|
550
|
+
```typescript
|
|
551
|
+
await client.spaceRoleUsers.setSpaceDefault('3fa85f64-5717-4562-b3fc ...');
|
|
552
|
+
console.log('Space role user has been set as default.');
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
</details>
|
|
556
|
+
|
|
526
557
|
<details>
|
|
527
558
|
<summary><strong>delete</strong></summary>
|
|
528
559
|
|
|
@@ -531,15 +562,15 @@ Delete a specific space role user by their ID.
|
|
|
531
562
|
**Signature:**
|
|
532
563
|
|
|
533
564
|
```typescript
|
|
534
|
-
delete(id: number, params:
|
|
565
|
+
delete(id: number, params: SpaceRoleUsersParams, options?: Core.RequestOptions): Core.APIPromise<void>
|
|
535
566
|
```
|
|
536
567
|
|
|
537
568
|
**Parameters:**
|
|
538
569
|
|
|
539
|
-
-
|
|
540
|
-
-
|
|
541
|
-
-
|
|
542
|
-
-
|
|
570
|
+
- `id` _(number)_: The ID of the space role user to delete.
|
|
571
|
+
- `params` _(SpaceRoleUsersParams)_: Parameters containing the space slug.
|
|
572
|
+
- `X-Space`: _(string)_: Space slug name.
|
|
573
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
543
574
|
|
|
544
575
|
**Returns:** `Promise<void>`
|
|
545
576
|
|
|
@@ -574,7 +605,7 @@ retrieve(options?: Core.RequestOptions): Core.APIPromise<OAuthCredentials>
|
|
|
574
605
|
|
|
575
606
|
**Parameters:**
|
|
576
607
|
|
|
577
|
-
-
|
|
608
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
578
609
|
|
|
579
610
|
**Returns:** `Promise<OAuthCredentials>`
|
|
580
611
|
|
|
@@ -610,11 +641,11 @@ create(params: SpaceRoleCreateParams, options?: Core.RequestOptions): Core.APIPr
|
|
|
610
641
|
|
|
611
642
|
**Parameters:**
|
|
612
643
|
|
|
613
|
-
-
|
|
614
|
-
-
|
|
615
|
-
-
|
|
616
|
-
-
|
|
617
|
-
-
|
|
644
|
+
- `params` _(SpaceRoleCreateParams)_: Parameters for creating a new space role.
|
|
645
|
+
- `name`: _(string)_: The name of the space role.
|
|
646
|
+
- `policies`: _(Array<number>)_: An array of policy IDs associated with the space role.
|
|
647
|
+
- `X-Space`: _(string)_: Header param for space slug name.
|
|
648
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
618
649
|
|
|
619
650
|
**Returns:** `Promise<SpaceRole>`
|
|
620
651
|
|
|
@@ -638,15 +669,15 @@ Retrieve a specific space role by its ID.
|
|
|
638
669
|
**Signature:**
|
|
639
670
|
|
|
640
671
|
```typescript
|
|
641
|
-
retrieve(id: number, params:
|
|
672
|
+
retrieve(id: number, params: SpaceRolesParams, options?: Core.RequestOptions): Core.APIPromise<SpaceRole>
|
|
642
673
|
```
|
|
643
674
|
|
|
644
675
|
**Parameters:**
|
|
645
676
|
|
|
646
|
-
-
|
|
647
|
-
-
|
|
648
|
-
-
|
|
649
|
-
-
|
|
677
|
+
- `id` _(number)_: The ID of the space role to retrieve.
|
|
678
|
+
- `params` _(SpaceRolesParams)_: Parameters containing the space slug.
|
|
679
|
+
- `X-Space`: _(string)_: Space slug name.
|
|
680
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
650
681
|
|
|
651
682
|
**Returns:** `Promise<SpaceRole>`
|
|
652
683
|
|
|
@@ -671,12 +702,12 @@ update(id: number, params: SpaceRoleUpdateParams, options?: Core.RequestOptions)
|
|
|
671
702
|
|
|
672
703
|
**Parameters:**
|
|
673
704
|
|
|
674
|
-
-
|
|
675
|
-
-
|
|
676
|
-
-
|
|
677
|
-
-
|
|
678
|
-
-
|
|
679
|
-
-
|
|
705
|
+
- `id` _(number)_: The ID of the space role to update.
|
|
706
|
+
- `params` _(SpaceRoleUpdateParams)_: Parameters for updating the space role.
|
|
707
|
+
- `name`: _(string)_: The new name of the space role.
|
|
708
|
+
- `policies`: _(Array<number>)_: An updated array of policy IDs associated with the space role.
|
|
709
|
+
- `X-Space`: _(string)_: Header param for space slug name.
|
|
710
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
680
711
|
|
|
681
712
|
**Returns:** `Promise<SpaceRole>`
|
|
682
713
|
|
|
@@ -700,21 +731,21 @@ List all space roles or filter them based on query parameters.
|
|
|
700
731
|
**Signature:**
|
|
701
732
|
|
|
702
733
|
```typescript
|
|
703
|
-
list(params:
|
|
734
|
+
list(spaceName: string, params: ListParamsResponse, options?: Core.RequestOptions): Core.APIPromise<SpaceRoleListResponse>
|
|
704
735
|
```
|
|
705
736
|
|
|
706
737
|
**Parameters:**
|
|
707
738
|
|
|
708
|
-
-
|
|
709
|
-
|
|
710
|
-
-
|
|
739
|
+
- `spaceName`: _(string)_: Header param for space slug name.
|
|
740
|
+
- `params` _(ListParamsResponse)_: Parameters containing the additional filters.
|
|
741
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
711
742
|
|
|
712
743
|
**Returns:** `Promise<SpaceRoleListResponse>`
|
|
713
744
|
|
|
714
745
|
**Example:**
|
|
715
746
|
|
|
716
747
|
```typescript
|
|
717
|
-
const spaceRoles = await client.spaceRoles.list(
|
|
748
|
+
const spaceRoles = await client.spaceRoles.list('example-space', { page: 1, limit: 10 });
|
|
718
749
|
```
|
|
719
750
|
|
|
720
751
|
</details>
|
|
@@ -732,10 +763,10 @@ delete(id: number, params: SpaceRoleDeleteParams, options?: Core.RequestOptions)
|
|
|
732
763
|
|
|
733
764
|
**Parameters:**
|
|
734
765
|
|
|
735
|
-
-
|
|
736
|
-
-
|
|
737
|
-
-
|
|
738
|
-
-
|
|
766
|
+
- `id` _(number)_: The ID of the space role to delete.
|
|
767
|
+
- `params` _(SpaceRoleDeleteParams)_: Parameters containing the space slug.
|
|
768
|
+
- `X-Space`: _(string)_: Space slug name.
|
|
769
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
739
770
|
|
|
740
771
|
**Returns:** `Promise<void>`
|
|
741
772
|
|
|
@@ -770,12 +801,12 @@ create(body: SpaceCreateParams, options?: Core.RequestOptions): Core.APIPromise<
|
|
|
770
801
|
|
|
771
802
|
**Parameters:**
|
|
772
803
|
|
|
773
|
-
-
|
|
774
|
-
-
|
|
775
|
-
-
|
|
776
|
-
-
|
|
777
|
-
-
|
|
778
|
-
-
|
|
804
|
+
- `body` _(SpaceCreateParams)_: Parameters for creating a new space.
|
|
805
|
+
- `logo`: _(string)_: URL of the space logo.
|
|
806
|
+
- `name`: _(string)_: The name of the space.
|
|
807
|
+
- `slug_name`: _(string)_: Slug name for the space.
|
|
808
|
+
- `is_active` _(boolean)_: (Optional) Whether the space is active.
|
|
809
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
779
810
|
|
|
780
811
|
**Returns:** `Promise<Space>`
|
|
781
812
|
|
|
@@ -805,13 +836,13 @@ update(params: SpaceUpdateParams, options?: Core.RequestOptions): Core.APIPromis
|
|
|
805
836
|
|
|
806
837
|
**Parameters:**
|
|
807
838
|
|
|
808
|
-
-
|
|
809
|
-
-
|
|
810
|
-
-
|
|
811
|
-
-
|
|
812
|
-
-
|
|
813
|
-
-
|
|
814
|
-
-
|
|
839
|
+
- `params` _(SpaceUpdateParams)_: Parameters for updating the space.
|
|
840
|
+
- `logo`: _(string)_: URL of the new space logo.
|
|
841
|
+
- `name`: _(string)_: The new name of the space.
|
|
842
|
+
- `slug_name`: _(string)_: The new slug name for the space.
|
|
843
|
+
- `X-Space`: _(string)_: Header param for space slug name.
|
|
844
|
+
- `is_active` _(boolean)_: (Optional) Whether the space is active.
|
|
845
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
815
846
|
|
|
816
847
|
**Returns:** `Promise<Space>`
|
|
817
848
|
|
|
@@ -842,9 +873,9 @@ list(params?: SpaceListParams, options?: Core.RequestOptions): Core.APIPromise<S
|
|
|
842
873
|
|
|
843
874
|
**Parameters:**
|
|
844
875
|
|
|
845
|
-
-
|
|
846
|
-
-
|
|
847
|
-
-
|
|
876
|
+
- `params` _(SpaceListParams)_: (Optional) Parameters containing the space slug and any additional filters.
|
|
877
|
+
- `X-Space`: _(string)_: Header param for space slug name (optional).
|
|
878
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
848
879
|
|
|
849
880
|
**Returns:** `Promise<SpaceListResponse>`
|
|
850
881
|
|
|
@@ -864,14 +895,14 @@ Delete a specific space.
|
|
|
864
895
|
**Signature:**
|
|
865
896
|
|
|
866
897
|
```typescript
|
|
867
|
-
delete(params:
|
|
898
|
+
delete(params: SpaceParams, options?: Core.RequestOptions): Core.APIPromise<void>
|
|
868
899
|
```
|
|
869
900
|
|
|
870
901
|
**Parameters:**
|
|
871
902
|
|
|
872
|
-
-
|
|
873
|
-
-
|
|
874
|
-
-
|
|
903
|
+
- `params` _(SpaceParams)_: Parameters containing the space slug.
|
|
904
|
+
- `X-Space`: _(string)_: Space slug name.
|
|
905
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
875
906
|
|
|
876
907
|
**Returns:** `Promise<void>`
|
|
877
908
|
|
|
@@ -891,33 +922,35 @@ Send an invitation to users to join a space.
|
|
|
891
922
|
**Signature:**
|
|
892
923
|
|
|
893
924
|
```typescript
|
|
894
|
-
invitation(
|
|
925
|
+
invitation(params: OAuthInvitationParams, options?: Core.RequestOptions): Core.APIPromise<OAuthInvitationParams>
|
|
895
926
|
```
|
|
896
927
|
|
|
897
928
|
**Parameters:**
|
|
898
929
|
|
|
899
|
-
- `
|
|
930
|
+
- `params` _(OAuthInvitationParams)_: Contains a list of receivers with emails and role IDs.
|
|
900
931
|
- `receiver_list`: _(Receiver[])_: A list of invitation targets.
|
|
901
932
|
- `email` _(string)_: Email address of the user to invite.
|
|
902
933
|
- `space_role_id` _(string)_: Role ID assigned to the user in the space.
|
|
934
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
903
935
|
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
904
936
|
|
|
905
|
-
**Returns:** `Promise<
|
|
937
|
+
**Returns:** `Promise<OAuthInvitationParams>`
|
|
906
938
|
|
|
907
939
|
**Example:**
|
|
908
940
|
|
|
909
941
|
```typescript
|
|
910
942
|
const invitationResponse = await client.spaces.invitation({
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
943
|
+
receiver_list: [
|
|
944
|
+
{
|
|
945
|
+
email: 'user1@example.com',
|
|
946
|
+
space_role_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
|
|
947
|
+
},
|
|
948
|
+
{
|
|
949
|
+
email: 'user2@example.com',
|
|
950
|
+
space_role_id: '3fa85f64-5717-4562-b3fc-2c963f66afb3',
|
|
951
|
+
},
|
|
952
|
+
],
|
|
953
|
+
'X-Space': 'your-space-slug',
|
|
921
954
|
});
|
|
922
955
|
```
|
|
923
956
|
|
|
@@ -945,20 +978,20 @@ Where `JoinSpaceResponse` is:
|
|
|
945
978
|
|
|
946
979
|
```typescript
|
|
947
980
|
export interface JoinSpaceResponse {
|
|
948
|
-
|
|
949
|
-
|
|
981
|
+
result?: string;
|
|
982
|
+
error?: string;
|
|
950
983
|
}
|
|
951
984
|
```
|
|
952
985
|
|
|
953
986
|
**Example:**
|
|
954
987
|
|
|
955
988
|
```typescript
|
|
956
|
-
const joinResponse = await client.spaces.joinSpace(
|
|
989
|
+
const joinResponse = await client.spaces.joinSpace('eyJ0b2tlbiI6ICJ4eXo0NTYiIH0...');
|
|
957
990
|
|
|
958
991
|
if (joinResponse.error) {
|
|
959
|
-
|
|
992
|
+
console.error('Failed to join space:', joinResponse.error);
|
|
960
993
|
} else {
|
|
961
|
-
|
|
994
|
+
console.log('Joined space successfully!', joinResponse.result);
|
|
962
995
|
}
|
|
963
996
|
```
|
|
964
997
|
|
|
@@ -987,11 +1020,11 @@ async authorize(body: OAuth2AuthorizeParams, options?: Core.RequestOptions): Pro
|
|
|
987
1020
|
|
|
988
1021
|
**Parameters:**
|
|
989
1022
|
|
|
990
|
-
-
|
|
991
|
-
-
|
|
992
|
-
-
|
|
993
|
-
-
|
|
994
|
-
-
|
|
1023
|
+
- `body` _(OAuth2AuthorizeParams)_: Parameters required for authorization.
|
|
1024
|
+
- `client_id`: _(string)_: The client ID of the application.
|
|
1025
|
+
- `redirect_uri`: _(string)_: The URI to redirect to after authorization.
|
|
1026
|
+
- `scopes`: _(Array<'organization'>)_: Scopes for the authorization request.
|
|
1027
|
+
- `options` _(Core.RequestOptions)_: (Optional) Additional request options.
|
|
995
1028
|
|
|
996
1029
|
**Returns:** `Promise<OAuth2Authorize>`
|
|
997
1030
|
|
|
@@ -1021,13 +1054,13 @@ token(body: OAuth2Token, options?: Core.RequestOptions): Core.APIPromise<OAuth2T
|
|
|
1021
1054
|
|
|
1022
1055
|
**Parameters:**
|
|
1023
1056
|
|
|
1024
|
-
-
|
|
1025
|
-
-
|
|
1026
|
-
-
|
|
1027
|
-
-
|
|
1028
|
-
-
|
|
1029
|
-
-
|
|
1030
|
-
-
|
|
1057
|
+
- `body` _(OAuth2Token)_: Parameters required to obtain an access token.
|
|
1058
|
+
- `client_id`: _(string)_: The client ID of the application.
|
|
1059
|
+
- `client_secret`: _(string)_: The client secret of the application.
|
|
1060
|
+
- `code`: _(string)_: The authorization code received from the authorization server.
|
|
1061
|
+
- `code_verifier`: _(string)_: The code verifier used in the authorization request.
|
|
1062
|
+
- `scopes`: _(Array<'organization'>)_: (Optional) Scopes for the token request.
|
|
1063
|
+
- `id_token`: _(string)_: (Optional) ID token if available.
|
|
1031
1064
|
|
|
1032
1065
|
**Returns:** `Promise<OAuth2Token>`
|
|
1033
1066
|
|
|
@@ -1068,9 +1101,9 @@ create(params: DashboardCreateParams, options?: Core.RequestOptions): Core.APIPr
|
|
|
1068
1101
|
|
|
1069
1102
|
**Parameters:**
|
|
1070
1103
|
|
|
1071
|
-
-
|
|
1072
|
-
-
|
|
1073
|
-
-
|
|
1104
|
+
- `params` _(DashboardCreateParams)_: Parameters required for creating a dashboard.
|
|
1105
|
+
- `name`: _(string)_: The name of the dashboard.
|
|
1106
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
1074
1107
|
|
|
1075
1108
|
**Returns:** `Promise<Dashboard>`
|
|
1076
1109
|
|
|
@@ -1099,9 +1132,9 @@ retrieve(id: number, params: DashboardRetrieveParams, options?: Core.RequestOpti
|
|
|
1099
1132
|
|
|
1100
1133
|
**Parameters:**
|
|
1101
1134
|
|
|
1102
|
-
-
|
|
1103
|
-
-
|
|
1104
|
-
-
|
|
1135
|
+
- `id` _(number)_: The ID of the dashboard to retrieve.
|
|
1136
|
+
- `params` _(DashboardRetrieveParams)_: Parameters required for retrieving a dashboard.
|
|
1137
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
1105
1138
|
|
|
1106
1139
|
**Returns:** `Promise<Dashboard>`
|
|
1107
1140
|
|
|
@@ -1127,10 +1160,10 @@ update(id: number, params: DashboardUpdateParams, options?: Core.RequestOptions)
|
|
|
1127
1160
|
|
|
1128
1161
|
**Parameters:**
|
|
1129
1162
|
|
|
1130
|
-
-
|
|
1131
|
-
-
|
|
1132
|
-
-
|
|
1133
|
-
-
|
|
1163
|
+
- `id` _(number)_: The ID of the dashboard to update.
|
|
1164
|
+
- `params` _(DashboardUpdateParams)_: Parameters required for updating a dashboard.
|
|
1165
|
+
- `name`: _(string)_: The new name of the dashboard.
|
|
1166
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
1134
1167
|
|
|
1135
1168
|
**Returns:** `Promise<Dashboard>`
|
|
1136
1169
|
|
|
@@ -1159,8 +1192,8 @@ list(params: DashboardListParams, options?: Core.RequestOptions): Core.APIPromis
|
|
|
1159
1192
|
|
|
1160
1193
|
**Parameters:**
|
|
1161
1194
|
|
|
1162
|
-
-
|
|
1163
|
-
-
|
|
1195
|
+
- `params` _(DashboardListParams)_: Parameters for listing dashboards.
|
|
1196
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
1164
1197
|
|
|
1165
1198
|
**Returns:** `Promise<DashboardListResponse>`
|
|
1166
1199
|
|
|
@@ -1185,9 +1218,9 @@ delete(id: number, params: DashboardDeleteParams, options?: Core.RequestOptions)
|
|
|
1185
1218
|
|
|
1186
1219
|
**Parameters:**
|
|
1187
1220
|
|
|
1188
|
-
-
|
|
1189
|
-
-
|
|
1190
|
-
-
|
|
1221
|
+
- `id` _(number)_: The ID of the dashboard to delete.
|
|
1222
|
+
- `params` _(DashboardDeleteParams)_: Parameters required for deleting a dashboard.
|
|
1223
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
1191
1224
|
|
|
1192
1225
|
**Returns:** `Promise<void>`
|
|
1193
1226
|
|
|
@@ -1212,10 +1245,10 @@ createWidget(dashboardId: string, params: WidgetCreateParams, options?: Core.Req
|
|
|
1212
1245
|
|
|
1213
1246
|
**Parameters:**
|
|
1214
1247
|
|
|
1215
|
-
-
|
|
1216
|
-
-
|
|
1217
|
-
-
|
|
1218
|
-
-
|
|
1248
|
+
- `dashboardId` _(string)_: The ID of the dashboard to create the widget in.
|
|
1249
|
+
- `params` _(WidgetCreateParams)_: Parameters required for creating a widget.
|
|
1250
|
+
- `configuration`: _(any)_: Configuration settings for the widget.
|
|
1251
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
1219
1252
|
|
|
1220
1253
|
**Returns:** `Promise<Widget>`
|
|
1221
1254
|
|
|
@@ -1244,10 +1277,10 @@ retrieveWidget(dashboardId: string, id: number, params: WidgetRetrieveParams, op
|
|
|
1244
1277
|
|
|
1245
1278
|
**Parameters:**
|
|
1246
1279
|
|
|
1247
|
-
-
|
|
1248
|
-
-
|
|
1249
|
-
-
|
|
1250
|
-
-
|
|
1280
|
+
- `dashboardId` _(string)_: The ID of the dashboard containing the widget.
|
|
1281
|
+
- `id` _(number)_: The ID of the widget to retrieve.
|
|
1282
|
+
- `params` _(WidgetRetrieveParams)_: Parameters required for retrieving a widget.
|
|
1283
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
1251
1284
|
|
|
1252
1285
|
**Returns:** `Promise<Widget>`
|
|
1253
1286
|
|
|
@@ -1272,11 +1305,11 @@ updateWidget(dashboardId: string, id: number, params: WidgetUpdateParams, option
|
|
|
1272
1305
|
|
|
1273
1306
|
**Parameters:**
|
|
1274
1307
|
|
|
1275
|
-
-
|
|
1276
|
-
-
|
|
1277
|
-
-
|
|
1278
|
-
-
|
|
1279
|
-
-
|
|
1308
|
+
- `dashboardId` _(string)_: The ID of the dashboard containing the widget.
|
|
1309
|
+
- `id` _(number)_: The ID of the widget to update.
|
|
1310
|
+
- `params` _(WidgetUpdateParams)_: Parameters required for updating a widget.
|
|
1311
|
+
- `configuration`: _(any)_: New configuration settings for the widget.
|
|
1312
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
1280
1313
|
|
|
1281
1314
|
**Returns:** `Promise<Widget>`
|
|
1282
1315
|
|
|
@@ -1305,10 +1338,10 @@ listWidgets(dashboardId: string, params: WidgetListParams, options?: Core.Reques
|
|
|
1305
1338
|
|
|
1306
1339
|
**Parameters:**
|
|
1307
1340
|
|
|
1308
|
-
-
|
|
1309
|
-
-
|
|
1310
|
-
-
|
|
1311
|
-
-
|
|
1341
|
+
- `dashboardId` _(string)_: The ID of the dashboard to list widgets from.
|
|
1342
|
+
- `params` _(WidgetListParams)_: Parameters for listing widgets.
|
|
1343
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
1344
|
+
- `ordering`: _(string)_: (Optional) Field to use when ordering the results.
|
|
1312
1345
|
|
|
1313
1346
|
**Returns:** `Promise<WidgetListResponse>`
|
|
1314
1347
|
|
|
@@ -1333,10 +1366,10 @@ deleteWidget(dashboardId: string, id: number, params: WidgetDeleteParams, option
|
|
|
1333
1366
|
|
|
1334
1367
|
**Parameters:**
|
|
1335
1368
|
|
|
1336
|
-
-
|
|
1337
|
-
-
|
|
1338
|
-
-
|
|
1339
|
-
-
|
|
1369
|
+
- `dashboardId` _(string)_: The ID of the dashboard containing the widget.
|
|
1370
|
+
- `id` _(number)_: The ID of the widget to delete.
|
|
1371
|
+
- `params` _(WidgetDeleteParams)_: Parameters required for deleting a widget.
|
|
1372
|
+
- `X-Space`: _(string)_: The space slug name.
|
|
1340
1373
|
|
|
1341
1374
|
**Returns:** `Promise<void>`
|
|
1342
1375
|
|
|
@@ -1369,9 +1402,9 @@ retrieveDaily(params: DailyRetrieveParams, options?: Core.RequestOptions): Core.
|
|
|
1369
1402
|
|
|
1370
1403
|
**Parameters:**
|
|
1371
1404
|
|
|
1372
|
-
-
|
|
1373
|
-
-
|
|
1374
|
-
-
|
|
1405
|
+
- `params` _(DailyRetrieveParams)_: Parameters for retrieving daily device states.
|
|
1406
|
+
- `X-Space`: _(string)_: Space slug name.
|
|
1407
|
+
- Other query parameters specific to daily retrieval.
|
|
1375
1408
|
|
|
1376
1409
|
**Returns:** `Promise<DailyRetrieveResponse>`
|
|
1377
1410
|
|
|
@@ -1400,9 +1433,9 @@ retrieveHourly(params: HourlyRetrieveParams, options?: Core.RequestOptions): Cor
|
|
|
1400
1433
|
|
|
1401
1434
|
**Parameters:**
|
|
1402
1435
|
|
|
1403
|
-
-
|
|
1404
|
-
-
|
|
1405
|
-
-
|
|
1436
|
+
- `params` _(HourlyRetrieveParams)_: Parameters for retrieving hourly device states.
|
|
1437
|
+
- `X-Space`: _(string)_: Space slug name.
|
|
1438
|
+
- Other query parameters specific to hourly retrieval.
|
|
1406
1439
|
|
|
1407
1440
|
**Returns:** `Promise<HourlyRetrieveResponse>`
|
|
1408
1441
|
|
|
@@ -1431,9 +1464,9 @@ retrieveMinutely(params: MinutelyRetrieveParams, options?: Core.RequestOptions):
|
|
|
1431
1464
|
|
|
1432
1465
|
**Parameters:**
|
|
1433
1466
|
|
|
1434
|
-
-
|
|
1435
|
-
-
|
|
1436
|
-
-
|
|
1467
|
+
- `params` _(MinutelyRetrieveParams)_: Parameters for retrieving minutely device states.
|
|
1468
|
+
- `X-Space`: _(string)_: Space slug name.
|
|
1469
|
+
- Other query parameters specific to minutely retrieval.
|
|
1437
1470
|
|
|
1438
1471
|
**Returns:** `Promise<MinutelyRetrieveResponse>`
|
|
1439
1472
|
|
|
@@ -1462,9 +1495,9 @@ retrieveMonthly(params: MonthlyRetrieveParams, options?: Core.RequestOptions): C
|
|
|
1462
1495
|
|
|
1463
1496
|
**Parameters:**
|
|
1464
1497
|
|
|
1465
|
-
-
|
|
1466
|
-
-
|
|
1467
|
-
-
|
|
1498
|
+
- `params` _(MonthlyRetrieveParams)_: Parameters for retrieving monthly device states.
|
|
1499
|
+
- `X-Space`: _(string)_: Space slug name.
|
|
1500
|
+
- Other query parameters specific to monthly retrieval.
|
|
1468
1501
|
|
|
1469
1502
|
**Returns:** `Promise<MonthlyRetrieveResponse>`
|
|
1470
1503
|
|
|
@@ -1503,7 +1536,7 @@ getMe(options?: Core.RequestOptions): Core.APIPromise<Profile>
|
|
|
1503
1536
|
|
|
1504
1537
|
**Parameters:**
|
|
1505
1538
|
|
|
1506
|
-
-
|
|
1539
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
1507
1540
|
|
|
1508
1541
|
**Returns:** `Promise<Profile>`
|
|
1509
1542
|
|
|
@@ -1529,15 +1562,15 @@ updateMe(body: Profile, options?: Core.RequestOptions): Core.APIPromise<Profile>
|
|
|
1529
1562
|
|
|
1530
1563
|
**Parameters:**
|
|
1531
1564
|
|
|
1532
|
-
-
|
|
1533
|
-
-
|
|
1534
|
-
-
|
|
1535
|
-
-
|
|
1536
|
-
-
|
|
1537
|
-
-
|
|
1538
|
-
-
|
|
1539
|
-
-
|
|
1540
|
-
-
|
|
1565
|
+
- `body` _(Profile)_: Object containing updated user profile details.
|
|
1566
|
+
- `first_name` _(string)_: User's first name.
|
|
1567
|
+
- `last_name` _(string)_: User's last name.
|
|
1568
|
+
- `email` _(string)_: User's email address.
|
|
1569
|
+
- `location` _(string)_: User's location.
|
|
1570
|
+
- `avatar` _(string)_: URL of the user's avatar.
|
|
1571
|
+
- `company_name` _(string)_: User's company name.
|
|
1572
|
+
- `title` _(string)_: User's title.
|
|
1573
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
1541
1574
|
|
|
1542
1575
|
**Returns:** `Promise<Profile>`
|
|
1543
1576
|
|
|
@@ -1567,7 +1600,7 @@ deleteMe(options?: Core.RequestOptions): Core.APIPromise<void>
|
|
|
1567
1600
|
|
|
1568
1601
|
**Parameters:**
|
|
1569
1602
|
|
|
1570
|
-
-
|
|
1603
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
1571
1604
|
|
|
1572
1605
|
**Returns:** `Promise<void>`
|
|
1573
1606
|
|
|
@@ -1603,7 +1636,7 @@ get(options?: Core.RequestOptions): Core.APIPromise<PresignedUrlResponse>
|
|
|
1603
1636
|
|
|
1604
1637
|
**Parameters:**
|
|
1605
1638
|
|
|
1606
|
-
-
|
|
1639
|
+
- `options` _(Core.RequestOptions)_: Additional request options.
|
|
1607
1640
|
|
|
1608
1641
|
**Returns:** `Promise<PresignedUrlResponse>`
|
|
1609
1642
|
|
|
@@ -1615,4 +1648,4 @@ console.log(response.presigned_url);
|
|
|
1615
1648
|
console.log(response.file_name);
|
|
1616
1649
|
```
|
|
1617
1650
|
|
|
1618
|
-
</details>
|
|
1651
|
+
</details>
|