@knowledge-stack/ksapi 1.80.1 → 1.81.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/README.md +7 -2
  3. package/dist/apis/UsersApi.d.ts +130 -1
  4. package/dist/apis/UsersApi.js +130 -0
  5. package/dist/esm/apis/UsersApi.d.ts +130 -1
  6. package/dist/esm/apis/UsersApi.js +131 -1
  7. package/dist/esm/models/OnboardingCompanyRequest.d.ts +53 -0
  8. package/dist/esm/models/OnboardingCompanyRequest.js +51 -0
  9. package/dist/esm/models/OnboardingProfileRequest.d.ts +59 -0
  10. package/dist/esm/models/OnboardingProfileRequest.js +50 -0
  11. package/dist/esm/models/TenantSettingsResponse.d.ts +6 -0
  12. package/dist/esm/models/TenantSettingsResponse.js +2 -0
  13. package/dist/esm/models/TenantSettingsUpdate.d.ts +6 -0
  14. package/dist/esm/models/TenantSettingsUpdate.js +10 -1
  15. package/dist/esm/models/UserResponse.d.ts +12 -0
  16. package/dist/esm/models/UserResponse.js +4 -0
  17. package/dist/esm/models/index.d.ts +2 -0
  18. package/dist/esm/models/index.js +2 -0
  19. package/dist/models/OnboardingCompanyRequest.d.ts +53 -0
  20. package/dist/models/OnboardingCompanyRequest.js +59 -0
  21. package/dist/models/OnboardingProfileRequest.d.ts +59 -0
  22. package/dist/models/OnboardingProfileRequest.js +58 -0
  23. package/dist/models/TenantSettingsResponse.d.ts +6 -0
  24. package/dist/models/TenantSettingsResponse.js +2 -0
  25. package/dist/models/TenantSettingsUpdate.d.ts +6 -0
  26. package/dist/models/TenantSettingsUpdate.js +10 -1
  27. package/dist/models/UserResponse.d.ts +12 -0
  28. package/dist/models/UserResponse.js +4 -0
  29. package/dist/models/index.d.ts +2 -0
  30. package/dist/models/index.js +2 -0
  31. package/docs/OnboardingCompanyRequest.md +37 -0
  32. package/docs/OnboardingProfileRequest.md +39 -0
  33. package/docs/TenantSettingsResponse.md +2 -0
  34. package/docs/TenantSettingsUpdate.md +2 -0
  35. package/docs/UserResponse.md +4 -0
  36. package/docs/UsersApi.md +222 -0
  37. package/package.json +1 -1
  38. package/src/apis/UsersApi.ts +254 -0
  39. package/src/models/OnboardingCompanyRequest.ts +96 -0
  40. package/src/models/OnboardingProfileRequest.ts +101 -0
  41. package/src/models/TenantSettingsResponse.ts +8 -0
  42. package/src/models/TenantSettingsUpdate.ts +14 -0
  43. package/src/models/UserResponse.ts +16 -0
  44. package/src/models/index.ts +2 -0
@@ -104,6 +104,8 @@ docs/MembershipResponse.md
104
104
  docs/MessageRole.md
105
105
  docs/MeteredQuotaStatus.md
106
106
  docs/NonFilesystemReferenceType.md
107
+ docs/OnboardingCompanyRequest.md
108
+ docs/OnboardingProfileRequest.md
107
109
  docs/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.md
108
110
  docs/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.md
109
111
  docs/PaginatedResponseDocumentResponse.md
@@ -343,6 +345,8 @@ src/models/MembershipResponse.ts
343
345
  src/models/MessageRole.ts
344
346
  src/models/MeteredQuotaStatus.ts
345
347
  src/models/NonFilesystemReferenceType.ts
348
+ src/models/OnboardingCompanyRequest.ts
349
+ src/models/OnboardingProfileRequest.ts
346
350
  src/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.ts
347
351
  src/models/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.ts
348
352
  src/models/PaginatedResponseDocumentResponse.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@1.80.1
