@knowledge-stack/ksapi 3.9.1 → 3.10.1

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/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@3.9.1
1
+ # @knowledge-stack/ksapi@3.10.1
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -274,11 +274,13 @@ All URIs are relative to *http://localhost:8000*
274
274
  *UserPermissionsApi* | [**deleteUserPermission**](docs/UserPermissionsApi.md#deleteuserpermission) | **DELETE** /v1/user-permissions/{permission_id} | Delete User Permission Handler
275
275
  *UserPermissionsApi* | [**listUserPermissions**](docs/UserPermissionsApi.md#listuserpermissions) | **GET** /v1/user-permissions | List User Permissions Handler
276
276
  *UserPermissionsApi* | [**updateUserPermission**](docs/UserPermissionsApi.md#updateuserpermission) | **PATCH** /v1/user-permissions/{permission_id} | Update User Permission Handler
277
+ *UsersApi* | [**deleteMyAvatar**](docs/UsersApi.md#deletemyavatar) | **DELETE** /v1/users/me/avatar | Delete My Avatar Handler
277
278
  *UsersApi* | [**getMe**](docs/UsersApi.md#getme) | **GET** /v1/users/me | Get Me Handler
278
279
  *UsersApi* | [**skipOnboarding**](docs/UsersApi.md#skiponboarding) | **POST** /v1/users/me/onboarding/skip | Skip Onboarding Handler
279
280
  *UsersApi* | [**updateMe**](docs/UsersApi.md#updateme) | **PATCH** /v1/users | Update Me Handler
280
281
  *UsersApi* | [**updateOnboardingCompany**](docs/UsersApi.md#updateonboardingcompany) | **PATCH** /v1/users/me/onboarding/company | Update Onboarding Company Handler
281
282
  *UsersApi* | [**updateOnboardingProfile**](docs/UsersApi.md#updateonboardingprofile) | **PATCH** /v1/users/me/onboarding/profile | Update Onboarding Profile Handler
283
+ *UsersApi* | [**uploadMyAvatar**](docs/UsersApi.md#uploadmyavatar) | **POST** /v1/users/me/avatar | Upload My Avatar Handler
282
284
  *WorkflowDefinitionsApi* | [**createWorkflowDefinition**](docs/WorkflowDefinitionsApi.md#createworkflowdefinitionoperation) | **POST** /v1/workflow-definitions | Create Workflow Definition Handler
283
285
  *WorkflowDefinitionsApi* | [**createWorkflowRun**](docs/WorkflowDefinitionsApi.md#createworkflowrun) | **POST** /v1/workflow-definitions/{definition_id}/runs | Create Workflow Run Handler
284
286
  *WorkflowDefinitionsApi* | [**deleteWorkflowDefinition**](docs/WorkflowDefinitionsApi.md#deleteworkflowdefinition) | **DELETE** /v1/workflow-definitions/{definition_id} | Delete Workflow Definition Handler
@@ -738,7 +740,7 @@ and is automatically generated by the
738
740
  [OpenAPI Generator](https://openapi-generator.tech) project:
739
741
 
740
742
  - API version: `0.1.0`
741
- - Package version: `3.9.1`
743
+ - Package version: `3.10.1`
742
744
  - Generator version: `7.21.0`
743
745
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
744
746
 
@@ -20,6 +20,9 @@ export interface UpdateOnboardingCompanyRequest {
20
20
  export interface UpdateOnboardingProfileRequest {
21
21
  onboardingProfileRequest: OnboardingProfileRequest;
22
22
  }
23
+ export interface UploadMyAvatarRequest {
24
+ file: Blob;
25
+ }
23
26
  /**
24
27
  * UsersApi - interface
25
28
  *
@@ -27,6 +30,25 @@ export interface UpdateOnboardingProfileRequest {
27
30
  * @interface UsersApiInterface
28
31
  */
29
32
  export interface UsersApiInterface {
33
+ /**
34
+ * Creates request options for deleteMyAvatar without sending the request
35
+ * @throws {RequiredError}
36
+ * @memberof UsersApiInterface
37
+ */
38
+ deleteMyAvatarRequestOpts(): Promise<runtime.RequestOpts>;
39
+ /**
40
+ * Remove the profile photo for the current tenant. No photo is a no-op.
41
+ * @summary Delete My Avatar Handler
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ * @memberof UsersApiInterface
45
+ */
46
+ deleteMyAvatarRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
47
+ /**
48
+ * Remove the profile photo for the current tenant. No photo is a no-op.
49
+ * Delete My Avatar Handler
50
+ */
51
+ deleteMyAvatar(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
30
52
  /**
31
53
  * Creates request options for getMe without sending the request
32
54
  * @throws {RequiredError}
@@ -73,7 +95,7 @@ export interface UsersApiInterface {
73
95
  */
74
96
  updateMeRequestOpts(requestParameters: UpdateMeRequest): Promise<runtime.RequestOpts>;
75
97
  /**
76
- * Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
98
+ * Update the user\'s name and default tenant, and the membership\'s profile. When updating default_tenant_id, the user must belong to the specified tenant.
77
99
  * @summary Update Me Handler
78
100
  * @param {UpdateUserRequest} updateUserRequest
79
101
  * @param {*} [options] Override http request option.
@@ -82,7 +104,7 @@ export interface UsersApiInterface {
82
104
  */
83
105
  updateMeRaw(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
84
106
  /**
85
- * Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
107
+ * Update the user\'s name and default tenant, and the membership\'s profile. When updating default_tenant_id, the user must belong to the specified tenant.
86
108
  * Update Me Handler
87
109
  */
88
110
  updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
@@ -115,7 +137,7 @@ export interface UsersApiInterface {
115
137
  */
116
138
  updateOnboardingProfileRequestOpts(requestParameters: UpdateOnboardingProfileRequest): Promise<runtime.RequestOpts>;
117
139
  /**
118
- * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users (name) or a future per-membership profile endpoint (job_title).
140
+ * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
119
141
  * @summary Update Onboarding Profile Handler
120
142
  * @param {OnboardingProfileRequest} onboardingProfileRequest
121
143
  * @param {*} [options] Override http request option.
@@ -124,15 +146,50 @@ export interface UsersApiInterface {
124
146
  */
125
147
  updateOnboardingProfileRaw(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
126
148
  /**
127
- * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users (name) or a future per-membership profile endpoint (job_title).
149
+ * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
128
150
  * Update Onboarding Profile Handler
129
151
  */
130
152
  updateOnboardingProfile(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
153
+ /**
154
+ * Creates request options for uploadMyAvatar without sending the request
155
+ * @param {Blob} file
156
+ * @throws {RequiredError}
157
+ * @memberof UsersApiInterface
158
+ */
159
+ uploadMyAvatarRequestOpts(requestParameters: UploadMyAvatarRequest): Promise<runtime.RequestOpts>;
160
+ /**
161
+ * Set the profile photo for the current tenant. PNG, JPEG, WebP or GIF, at most 2 MB and 4096 px per side; the format is read from the bytes, not the content type.
162
+ * @summary Upload My Avatar Handler
163
+ * @param {Blob} file
164
+ * @param {*} [options] Override http request option.
165
+ * @throws {RequiredError}
166
+ * @memberof UsersApiInterface
167
+ */
168
+ uploadMyAvatarRaw(requestParameters: UploadMyAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
169
+ /**
170
+ * Set the profile photo for the current tenant. PNG, JPEG, WebP or GIF, at most 2 MB and 4096 px per side; the format is read from the bytes, not the content type.
171
+ * Upload My Avatar Handler
172
+ */
173
+ uploadMyAvatar(requestParameters: UploadMyAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
131
174
  }
132
175
  /**
133
176
  *
134
177
  */
135
178
  export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
179
+ /**
180
+ * Creates request options for deleteMyAvatar without sending the request
181
+ */
182
+ deleteMyAvatarRequestOpts(): Promise<runtime.RequestOpts>;
183
+ /**
184
+ * Remove the profile photo for the current tenant. No photo is a no-op.
185
+ * Delete My Avatar Handler
186
+ */
187
+ deleteMyAvatarRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
188
+ /**
189
+ * Remove the profile photo for the current tenant. No photo is a no-op.
190
+ * Delete My Avatar Handler
191
+ */
192
+ deleteMyAvatar(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
136
193
  /**
137
194
  * Creates request options for getMe without sending the request
138
195
  */
@@ -166,12 +223,12 @@ export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterfa
166
223
  */
167
224
  updateMeRequestOpts(requestParameters: UpdateMeRequest): Promise<runtime.RequestOpts>;
168
225
  /**
169
- * Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
226
+ * Update the user\'s name and default tenant, and the membership\'s profile. When updating default_tenant_id, the user must belong to the specified tenant.
170
227
  * Update Me Handler
171
228
  */
172
229
  updateMeRaw(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
173
230
  /**
174
- * Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
231
+ * Update the user\'s name and default tenant, and the membership\'s profile. When updating default_tenant_id, the user must belong to the specified tenant.
175
232
  * Update Me Handler
176
233
  */
177
234
  updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
@@ -194,13 +251,27 @@ export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterfa
194
251
  */
195
252
  updateOnboardingProfileRequestOpts(requestParameters: UpdateOnboardingProfileRequest): Promise<runtime.RequestOpts>;
196
253
  /**
197
- * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users (name) or a future per-membership profile endpoint (job_title).
254
+ * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
198
255
  * Update Onboarding Profile Handler
199
256
  */
200
257
  updateOnboardingProfileRaw(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
201
258
  /**
202
- * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users (name) or a future per-membership profile endpoint (job_title).
259
+ * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
203
260
  * Update Onboarding Profile Handler
204
261
  */
205
262
  updateOnboardingProfile(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
263
+ /**
264
+ * Creates request options for uploadMyAvatar without sending the request
265
+ */
266
+ uploadMyAvatarRequestOpts(requestParameters: UploadMyAvatarRequest): Promise<runtime.RequestOpts>;
267
+ /**
268
+ * Set the profile photo for the current tenant. PNG, JPEG, WebP or GIF, at most 2 MB and 4096 px per side; the format is read from the bytes, not the content type.
269
+ * Upload My Avatar Handler
270
+ */
271
+ uploadMyAvatarRaw(requestParameters: UploadMyAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
272
+ /**
273
+ * Set the profile photo for the current tenant. PNG, JPEG, WebP or GIF, at most 2 MB and 4096 px per side; the format is read from the bytes, not the content type.
274
+ * Upload My Avatar Handler
275
+ */
276
+ uploadMyAvatar(requestParameters: UploadMyAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
206
277
  }
@@ -62,6 +62,50 @@ const index_1 = require("../models/index");
62
62
  *
63
63
  */
64
64
  class UsersApi extends runtime.BaseAPI {
65
+ /**
66
+ * Creates request options for deleteMyAvatar without sending the request
67
+ */
68
+ deleteMyAvatarRequestOpts() {
69
+ return __awaiter(this, void 0, void 0, function* () {
70
+ const queryParameters = {};
71
+ const headerParameters = {};
72
+ if (this.configuration && this.configuration.accessToken) {
73
+ const token = this.configuration.accessToken;
74
+ const tokenString = yield token("bearerAuth", []);
75
+ if (tokenString) {
76
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
77
+ }
78
+ }
79
+ let urlPath = `/v1/users/me/avatar`;
80
+ return {
81
+ path: urlPath,
82
+ method: 'DELETE',
83
+ headers: headerParameters,
84
+ query: queryParameters,
85
+ };
86
+ });
87
+ }
88
+ /**
89
+ * Remove the profile photo for the current tenant. No photo is a no-op.
90
+ * Delete My Avatar Handler
91
+ */
92
+ deleteMyAvatarRaw(initOverrides) {
93
+ return __awaiter(this, void 0, void 0, function* () {
94
+ const requestOptions = yield this.deleteMyAvatarRequestOpts();
95
+ const response = yield this.request(requestOptions, initOverrides);
96
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserResponseFromJSON)(jsonValue));
97
+ });
98
+ }
99
+ /**
100
+ * Remove the profile photo for the current tenant. No photo is a no-op.
101
+ * Delete My Avatar Handler
102
+ */
103
+ deleteMyAvatar(initOverrides) {
104
+ return __awaiter(this, void 0, void 0, function* () {
105
+ const response = yield this.deleteMyAvatarRaw(initOverrides);
106
+ return yield response.value();
107
+ });
108
+ }
65
109
  /**
66
110
  * Creates request options for getMe without sending the request
67
111
  */
@@ -179,7 +223,7 @@ class UsersApi extends runtime.BaseAPI {
179
223
  });
180
224
  }
181
225
  /**
182
- * Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
226
+ * Update the user\'s name and default tenant, and the membership\'s profile. When updating default_tenant_id, the user must belong to the specified tenant.
183
227
  * Update Me Handler
184
228
  */
185
229
  updateMeRaw(requestParameters, initOverrides) {
@@ -190,7 +234,7 @@ class UsersApi extends runtime.BaseAPI {
190
234
  });
191
235
  }
192
236
  /**
193
- * Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
237
+ * Update the user\'s name and default tenant, and the membership\'s profile. When updating default_tenant_id, the user must belong to the specified tenant.
194
238
  * Update Me Handler
195
239
  */
196
240
  updateMe(requestParameters, initOverrides) {
@@ -277,7 +321,7 @@ class UsersApi extends runtime.BaseAPI {
277
321
  });
278
322
  }
279
323
  /**
280
- * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users (name) or a future per-membership profile endpoint (job_title).
324
+ * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
281
325
  * Update Onboarding Profile Handler
282
326
  */
283
327
  updateOnboardingProfileRaw(requestParameters, initOverrides) {
@@ -288,7 +332,7 @@ class UsersApi extends runtime.BaseAPI {
288
332
  });
289
333
  }
290
334
  /**
291
- * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users (name) or a future per-membership profile endpoint (job_title).
335
+ * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
292
336
  * Update Onboarding Profile Handler
293
337
  */
294
338
  updateOnboardingProfile(requestParameters, initOverrides) {
@@ -297,5 +341,71 @@ class UsersApi extends runtime.BaseAPI {
297
341
  return yield response.value();
298
342
  });
299
343
  }
344
+ /**
345
+ * Creates request options for uploadMyAvatar without sending the request
346
+ */
347
+ uploadMyAvatarRequestOpts(requestParameters) {
348
+ return __awaiter(this, void 0, void 0, function* () {
349
+ if (requestParameters['file'] == null) {
350
+ throw new runtime.RequiredError('file', 'Required parameter "file" was null or undefined when calling uploadMyAvatar().');
351
+ }
352
+ const queryParameters = {};
353
+ const headerParameters = {};
354
+ if (this.configuration && this.configuration.accessToken) {
355
+ const token = this.configuration.accessToken;
356
+ const tokenString = yield token("bearerAuth", []);
357
+ if (tokenString) {
358
+ headerParameters["Authorization"] = `Bearer ${tokenString}`;
359
+ }
360
+ }
361
+ const consumes = [
362
+ { contentType: 'multipart/form-data' },
363
+ ];
364
+ // @ts-ignore: canConsumeForm may be unused
365
+ const canConsumeForm = runtime.canConsumeForm(consumes);
366
+ let formParams;
367
+ let useForm = false;
368
+ // use FormData to transmit files using content-type "multipart/form-data"
369
+ useForm = canConsumeForm;
370
+ if (useForm) {
371
+ formParams = new FormData();
372
+ }
373
+ else {
374
+ formParams = new URLSearchParams();
375
+ }
376
+ if (requestParameters['file'] != null) {
377
+ formParams.append('file', requestParameters['file']);
378
+ }
379
+ let urlPath = `/v1/users/me/avatar`;
380
+ return {
381
+ path: urlPath,
382
+ method: 'POST',
383
+ headers: headerParameters,
384
+ query: queryParameters,
385
+ body: formParams,
386
+ };
387
+ });
388
+ }
389
+ /**
390
+ * Set the profile photo for the current tenant. PNG, JPEG, WebP or GIF, at most 2 MB and 4096 px per side; the format is read from the bytes, not the content type.
391
+ * Upload My Avatar Handler
392
+ */
393
+ uploadMyAvatarRaw(requestParameters, initOverrides) {
394
+ return __awaiter(this, void 0, void 0, function* () {
395
+ const requestOptions = yield this.uploadMyAvatarRequestOpts(requestParameters);
396
+ const response = yield this.request(requestOptions, initOverrides);
397
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserResponseFromJSON)(jsonValue));
398
+ });
399
+ }
400
+ /**
401
+ * Set the profile photo for the current tenant. PNG, JPEG, WebP or GIF, at most 2 MB and 4096 px per side; the format is read from the bytes, not the content type.
402
+ * Upload My Avatar Handler
403
+ */
404
+ uploadMyAvatar(requestParameters, initOverrides) {
405
+ return __awaiter(this, void 0, void 0, function* () {
406
+ const response = yield this.uploadMyAvatarRaw(requestParameters, initOverrides);
407
+ return yield response.value();
408
+ });
409
+ }
300
410
  }
301
411
  exports.UsersApi = UsersApi;
@@ -20,6 +20,9 @@ export interface UpdateOnboardingCompanyRequest {
20
20
  export interface UpdateOnboardingProfileRequest {
21
21
  onboardingProfileRequest: OnboardingProfileRequest;
22
22
  }
23
+ export interface UploadMyAvatarRequest {
24
+ file: Blob;
25
+ }
23
26
  /**
24
27
  * UsersApi - interface
25
28
  *
@@ -27,6 +30,25 @@ export interface UpdateOnboardingProfileRequest {
27
30
  * @interface UsersApiInterface
28
31
  */
29
32
  export interface UsersApiInterface {
33
+ /**
34
+ * Creates request options for deleteMyAvatar without sending the request
35
+ * @throws {RequiredError}
36
+ * @memberof UsersApiInterface
37
+ */
38
+ deleteMyAvatarRequestOpts(): Promise<runtime.RequestOpts>;
39
+ /**
40
+ * Remove the profile photo for the current tenant. No photo is a no-op.
41
+ * @summary Delete My Avatar Handler
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ * @memberof UsersApiInterface
45
+ */
46
+ deleteMyAvatarRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
47
+ /**
48
+ * Remove the profile photo for the current tenant. No photo is a no-op.
49
+ * Delete My Avatar Handler
50
+ */
51
+ deleteMyAvatar(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
30
52
  /**
31
53
  * Creates request options for getMe without sending the request
32
54
  * @throws {RequiredError}
@@ -73,7 +95,7 @@ export interface UsersApiInterface {
73
95
  */
74
96
  updateMeRequestOpts(requestParameters: UpdateMeRequest): Promise<runtime.RequestOpts>;
75
97
  /**
76
- * Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
98
+ * Update the user\'s name and default tenant, and the membership\'s profile. When updating default_tenant_id, the user must belong to the specified tenant.
77
99
  * @summary Update Me Handler
78
100
  * @param {UpdateUserRequest} updateUserRequest
79
101
  * @param {*} [options] Override http request option.
@@ -82,7 +104,7 @@ export interface UsersApiInterface {
82
104
  */
83
105
  updateMeRaw(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
84
106
  /**
85
- * Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
107
+ * Update the user\'s name and default tenant, and the membership\'s profile. When updating default_tenant_id, the user must belong to the specified tenant.
86
108
  * Update Me Handler
87
109
  */
88
110
  updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
@@ -115,7 +137,7 @@ export interface UsersApiInterface {
115
137
  */
116
138
  updateOnboardingProfileRequestOpts(requestParameters: UpdateOnboardingProfileRequest): Promise<runtime.RequestOpts>;
117
139
  /**
118
- * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users (name) or a future per-membership profile endpoint (job_title).
140
+ * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
119
141
  * @summary Update Onboarding Profile Handler
120
142
  * @param {OnboardingProfileRequest} onboardingProfileRequest
121
143
  * @param {*} [options] Override http request option.
@@ -124,15 +146,50 @@ export interface UsersApiInterface {
124
146
  */
125
147
  updateOnboardingProfileRaw(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
126
148
  /**
127
- * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users (name) or a future per-membership profile endpoint (job_title).
149
+ * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
128
150
  * Update Onboarding Profile Handler
129
151
  */
130
152
  updateOnboardingProfile(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
153
+ /**
154
+ * Creates request options for uploadMyAvatar without sending the request
155
+ * @param {Blob} file
156
+ * @throws {RequiredError}
157
+ * @memberof UsersApiInterface
158
+ */
159
+ uploadMyAvatarRequestOpts(requestParameters: UploadMyAvatarRequest): Promise<runtime.RequestOpts>;
160
+ /**
161
+ * Set the profile photo for the current tenant. PNG, JPEG, WebP or GIF, at most 2 MB and 4096 px per side; the format is read from the bytes, not the content type.
162
+ * @summary Upload My Avatar Handler
163
+ * @param {Blob} file
164
+ * @param {*} [options] Override http request option.
165
+ * @throws {RequiredError}
166
+ * @memberof UsersApiInterface
167
+ */
168
+ uploadMyAvatarRaw(requestParameters: UploadMyAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
169
+ /**
170
+ * Set the profile photo for the current tenant. PNG, JPEG, WebP or GIF, at most 2 MB and 4096 px per side; the format is read from the bytes, not the content type.
171
+ * Upload My Avatar Handler
172
+ */
173
+ uploadMyAvatar(requestParameters: UploadMyAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
131
174
  }
132
175
  /**
133
176
  *
134
177
  */
135
178
  export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterface {
179
+ /**
180
+ * Creates request options for deleteMyAvatar without sending the request
181
+ */
182
+ deleteMyAvatarRequestOpts(): Promise<runtime.RequestOpts>;
183
+ /**
184
+ * Remove the profile photo for the current tenant. No photo is a no-op.
185
+ * Delete My Avatar Handler
186
+ */
187
+ deleteMyAvatarRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
188
+ /**
189
+ * Remove the profile photo for the current tenant. No photo is a no-op.
190
+ * Delete My Avatar Handler
191
+ */
192
+ deleteMyAvatar(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
136
193
  /**
137
194
  * Creates request options for getMe without sending the request
138
195
  */
@@ -166,12 +223,12 @@ export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterfa
166
223
  */
167
224
  updateMeRequestOpts(requestParameters: UpdateMeRequest): Promise<runtime.RequestOpts>;
168
225
  /**
169
- * Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
226
+ * Update the user\'s name and default tenant, and the membership\'s profile. When updating default_tenant_id, the user must belong to the specified tenant.
170
227
  * Update Me Handler
171
228
  */
172
229
  updateMeRaw(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
173
230
  /**
174
- * Update the user\'s profile (default tenant, name fields). When updating default_tenant_id, the user must belong to the specified tenant.
231
+ * Update the user\'s name and default tenant, and the membership\'s profile. When updating default_tenant_id, the user must belong to the specified tenant.
175
232
  * Update Me Handler
176
233
  */
177
234
  updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
@@ -194,13 +251,27 @@ export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterfa
194
251
  */
195
252
  updateOnboardingProfileRequestOpts(requestParameters: UpdateOnboardingProfileRequest): Promise<runtime.RequestOpts>;
196
253
  /**
197
- * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users (name) or a future per-membership profile endpoint (job_title).
254
+ * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
198
255
  * Update Onboarding Profile Handler
199
256
  */
200
257
  updateOnboardingProfileRaw(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
201
258
  /**
202
- * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users (name) or a future per-membership profile endpoint (job_title).
259
+ * Step 2 (final) of onboarding: per-user profile for the current tenant. Writes name to the User row (global) and job_title to the TenantUser row (per-tenant), then stamps ``onboarding_completed_at`` on the membership. Returns 409 if onboarding has already been completed or skipped — post-onboarding edits go through PATCH /v1/users.
203
260
  * Update Onboarding Profile Handler
204
261
  */
205
262
  updateOnboardingProfile(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
263
+ /**
264
+ * Creates request options for uploadMyAvatar without sending the request
265
+ */
266
+ uploadMyAvatarRequestOpts(requestParameters: UploadMyAvatarRequest): Promise<runtime.RequestOpts>;
267
+ /**
268
+ * Set the profile photo for the current tenant. PNG, JPEG, WebP or GIF, at most 2 MB and 4096 px per side; the format is read from the bytes, not the content type.
269
+ * Upload My Avatar Handler
270
+ */
271
+ uploadMyAvatarRaw(requestParameters: UploadMyAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
272
+ /**
273
+ * Set the profile photo for the current tenant. PNG, JPEG, WebP or GIF, at most 2 MB and 4096 px per side; the format is read from the bytes, not the content type.
274
+ * Upload My Avatar Handler
275
+ */
276
+ uploadMyAvatar(requestParameters: UploadMyAvatarRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
206
277
  }