1
+ # @knowledge-stack/ksapi@1.81.0
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -180,7 +180,10 @@ All URIs are relative to *http://localhost:8000*
180
180
  *UserPermissionsApi* | [**listUserPermissions**](docs/UserPermissionsApi.md#listuserpermissions) | **GET** /v1/user-permissions | List User Permissions Handler
181
181
  *UserPermissionsApi* | [**updateUserPermission**](docs/UserPermissionsApi.md#updateuserpermission) | **PATCH** /v1/user-permissions/{permission_id} | Update User Permission Handler
182
182
  *UsersApi* | [**getMe**](docs/UsersApi.md#getme) | **GET** /v1/users/me | Get Me Handler
183
+ *UsersApi* | [**skipOnboarding**](docs/UsersApi.md#skiponboarding) | **POST** /v1/users/me/onboarding/skip | Skip Onboarding Handler
183
184
  *UsersApi* | [**updateMe**](docs/UsersApi.md#updateme) | **PATCH** /v1/users | Update Me Handler
185
+ *UsersApi* | [**updateOnboardingCompany**](docs/UsersApi.md#updateonboardingcompany) | **PATCH** /v1/users/me/onboarding/company | Update Onboarding Company Handler
186
+ *UsersApi* | [**updateOnboardingProfile**](docs/UsersApi.md#updateonboardingprofile) | **PATCH** /v1/users/me/onboarding/profile | Update Onboarding Profile Handler
184
187
  *WorkflowDefinitionsApi* | [**createWorkflowDefinition**](docs/WorkflowDefinitionsApi.md#createworkflowdefinitionoperation) | **POST** /v1/workflow-definitions | Create Workflow Definition Handler
185
188
  *WorkflowDefinitionsApi* | [**deleteWorkflowDefinition**](docs/WorkflowDefinitionsApi.md#deleteworkflowdefinition) | **DELETE** /v1/workflow-definitions/{definition_id} | Delete Workflow Definition Handler
186
189
  *WorkflowDefinitionsApi* | [**getWorkflowDefinition**](docs/WorkflowDefinitionsApi.md#getworkflowdefinition) | **GET** /v1/workflow-definitions/{definition_id} | Get Workflow Definition Handler
@@ -290,6 +293,8 @@ All URIs are relative to *http://localhost:8000*
290
293
  - [MessageRole](docs/MessageRole.md)
291
294
  - [MeteredQuotaStatus](docs/MeteredQuotaStatus.md)
292
295
  - [NonFilesystemReferenceType](docs/NonFilesystemReferenceType.md)
296
+ - [OnboardingCompanyRequest](docs/OnboardingCompanyRequest.md)
297
+ - [OnboardingProfileRequest](docs/OnboardingProfileRequest.md)
293
298
  - [PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator](docs/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseDiscriminator.md)
294
299
  - [PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator](docs/PaginatedResponseAnnotatedUnionSectionContentItemChunkContentItemDiscriminator.md)
295
300
  - [PaginatedResponseDocumentResponse](docs/PaginatedResponseDocumentResponse.md)
@@ -409,7 +414,7 @@ and is automatically generated by the
409
414
  [OpenAPI Generator](https://openapi-generator.tech) project:
410
415
 
411
416
  - API version: `0.1.0`
412
- - Package version: `1.80.1`
417
+ - Package version: `1.81.0`
413
418
  - Generator version: `7.21.0`
414
419
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
415
420
 
@@ -10,16 +10,30 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { UpdateUserRequest, UserResponse } from '../models/index';
13
+ import type { OnboardingCompanyRequest, OnboardingProfileRequest, UpdateUserRequest, UserResponse } from '../models/index';
14
14
  export interface GetMeRequest {
15
15
  authorization?: string | null;
16
16
  ksUat?: string | null;
17
17
  }
18
+ export interface SkipOnboardingRequest {
19
+ authorization?: string | null;
20
+ ksUat?: string | null;
21
+ }
18
22
  export interface UpdateMeRequest {
19
23
  updateUserRequest: UpdateUserRequest;
20
24
  authorization?: string | null;
21
25
  ksUat?: string | null;
22
26
  }
27
+ export interface UpdateOnboardingCompanyRequest {
28
+ onboardingCompanyRequest: OnboardingCompanyRequest;
29
+ authorization?: string | null;
30
+ ksUat?: string | null;
31
+ }
32
+ export interface UpdateOnboardingProfileRequest {
33
+ onboardingProfileRequest: OnboardingProfileRequest;
34
+ authorization?: string | null;
35
+ ksUat?: string | null;
36
+ }
23
37
  /**
24
38
  * UsersApi - interface
25
39
  *
@@ -50,6 +64,29 @@ export interface UsersApiInterface {
50
64
  * Get Me Handler
51
65
  */
52
66
  getMe(requestParameters: GetMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
67
+ /**
68
+ * Creates request options for skipOnboarding without sending the request
69
+ * @param {string} [authorization]
70
+ * @param {string} [ksUat]
71
+ * @throws {RequiredError}
72
+ * @memberof UsersApiInterface
73
+ */
74
+ skipOnboardingRequestOpts(requestParameters: SkipOnboardingRequest): Promise<runtime.RequestOpts>;
75
+ /**
76
+ * Mark onboarding complete without writing any profile/company fields. Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
77
+ * @summary Skip Onboarding Handler
78
+ * @param {string} [authorization]
79
+ * @param {string} [ksUat]
80
+ * @param {*} [options] Override http request option.
81
+ * @throws {RequiredError}
82
+ * @memberof UsersApiInterface
83
+ */
84
+ skipOnboardingRaw(requestParameters: SkipOnboardingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
85
+ /**
86
+ * Mark onboarding complete without writing any profile/company fields. Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
87
+ * Skip Onboarding Handler
88
+ */
89
+ skipOnboarding(requestParameters: SkipOnboardingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
53
90
  /**
54
91
  * Creates request options for updateMe without sending the request
55
92
  * @param {UpdateUserRequest} updateUserRequest
@@ -75,6 +112,56 @@ export interface UsersApiInterface {
75
112
  * Update Me Handler
76
113
  */
77
114
  updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
115
+ /**
116
+ * Creates request options for updateOnboardingCompany without sending the request
117
+ * @param {OnboardingCompanyRequest} onboardingCompanyRequest
118
+ * @param {string} [authorization]
119
+ * @param {string} [ksUat]
120
+ * @throws {RequiredError}
121
+ * @memberof UsersApiInterface
122
+ */
123
+ updateOnboardingCompanyRequestOpts(requestParameters: UpdateOnboardingCompanyRequest): Promise<runtime.RequestOpts>;
124
+ /**
125
+ * Step 1 of onboarding: tenant-wide company info. Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead. Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
126
+ * @summary Update Onboarding Company Handler
127
+ * @param {OnboardingCompanyRequest} onboardingCompanyRequest
128
+ * @param {string} [authorization]
129
+ * @param {string} [ksUat]
130
+ * @param {*} [options] Override http request option.
131
+ * @throws {RequiredError}
132
+ * @memberof UsersApiInterface
133
+ */
134
+ updateOnboardingCompanyRaw(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
135
+ /**
136
+ * Step 1 of onboarding: tenant-wide company info. Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead. Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
137
+ * Update Onboarding Company Handler
138
+ */
139
+ updateOnboardingCompany(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
140
+ /**
141
+ * Creates request options for updateOnboardingProfile without sending the request
142
+ * @param {OnboardingProfileRequest} onboardingProfileRequest
143
+ * @param {string} [authorization]
144
+ * @param {string} [ksUat]
145
+ * @throws {RequiredError}
146
+ * @memberof UsersApiInterface
147
+ */
148
+ updateOnboardingProfileRequestOpts(requestParameters: UpdateOnboardingProfileRequest): Promise<runtime.RequestOpts>;
149
+ /**
150
+ * 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).
151
+ * @summary Update Onboarding Profile Handler
152
+ * @param {OnboardingProfileRequest} onboardingProfileRequest
153
+ * @param {string} [authorization]
154
+ * @param {string} [ksUat]
155
+ * @param {*} [options] Override http request option.
156
+ * @throws {RequiredError}
157
+ * @memberof UsersApiInterface
158
+ */
159
+ updateOnboardingProfileRaw(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
160
+ /**
161
+ * 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).
162
+ * Update Onboarding Profile Handler
163
+ */
164
+ updateOnboardingProfile(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
78
165
  }
79
166
  /**
80
167
  *
@@ -94,6 +181,20 @@ export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterfa
94
181
  * Get Me Handler
95
182
  */
96
183
  getMe(requestParameters?: GetMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
184
+ /**
185
+ * Creates request options for skipOnboarding without sending the request
186
+ */
187
+ skipOnboardingRequestOpts(requestParameters: SkipOnboardingRequest): Promise<runtime.RequestOpts>;
188
+ /**
189
+ * Mark onboarding complete without writing any profile/company fields. Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
190
+ * Skip Onboarding Handler
191
+ */
192
+ skipOnboardingRaw(requestParameters: SkipOnboardingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
193
+ /**
194
+ * Mark onboarding complete without writing any profile/company fields. Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
195
+ * Skip Onboarding Handler
196
+ */
197
+ skipOnboarding(requestParameters?: SkipOnboardingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
97
198
  /**
98
199
  * Creates request options for updateMe without sending the request
99
200
  */
@@ -108,4 +209,32 @@ export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterfa
108
209
  * Update Me Handler
109
210
  */
110
211
  updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
212
+ /**
213
+ * Creates request options for updateOnboardingCompany without sending the request
214
+ */
215
+ updateOnboardingCompanyRequestOpts(requestParameters: UpdateOnboardingCompanyRequest): Promise<runtime.RequestOpts>;
216
+ /**
217
+ * Step 1 of onboarding: tenant-wide company info. Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead. Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
218
+ * Update Onboarding Company Handler
219
+ */
220
+ updateOnboardingCompanyRaw(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
221
+ /**
222
+ * Step 1 of onboarding: tenant-wide company info. Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead. Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
223
+ * Update Onboarding Company Handler
224
+ */
225
+ updateOnboardingCompany(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
226
+ /**
227
+ * Creates request options for updateOnboardingProfile without sending the request
228
+ */
229
+ updateOnboardingProfileRequestOpts(requestParameters: UpdateOnboardingProfileRequest): Promise<runtime.RequestOpts>;
230
+ /**
231
+ * 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).
232
+ * Update Onboarding Profile Handler
233
+ */
234
+ updateOnboardingProfileRaw(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
235
+ /**
236
+ * 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).
237
+ * Update Onboarding Profile Handler
238
+ */
239
+ updateOnboardingProfile(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
111
240
  }
@@ -102,6 +102,46 @@ class UsersApi extends runtime.BaseAPI {
102
102
  return yield response.value();
103
103
  });
104
104
  }
105
+ /**
106
+ * Creates request options for skipOnboarding without sending the request
107
+ */
108
+ skipOnboardingRequestOpts(requestParameters) {
109
+ return __awaiter(this, void 0, void 0, function* () {
110
+ const queryParameters = {};
111
+ const headerParameters = {};
112
+ if (requestParameters['authorization'] != null) {
113
+ headerParameters['authorization'] = String(requestParameters['authorization']);
114
+ }
115
+ let urlPath = `/v1/users/me/onboarding/skip`;
116
+ return {
117
+ path: urlPath,
118
+ method: 'POST',
119
+ headers: headerParameters,
120
+ query: queryParameters,
121
+ };
122
+ });
123
+ }
124
+ /**
125
+ * Mark onboarding complete without writing any profile/company fields. Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
126
+ * Skip Onboarding Handler
127
+ */
128
+ skipOnboardingRaw(requestParameters, initOverrides) {
129
+ return __awaiter(this, void 0, void 0, function* () {
130
+ const requestOptions = yield this.skipOnboardingRequestOpts(requestParameters);
131
+ const response = yield this.request(requestOptions, initOverrides);
132
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserResponseFromJSON)(jsonValue));
133
+ });
134
+ }
135
+ /**
136
+ * Mark onboarding complete without writing any profile/company fields. Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
137
+ * Skip Onboarding Handler
138
+ */
139
+ skipOnboarding() {
140
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
141
+ const response = yield this.skipOnboardingRaw(requestParameters, initOverrides);
142
+ return yield response.value();
143
+ });
144
+ }
105
145
  /**
106
146
  * Creates request options for updateMe without sending the request
107
147
  */
@@ -147,5 +187,95 @@ class UsersApi extends runtime.BaseAPI {
147
187
  return yield response.value();
148
188
  });
149
189
  }
190
+ /**
191
+ * Creates request options for updateOnboardingCompany without sending the request
192
+ */
193
+ updateOnboardingCompanyRequestOpts(requestParameters) {
194
+ return __awaiter(this, void 0, void 0, function* () {
195
+ if (requestParameters['onboardingCompanyRequest'] == null) {
196
+ throw new runtime.RequiredError('onboardingCompanyRequest', 'Required parameter "onboardingCompanyRequest" was null or undefined when calling updateOnboardingCompany().');
197
+ }
198
+ const queryParameters = {};
199
+ const headerParameters = {};
200
+ headerParameters['Content-Type'] = 'application/json';
201
+ if (requestParameters['authorization'] != null) {
202
+ headerParameters['authorization'] = String(requestParameters['authorization']);
203
+ }
204
+ let urlPath = `/v1/users/me/onboarding/company`;
205
+ return {
206
+ path: urlPath,
207
+ method: 'PATCH',
208
+ headers: headerParameters,
209
+ query: queryParameters,
210
+ body: (0, index_1.OnboardingCompanyRequestToJSON)(requestParameters['onboardingCompanyRequest']),
211
+ };
212
+ });
213
+ }
214
+ /**
215
+ * Step 1 of onboarding: tenant-wide company info. Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead. Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
216
+ * Update Onboarding Company Handler
217
+ */
218
+ updateOnboardingCompanyRaw(requestParameters, initOverrides) {
219
+ return __awaiter(this, void 0, void 0, function* () {
220
+ const requestOptions = yield this.updateOnboardingCompanyRequestOpts(requestParameters);
221
+ const response = yield this.request(requestOptions, initOverrides);
222
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserResponseFromJSON)(jsonValue));
223
+ });
224
+ }
225
+ /**
226
+ * Step 1 of onboarding: tenant-wide company info. Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead. Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
227
+ * Update Onboarding Company Handler
228
+ */
229
+ updateOnboardingCompany(requestParameters, initOverrides) {
230
+ return __awaiter(this, void 0, void 0, function* () {
231
+ const response = yield this.updateOnboardingCompanyRaw(requestParameters, initOverrides);
232
+ return yield response.value();
233
+ });
234
+ }
235
+ /**
236
+ * Creates request options for updateOnboardingProfile without sending the request
237
+ */
238
+ updateOnboardingProfileRequestOpts(requestParameters) {
239
+ return __awaiter(this, void 0, void 0, function* () {
240
+ if (requestParameters['onboardingProfileRequest'] == null) {
241
+ throw new runtime.RequiredError('onboardingProfileRequest', 'Required parameter "onboardingProfileRequest" was null or undefined when calling updateOnboardingProfile().');
242
+ }
243
+ const queryParameters = {};
244
+ const headerParameters = {};
245
+ headerParameters['Content-Type'] = 'application/json';
246
+ if (requestParameters['authorization'] != null) {
247
+ headerParameters['authorization'] = String(requestParameters['authorization']);
248
+ }
249
+ let urlPath = `/v1/users/me/onboarding/profile`;
250
+ return {
251
+ path: urlPath,
252
+ method: 'PATCH',
253
+ headers: headerParameters,
254
+ query: queryParameters,
255
+ body: (0, index_1.OnboardingProfileRequestToJSON)(requestParameters['onboardingProfileRequest']),
256
+ };
257
+ });
258
+ }
259
+ /**
260
+ * 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).
261
+ * Update Onboarding Profile Handler
262
+ */
263
+ updateOnboardingProfileRaw(requestParameters, initOverrides) {
264
+ return __awaiter(this, void 0, void 0, function* () {
265
+ const requestOptions = yield this.updateOnboardingProfileRequestOpts(requestParameters);
266
+ const response = yield this.request(requestOptions, initOverrides);
267
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserResponseFromJSON)(jsonValue));
268
+ });
269
+ }
270
+ /**
271
+ * 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).
272
+ * Update Onboarding Profile Handler
273
+ */
274
+ updateOnboardingProfile(requestParameters, initOverrides) {
275
+ return __awaiter(this, void 0, void 0, function* () {
276
+ const response = yield this.updateOnboardingProfileRaw(requestParameters, initOverrides);
277
+ return yield response.value();
278
+ });
279
+ }
150
280
  }
151
281
  exports.UsersApi = UsersApi;
@@ -10,16 +10,30 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { UpdateUserRequest, UserResponse } from '../models/index';
13
+ import type { OnboardingCompanyRequest, OnboardingProfileRequest, UpdateUserRequest, UserResponse } from '../models/index';
14
14
  export interface GetMeRequest {
15
15
  authorization?: string | null;
16
16
  ksUat?: string | null;
17
17
  }
18
+ export interface SkipOnboardingRequest {
19
+ authorization?: string | null;
20
+ ksUat?: string | null;
21
+ }
18
22
  export interface UpdateMeRequest {
19
23
  updateUserRequest: UpdateUserRequest;
20
24
  authorization?: string | null;
21
25
  ksUat?: string | null;
22
26
  }
27
+ export interface UpdateOnboardingCompanyRequest {
28
+ onboardingCompanyRequest: OnboardingCompanyRequest;
29
+ authorization?: string | null;
30
+ ksUat?: string | null;
31
+ }
32
+ export interface UpdateOnboardingProfileRequest {
33
+ onboardingProfileRequest: OnboardingProfileRequest;
34
+ authorization?: string | null;
35
+ ksUat?: string | null;
36
+ }
23
37
  /**
24
38
  * UsersApi - interface
25
39
  *
@@ -50,6 +64,29 @@ export interface UsersApiInterface {
50
64
  * Get Me Handler
51
65
  */
52
66
  getMe(requestParameters: GetMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
67
+ /**
68
+ * Creates request options for skipOnboarding without sending the request
69
+ * @param {string} [authorization]
70
+ * @param {string} [ksUat]
71
+ * @throws {RequiredError}
72
+ * @memberof UsersApiInterface
73
+ */
74
+ skipOnboardingRequestOpts(requestParameters: SkipOnboardingRequest): Promise<runtime.RequestOpts>;
75
+ /**
76
+ * Mark onboarding complete without writing any profile/company fields. Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
77
+ * @summary Skip Onboarding Handler
78
+ * @param {string} [authorization]
79
+ * @param {string} [ksUat]
80
+ * @param {*} [options] Override http request option.
81
+ * @throws {RequiredError}
82
+ * @memberof UsersApiInterface
83
+ */
84
+ skipOnboardingRaw(requestParameters: SkipOnboardingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
85
+ /**
86
+ * Mark onboarding complete without writing any profile/company fields. Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
87
+ * Skip Onboarding Handler
88
+ */
89
+ skipOnboarding(requestParameters: SkipOnboardingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
53
90
  /**
54
91
  * Creates request options for updateMe without sending the request
55
92
  * @param {UpdateUserRequest} updateUserRequest
@@ -75,6 +112,56 @@ export interface UsersApiInterface {
75
112
  * Update Me Handler
76
113
  */
77
114
  updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
115
+ /**
116
+ * Creates request options for updateOnboardingCompany without sending the request
117
+ * @param {OnboardingCompanyRequest} onboardingCompanyRequest
118
+ * @param {string} [authorization]
119
+ * @param {string} [ksUat]
120
+ * @throws {RequiredError}
121
+ * @memberof UsersApiInterface
122
+ */
123
+ updateOnboardingCompanyRequestOpts(requestParameters: UpdateOnboardingCompanyRequest): Promise<runtime.RequestOpts>;
124
+ /**
125
+ * Step 1 of onboarding: tenant-wide company info. Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead. Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
126
+ * @summary Update Onboarding Company Handler
127
+ * @param {OnboardingCompanyRequest} onboardingCompanyRequest
128
+ * @param {string} [authorization]
129
+ * @param {string} [ksUat]
130
+ * @param {*} [options] Override http request option.
131
+ * @throws {RequiredError}
132
+ * @memberof UsersApiInterface
133
+ */
134
+ updateOnboardingCompanyRaw(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
135
+ /**
136
+ * Step 1 of onboarding: tenant-wide company info. Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead. Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
137
+ * Update Onboarding Company Handler
138
+ */
139
+ updateOnboardingCompany(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
140
+ /**
141
+ * Creates request options for updateOnboardingProfile without sending the request
142
+ * @param {OnboardingProfileRequest} onboardingProfileRequest
143
+ * @param {string} [authorization]
144
+ * @param {string} [ksUat]
145
+ * @throws {RequiredError}
146
+ * @memberof UsersApiInterface
147
+ */
148
+ updateOnboardingProfileRequestOpts(requestParameters: UpdateOnboardingProfileRequest): Promise<runtime.RequestOpts>;
149
+ /**
150
+ * 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).
151
+ * @summary Update Onboarding Profile Handler
152
+ * @param {OnboardingProfileRequest} onboardingProfileRequest
153
+ * @param {string} [authorization]
154
+ * @param {string} [ksUat]
155
+ * @param {*} [options] Override http request option.
156
+ * @throws {RequiredError}
157
+ * @memberof UsersApiInterface
158
+ */
159
+ updateOnboardingProfileRaw(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
160
+ /**
161
+ * 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).
162
+ * Update Onboarding Profile Handler
163
+ */
164
+ updateOnboardingProfile(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
78
165
  }
79
166
  /**
80
167
  *
@@ -94,6 +181,20 @@ export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterfa
94
181
  * Get Me Handler
95
182
  */
96
183
  getMe(requestParameters?: GetMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
184
+ /**
185
+ * Creates request options for skipOnboarding without sending the request
186
+ */
187
+ skipOnboardingRequestOpts(requestParameters: SkipOnboardingRequest): Promise<runtime.RequestOpts>;
188
+ /**
189
+ * Mark onboarding complete without writing any profile/company fields. Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
190
+ * Skip Onboarding Handler
191
+ */
192
+ skipOnboardingRaw(requestParameters: SkipOnboardingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
193
+ /**
194
+ * Mark onboarding complete without writing any profile/company fields. Idempotent — calling this after onboarding is already complete returns the current state unchanged (the CRUD only stamps the timestamp when it is NULL).
195
+ * Skip Onboarding Handler
196
+ */
197
+ skipOnboarding(requestParameters?: SkipOnboardingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
97
198
  /**
98
199
  * Creates request options for updateMe without sending the request
99
200
  */
@@ -108,4 +209,32 @@ export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterfa
108
209
  * Update Me Handler
109
210
  */
110
211
  updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
212
+ /**
213
+ * Creates request options for updateOnboardingCompany without sending the request
214
+ */
215
+ updateOnboardingCompanyRequestOpts(requestParameters: UpdateOnboardingCompanyRequest): Promise<runtime.RequestOpts>;
216
+ /**
217
+ * Step 1 of onboarding: tenant-wide company info. Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead. Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
218
+ * Update Onboarding Company Handler
219
+ */
220
+ updateOnboardingCompanyRaw(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
221
+ /**
222
+ * Step 1 of onboarding: tenant-wide company info. Writes ``industry`` and ``description`` into the current tenant\'s settings JSONB. Restricted to OWNER and ADMIN — invited USERs see a pre-filled, read-only step on the frontend instead. Does not mark onboarding complete; the user finishes via the profile step. Re-running while the wizard is still open overwrites prior values; once onboarding has been completed/skipped, this endpoint returns 409. Post-onboarding edits go through PATCH /v1/tenants/{id}.
223
+ * Update Onboarding Company Handler
224
+ */
225
+ updateOnboardingCompany(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
226
+ /**
227
+ * Creates request options for updateOnboardingProfile without sending the request
228
+ */
229
+ updateOnboardingProfileRequestOpts(requestParameters: UpdateOnboardingProfileRequest): Promise<runtime.RequestOpts>;
230
+ /**
231
+ * 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).
232
+ * Update Onboarding Profile Handler
233
+ */
234
+ updateOnboardingProfileRaw(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
235
+ /**
236
+ * 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).
237
+ * Update Onboarding Profile Handler
238
+ */
239
+ updateOnboardingProfile(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
111
240
  }