@knowledge-stack/ksapi 3.11.0 → 3.13.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.
- package/.openapi-generator/FILES +26 -4
- package/README.md +18 -6
- package/dist/apis/AuthApi.d.ts +12 -9
- package/dist/apis/AuthApi.js +5 -2
- package/dist/apis/FeedbackApi.d.ts +10 -7
- package/dist/apis/FeedbackApi.js +5 -2
- package/dist/apis/InvitesApi.d.ts +39 -1
- package/dist/apis/InvitesApi.js +41 -0
- package/dist/apis/UsersApi.d.ts +51 -59
- package/dist/apis/UsersApi.js +50 -57
- package/dist/esm/apis/AuthApi.d.ts +12 -9
- package/dist/esm/apis/AuthApi.js +6 -3
- package/dist/esm/apis/FeedbackApi.d.ts +10 -7
- package/dist/esm/apis/FeedbackApi.js +5 -2
- package/dist/esm/apis/InvitesApi.d.ts +39 -1
- package/dist/esm/apis/InvitesApi.js +42 -1
- package/dist/esm/apis/UsersApi.d.ts +51 -59
- package/dist/esm/apis/UsersApi.js +51 -58
- package/dist/esm/models/{OnboardingProfileRequest.d.ts → AccessRequestResponse.d.ts} +14 -26
- package/dist/esm/models/{OnboardingCompanyRequest.js → AccessRequestResponse.js} +13 -20
- package/dist/esm/models/AddedBy.d.ts +25 -0
- package/dist/esm/models/AddedBy.js +43 -0
- package/dist/esm/models/CreatePasswordUserRequest.d.ts +6 -0
- package/dist/esm/models/CreatePasswordUserRequest.js +2 -0
- package/dist/esm/models/ErrorResponse.d.ts +2 -0
- package/dist/esm/models/ErrorResponse.js +2 -0
- package/dist/esm/models/FeaturesResponse.d.ts +7 -0
- package/dist/esm/models/FeaturesResponse.js +5 -0
- package/dist/esm/models/GuideModuleProgress.d.ts +66 -0
- package/dist/{models/OnboardingProfileRequest.js → esm/models/GuideModuleProgress.js} +31 -25
- package/dist/esm/models/GuideModuleStatus.d.ts +26 -0
- package/dist/esm/models/GuideModuleStatus.js +44 -0
- package/dist/esm/models/GuideModules.d.ts +126 -0
- package/dist/esm/models/GuideModules.js +69 -0
- package/dist/esm/models/InvitePreviewResponse.d.ts +80 -0
- package/dist/esm/models/InvitePreviewResponse.js +57 -0
- package/dist/esm/models/InvitePreviewState.d.ts +28 -0
- package/dist/esm/models/InvitePreviewState.js +46 -0
- package/dist/esm/models/InviteRejection.d.ts +30 -0
- package/dist/esm/models/InviteRejection.js +48 -0
- package/dist/esm/models/KbSummaryResponse.d.ts +8 -0
- package/dist/esm/models/KbSummaryResponse.js +4 -0
- package/dist/esm/models/{OnboardingCompanyRequest.d.ts → OnboardingState.d.ts} +26 -18
- package/dist/esm/models/{OnboardingProfileRequest.js → OnboardingState.js} +17 -19
- package/dist/esm/models/OnboardingStateUpdate.d.ts +61 -0
- package/dist/esm/models/OnboardingStateUpdate.js +48 -0
- package/dist/esm/models/OnboardingStep.d.ts +27 -0
- package/dist/esm/models/OnboardingStep.js +45 -0
- package/dist/esm/models/SignUpResponse.d.ts +174 -0
- package/dist/esm/models/SignUpResponse.js +107 -0
- package/dist/esm/models/TenantResponse.d.ts +7 -0
- package/dist/esm/models/TenantResponse.js +5 -0
- package/dist/esm/models/TenantUserJoinMethod.d.ts +26 -0
- package/dist/esm/models/TenantUserJoinMethod.js +44 -0
- package/dist/esm/models/UserResponse.d.ts +40 -0
- package/dist/esm/models/UserResponse.js +18 -0
- package/dist/esm/models/index.d.ts +13 -2
- package/dist/esm/models/index.js +13 -2
- package/dist/models/{OnboardingProfileRequest.d.ts → AccessRequestResponse.d.ts} +14 -26
- package/dist/models/{OnboardingCompanyRequest.js → AccessRequestResponse.js} +19 -26
- package/dist/models/AddedBy.d.ts +25 -0
- package/dist/models/AddedBy.js +51 -0
- package/dist/models/CreatePasswordUserRequest.d.ts +6 -0
- package/dist/models/CreatePasswordUserRequest.js +2 -0
- package/dist/models/ErrorResponse.d.ts +2 -0
- package/dist/models/ErrorResponse.js +2 -0
- package/dist/models/FeaturesResponse.d.ts +7 -0
- package/dist/models/FeaturesResponse.js +5 -0
- package/dist/models/GuideModuleProgress.d.ts +66 -0
- package/dist/models/GuideModuleProgress.js +72 -0
- package/dist/models/GuideModuleStatus.d.ts +26 -0
- package/dist/models/GuideModuleStatus.js +52 -0
- package/dist/models/GuideModules.d.ts +126 -0
- package/dist/models/GuideModules.js +77 -0
- package/dist/models/InvitePreviewResponse.d.ts +80 -0
- package/dist/models/InvitePreviewResponse.js +65 -0
- package/dist/models/InvitePreviewState.d.ts +28 -0
- package/dist/models/InvitePreviewState.js +54 -0
- package/dist/models/InviteRejection.d.ts +30 -0
- package/dist/models/InviteRejection.js +56 -0
- package/dist/models/KbSummaryResponse.d.ts +8 -0
- package/dist/models/KbSummaryResponse.js +4 -0
- package/dist/models/{OnboardingCompanyRequest.d.ts → OnboardingState.d.ts} +26 -18
- package/dist/models/OnboardingState.js +56 -0
- package/dist/models/OnboardingStateUpdate.d.ts +61 -0
- package/dist/models/OnboardingStateUpdate.js +56 -0
- package/dist/models/OnboardingStep.d.ts +27 -0
- package/dist/models/OnboardingStep.js +53 -0
- package/dist/models/SignUpResponse.d.ts +174 -0
- package/dist/models/SignUpResponse.js +115 -0
- package/dist/models/TenantResponse.d.ts +7 -0
- package/dist/models/TenantResponse.js +5 -0
- package/dist/models/TenantUserJoinMethod.d.ts +26 -0
- package/dist/models/TenantUserJoinMethod.js +52 -0
- package/dist/models/UserResponse.d.ts +40 -0
- package/dist/models/UserResponse.js +18 -0
- package/dist/models/index.d.ts +13 -2
- package/dist/models/index.js +13 -2
- package/docs/{OnboardingCompanyRequest.md → AccessRequestResponse.md} +6 -9
- package/docs/{OnboardingProfileRequest.md → AddedBy.md} +4 -11
- package/docs/AuthApi.md +8 -5
- package/docs/CreatePasswordUserRequest.md +2 -0
- package/docs/FeaturesResponse.md +2 -0
- package/docs/FeedbackApi.md +8 -5
- package/docs/GuideModuleProgress.md +40 -0
- package/docs/GuideModuleStatus.md +32 -0
- package/docs/GuideModules.md +60 -0
- package/docs/InvitePreviewResponse.md +44 -0
- package/docs/InvitePreviewState.md +32 -0
- package/docs/InviteRejection.md +32 -0
- package/docs/InvitesApi.md +70 -0
- package/docs/KbSummaryResponse.md +2 -0
- package/docs/OnboardingState.md +39 -0
- package/docs/OnboardingStateUpdate.md +38 -0
- package/docs/OnboardingStep.md +32 -0
- package/docs/SignUpResponse.md +74 -0
- package/docs/TenantResponse.md +2 -0
- package/docs/TenantUserJoinMethod.md +32 -0
- package/docs/UserResponse.md +12 -0
- package/docs/UsersApi.md +36 -47
- package/package.json +1 -1
- package/src/apis/AuthApi.ts +20 -10
- package/src/apis/FeedbackApi.ts +14 -7
- package/src/apis/InvitesApi.ts +78 -0
- package/src/apis/UsersApi.ts +91 -110
- package/src/models/{OnboardingCompanyRequest.ts → AccessRequestResponse.ts} +19 -32
- package/src/models/AddedBy.ts +53 -0
- package/src/models/CreatePasswordUserRequest.ts +8 -0
- package/src/models/ErrorResponse.ts +2 -0
- package/src/models/FeaturesResponse.ts +16 -0
- package/src/models/GuideModuleProgress.ts +127 -0
- package/src/models/GuideModuleStatus.ts +54 -0
- package/src/models/GuideModules.ts +194 -0
- package/src/models/InvitePreviewResponse.ts +147 -0
- package/src/models/InvitePreviewState.ts +56 -0
- package/src/models/InviteRejection.ts +58 -0
- package/src/models/KbSummaryResponse.ts +9 -0
- package/src/models/{OnboardingProfileRequest.ts → OnboardingState.ts} +47 -33
- package/src/models/OnboardingStateUpdate.ts +115 -0
- package/src/models/OnboardingStep.ts +55 -0
- package/src/models/SignUpResponse.ts +303 -0
- package/src/models/TenantResponse.ts +16 -0
- package/src/models/TenantUserJoinMethod.ts +54 -0
- package/src/models/UserResponse.ts +77 -0
- package/src/models/index.ts +13 -2
package/dist/apis/UsersApi.d.ts
CHANGED
|
@@ -10,15 +10,12 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type {
|
|
13
|
+
import type { AccessRequestResponse, OnboardingStateUpdate, UpdateUserRequest, UserResponse } from '../models/index';
|
|
14
14
|
export interface UpdateMeRequest {
|
|
15
15
|
updateUserRequest: UpdateUserRequest;
|
|
16
16
|
}
|
|
17
|
-
export interface
|
|
18
|
-
|
|
19
|
-
}
|
|
20
|
-
export interface UpdateOnboardingProfileRequest {
|
|
21
|
-
onboardingProfileRequest: OnboardingProfileRequest;
|
|
17
|
+
export interface UpdateOnboardingStateRequest {
|
|
18
|
+
onboardingStateUpdate: OnboardingStateUpdate;
|
|
22
19
|
}
|
|
23
20
|
export interface UploadMyAvatarRequest {
|
|
24
21
|
file: Blob;
|
|
@@ -68,6 +65,25 @@ export interface UsersApiInterface {
|
|
|
68
65
|
* Get Me Handler
|
|
69
66
|
*/
|
|
70
67
|
getMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
|
|
68
|
+
/**
|
|
69
|
+
* Creates request options for requestAccess without sending the request
|
|
70
|
+
* @throws {RequiredError}
|
|
71
|
+
* @memberof UsersApiInterface
|
|
72
|
+
*/
|
|
73
|
+
requestAccessRequestOpts(): Promise<runtime.RequestOpts>;
|
|
74
|
+
/**
|
|
75
|
+
* Email the owner and admins for access; one request per member per day.
|
|
76
|
+
* @summary Request Access Handler
|
|
77
|
+
* @param {*} [options] Override http request option.
|
|
78
|
+
* @throws {RequiredError}
|
|
79
|
+
* @memberof UsersApiInterface
|
|
80
|
+
*/
|
|
81
|
+
requestAccessRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessRequestResponse>>;
|
|
82
|
+
/**
|
|
83
|
+
* Email the owner and admins for access; one request per member per day.
|
|
84
|
+
* Request Access Handler
|
|
85
|
+
*/
|
|
86
|
+
requestAccess(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessRequestResponse>;
|
|
71
87
|
/**
|
|
72
88
|
* Creates request options for skipOnboarding without sending the request
|
|
73
89
|
* @throws {RequiredError}
|
|
@@ -109,47 +125,25 @@ export interface UsersApiInterface {
|
|
|
109
125
|
*/
|
|
110
126
|
updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
|
|
111
127
|
/**
|
|
112
|
-
* Creates request options for
|
|
113
|
-
* @param {
|
|
128
|
+
* Creates request options for updateOnboardingState without sending the request
|
|
129
|
+
* @param {OnboardingStateUpdate} onboardingStateUpdate
|
|
114
130
|
* @throws {RequiredError}
|
|
115
131
|
* @memberof UsersApiInterface
|
|
116
132
|
*/
|
|
117
|
-
|
|
133
|
+
updateOnboardingStateRequestOpts(requestParameters: UpdateOnboardingStateRequest): Promise<runtime.RequestOpts>;
|
|
118
134
|
/**
|
|
119
|
-
*
|
|
120
|
-
* @summary Update Onboarding
|
|
121
|
-
* @param {
|
|
135
|
+
*
|
|
136
|
+
* @summary Update Onboarding State Handler
|
|
137
|
+
* @param {OnboardingStateUpdate} onboardingStateUpdate
|
|
122
138
|
* @param {*} [options] Override http request option.
|
|
123
139
|
* @throws {RequiredError}
|
|
124
140
|
* @memberof UsersApiInterface
|
|
125
141
|
*/
|
|
126
|
-
|
|
142
|
+
updateOnboardingStateRaw(requestParameters: UpdateOnboardingStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
|
|
127
143
|
/**
|
|
128
|
-
*
|
|
129
|
-
* Update Onboarding Company Handler
|
|
144
|
+
* Update Onboarding State Handler
|
|
130
145
|
*/
|
|
131
|
-
|
|
132
|
-
/**
|
|
133
|
-
* Creates request options for updateOnboardingProfile without sending the request
|
|
134
|
-
* @param {OnboardingProfileRequest} onboardingProfileRequest
|
|
135
|
-
* @throws {RequiredError}
|
|
136
|
-
* @memberof UsersApiInterface
|
|
137
|
-
*/
|
|
138
|
-
updateOnboardingProfileRequestOpts(requestParameters: UpdateOnboardingProfileRequest): Promise<runtime.RequestOpts>;
|
|
139
|
-
/**
|
|
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.
|
|
141
|
-
* @summary Update Onboarding Profile Handler
|
|
142
|
-
* @param {OnboardingProfileRequest} onboardingProfileRequest
|
|
143
|
-
* @param {*} [options] Override http request option.
|
|
144
|
-
* @throws {RequiredError}
|
|
145
|
-
* @memberof UsersApiInterface
|
|
146
|
-
*/
|
|
147
|
-
updateOnboardingProfileRaw(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
|
|
148
|
-
/**
|
|
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.
|
|
150
|
-
* Update Onboarding Profile Handler
|
|
151
|
-
*/
|
|
152
|
-
updateOnboardingProfile(requestParameters: UpdateOnboardingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
|
|
146
|
+
updateOnboardingState(requestParameters: UpdateOnboardingStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
|
|
153
147
|
/**
|
|
154
148
|
* Creates request options for uploadMyAvatar without sending the request
|
|
155
149
|
* @param {Blob} file
|
|
@@ -204,6 +198,20 @@ export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterfa
|
|
|
204
198
|
* Get Me Handler
|
|
205
199
|
*/
|
|
206
200
|
getMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
|
|
201
|
+
/**
|
|
202
|
+
* Creates request options for requestAccess without sending the request
|
|
203
|
+
*/
|
|
204
|
+
requestAccessRequestOpts(): Promise<runtime.RequestOpts>;
|
|
205
|
+
/**
|
|
206
|
+
* Email the owner and admins for access; one request per member per day.
|
|
207
|
+
* Request Access Handler
|
|
208
|
+
*/
|
|
209
|
+
requestAccessRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccessRequestResponse>>;
|
|
210
|
+
/**
|
|
211
|
+
* Email the owner and admins for access; one request per member per day.
|
|
212
|
+
* Request Access Handler
|
|
213
|
+
*/
|
|
214
|
+
requestAccess(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccessRequestResponse>;
|
|
207
215
|
/**
|
|
208
216
|
* Creates request options for skipOnboarding without sending the request
|
|
209
217
|
*/
|
|
@@ -233,33 +241,17 @@ export declare class UsersApi extends runtime.BaseAPI implements UsersApiInterfa
|
|
|
233
241
|
*/
|
|
234
242
|
updateMe(requestParameters: UpdateMeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
|
|
235
243
|
/**
|
|
236
|
-
* Creates request options for
|
|
237
|
-
*/
|
|
238
|
-
updateOnboardingCompanyRequestOpts(requestParameters: UpdateOnboardingCompanyRequest): Promise<runtime.RequestOpts>;
|
|
239
|
-
/**
|
|
240
|
-
* 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}.
|
|
241
|
-
* Update Onboarding Company Handler
|
|
242
|
-
*/
|
|
243
|
-
updateOnboardingCompanyRaw(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
|
|
244
|
-
/**
|
|
245
|
-
* 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}.
|
|
246
|
-
* Update Onboarding Company Handler
|
|
247
|
-
*/
|
|
248
|
-
updateOnboardingCompany(requestParameters: UpdateOnboardingCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
|
|
249
|
-
/**
|
|
250
|
-
* Creates request options for updateOnboardingProfile without sending the request
|
|
244
|
+
* Creates request options for updateOnboardingState without sending the request
|
|
251
245
|
*/
|
|
252
|
-
|
|
246
|
+
updateOnboardingStateRequestOpts(requestParameters: UpdateOnboardingStateRequest): Promise<runtime.RequestOpts>;
|
|
253
247
|
/**
|
|
254
|
-
*
|
|
255
|
-
* Update Onboarding Profile Handler
|
|
248
|
+
* Update Onboarding State Handler
|
|
256
249
|
*/
|
|
257
|
-
|
|
250
|
+
updateOnboardingStateRaw(requestParameters: UpdateOnboardingStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
|
|
258
251
|
/**
|
|
259
|
-
*
|
|
260
|
-
* Update Onboarding Profile Handler
|
|
252
|
+
* Update Onboarding State Handler
|
|
261
253
|
*/
|
|
262
|
-
|
|
254
|
+
updateOnboardingState(requestParameters: UpdateOnboardingStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
|
|
263
255
|
/**
|
|
264
256
|
* Creates request options for uploadMyAvatar without sending the request
|
|
265
257
|
*/
|
package/dist/apis/UsersApi.js
CHANGED
|
@@ -151,9 +151,9 @@ class UsersApi extends runtime.BaseAPI {
|
|
|
151
151
|
});
|
|
152
152
|
}
|
|
153
153
|
/**
|
|
154
|
-
* Creates request options for
|
|
154
|
+
* Creates request options for requestAccess without sending the request
|
|
155
155
|
*/
|
|
156
|
-
|
|
156
|
+
requestAccessRequestOpts() {
|
|
157
157
|
return __awaiter(this, void 0, void 0, function* () {
|
|
158
158
|
const queryParameters = {};
|
|
159
159
|
const headerParameters = {};
|
|
@@ -164,7 +164,7 @@ class UsersApi extends runtime.BaseAPI {
|
|
|
164
164
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
165
165
|
}
|
|
166
166
|
}
|
|
167
|
-
let urlPath = `/v1/users/me/
|
|
167
|
+
let urlPath = `/v1/users/me/access_requests`;
|
|
168
168
|
return {
|
|
169
169
|
path: urlPath,
|
|
170
170
|
method: 'POST',
|
|
@@ -174,37 +174,33 @@ class UsersApi extends runtime.BaseAPI {
|
|
|
174
174
|
});
|
|
175
175
|
}
|
|
176
176
|
/**
|
|
177
|
-
*
|
|
178
|
-
*
|
|
177
|
+
* Email the owner and admins for access; one request per member per day.
|
|
178
|
+
* Request Access Handler
|
|
179
179
|
*/
|
|
180
|
-
|
|
180
|
+
requestAccessRaw(initOverrides) {
|
|
181
181
|
return __awaiter(this, void 0, void 0, function* () {
|
|
182
|
-
const requestOptions = yield this.
|
|
182
|
+
const requestOptions = yield this.requestAccessRequestOpts();
|
|
183
183
|
const response = yield this.request(requestOptions, initOverrides);
|
|
184
|
-
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.
|
|
184
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.AccessRequestResponseFromJSON)(jsonValue));
|
|
185
185
|
});
|
|
186
186
|
}
|
|
187
187
|
/**
|
|
188
|
-
*
|
|
189
|
-
*
|
|
188
|
+
* Email the owner and admins for access; one request per member per day.
|
|
189
|
+
* Request Access Handler
|
|
190
190
|
*/
|
|
191
|
-
|
|
191
|
+
requestAccess(initOverrides) {
|
|
192
192
|
return __awaiter(this, void 0, void 0, function* () {
|
|
193
|
-
const response = yield this.
|
|
193
|
+
const response = yield this.requestAccessRaw(initOverrides);
|
|
194
194
|
return yield response.value();
|
|
195
195
|
});
|
|
196
196
|
}
|
|
197
197
|
/**
|
|
198
|
-
* Creates request options for
|
|
198
|
+
* Creates request options for skipOnboarding without sending the request
|
|
199
199
|
*/
|
|
200
|
-
|
|
200
|
+
skipOnboardingRequestOpts() {
|
|
201
201
|
return __awaiter(this, void 0, void 0, function* () {
|
|
202
|
-
if (requestParameters['updateUserRequest'] == null) {
|
|
203
|
-
throw new runtime.RequiredError('updateUserRequest', 'Required parameter "updateUserRequest" was null or undefined when calling updateMe().');
|
|
204
|
-
}
|
|
205
202
|
const queryParameters = {};
|
|
206
203
|
const headerParameters = {};
|
|
207
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
208
204
|
if (this.configuration && this.configuration.accessToken) {
|
|
209
205
|
const token = this.configuration.accessToken;
|
|
210
206
|
const tokenString = yield token("bearerAuth", []);
|
|
@@ -212,44 +208,43 @@ class UsersApi extends runtime.BaseAPI {
|
|
|
212
208
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
213
209
|
}
|
|
214
210
|
}
|
|
215
|
-
let urlPath = `/v1/users`;
|
|
211
|
+
let urlPath = `/v1/users/me/onboarding/skip`;
|
|
216
212
|
return {
|
|
217
213
|
path: urlPath,
|
|
218
|
-
method: '
|
|
214
|
+
method: 'POST',
|
|
219
215
|
headers: headerParameters,
|
|
220
216
|
query: queryParameters,
|
|
221
|
-
body: (0, index_1.UpdateUserRequestToJSON)(requestParameters['updateUserRequest']),
|
|
222
217
|
};
|
|
223
218
|
});
|
|
224
219
|
}
|
|
225
220
|
/**
|
|
226
|
-
*
|
|
227
|
-
*
|
|
221
|
+
* 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).
|
|
222
|
+
* Skip Onboarding Handler
|
|
228
223
|
*/
|
|
229
|
-
|
|
224
|
+
skipOnboardingRaw(initOverrides) {
|
|
230
225
|
return __awaiter(this, void 0, void 0, function* () {
|
|
231
|
-
const requestOptions = yield this.
|
|
226
|
+
const requestOptions = yield this.skipOnboardingRequestOpts();
|
|
232
227
|
const response = yield this.request(requestOptions, initOverrides);
|
|
233
228
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserResponseFromJSON)(jsonValue));
|
|
234
229
|
});
|
|
235
230
|
}
|
|
236
231
|
/**
|
|
237
|
-
*
|
|
238
|
-
*
|
|
232
|
+
* 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).
|
|
233
|
+
* Skip Onboarding Handler
|
|
239
234
|
*/
|
|
240
|
-
|
|
235
|
+
skipOnboarding(initOverrides) {
|
|
241
236
|
return __awaiter(this, void 0, void 0, function* () {
|
|
242
|
-
const response = yield this.
|
|
237
|
+
const response = yield this.skipOnboardingRaw(initOverrides);
|
|
243
238
|
return yield response.value();
|
|
244
239
|
});
|
|
245
240
|
}
|
|
246
241
|
/**
|
|
247
|
-
* Creates request options for
|
|
242
|
+
* Creates request options for updateMe without sending the request
|
|
248
243
|
*/
|
|
249
|
-
|
|
244
|
+
updateMeRequestOpts(requestParameters) {
|
|
250
245
|
return __awaiter(this, void 0, void 0, function* () {
|
|
251
|
-
if (requestParameters['
|
|
252
|
-
throw new runtime.RequiredError('
|
|
246
|
+
if (requestParameters['updateUserRequest'] == null) {
|
|
247
|
+
throw new runtime.RequiredError('updateUserRequest', 'Required parameter "updateUserRequest" was null or undefined when calling updateMe().');
|
|
253
248
|
}
|
|
254
249
|
const queryParameters = {};
|
|
255
250
|
const headerParameters = {};
|
|
@@ -261,44 +256,44 @@ class UsersApi extends runtime.BaseAPI {
|
|
|
261
256
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
262
257
|
}
|
|
263
258
|
}
|
|
264
|
-
let urlPath = `/v1/users
|
|
259
|
+
let urlPath = `/v1/users`;
|
|
265
260
|
return {
|
|
266
261
|
path: urlPath,
|
|
267
262
|
method: 'PATCH',
|
|
268
263
|
headers: headerParameters,
|
|
269
264
|
query: queryParameters,
|
|
270
|
-
body: (0, index_1.
|
|
265
|
+
body: (0, index_1.UpdateUserRequestToJSON)(requestParameters['updateUserRequest']),
|
|
271
266
|
};
|
|
272
267
|
});
|
|
273
268
|
}
|
|
274
269
|
/**
|
|
275
|
-
*
|
|
276
|
-
* Update
|
|
270
|
+
* 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.
|
|
271
|
+
* Update Me Handler
|
|
277
272
|
*/
|
|
278
|
-
|
|
273
|
+
updateMeRaw(requestParameters, initOverrides) {
|
|
279
274
|
return __awaiter(this, void 0, void 0, function* () {
|
|
280
|
-
const requestOptions = yield this.
|
|
275
|
+
const requestOptions = yield this.updateMeRequestOpts(requestParameters);
|
|
281
276
|
const response = yield this.request(requestOptions, initOverrides);
|
|
282
277
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserResponseFromJSON)(jsonValue));
|
|
283
278
|
});
|
|
284
279
|
}
|
|
285
280
|
/**
|
|
286
|
-
*
|
|
287
|
-
* Update
|
|
281
|
+
* 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.
|
|
282
|
+
* Update Me Handler
|
|
288
283
|
*/
|
|
289
|
-
|
|
284
|
+
updateMe(requestParameters, initOverrides) {
|
|
290
285
|
return __awaiter(this, void 0, void 0, function* () {
|
|
291
|
-
const response = yield this.
|
|
286
|
+
const response = yield this.updateMeRaw(requestParameters, initOverrides);
|
|
292
287
|
return yield response.value();
|
|
293
288
|
});
|
|
294
289
|
}
|
|
295
290
|
/**
|
|
296
|
-
* Creates request options for
|
|
291
|
+
* Creates request options for updateOnboardingState without sending the request
|
|
297
292
|
*/
|
|
298
|
-
|
|
293
|
+
updateOnboardingStateRequestOpts(requestParameters) {
|
|
299
294
|
return __awaiter(this, void 0, void 0, function* () {
|
|
300
|
-
if (requestParameters['
|
|
301
|
-
throw new runtime.RequiredError('
|
|
295
|
+
if (requestParameters['onboardingStateUpdate'] == null) {
|
|
296
|
+
throw new runtime.RequiredError('onboardingStateUpdate', 'Required parameter "onboardingStateUpdate" was null or undefined when calling updateOnboardingState().');
|
|
302
297
|
}
|
|
303
298
|
const queryParameters = {};
|
|
304
299
|
const headerParameters = {};
|
|
@@ -310,34 +305,32 @@ class UsersApi extends runtime.BaseAPI {
|
|
|
310
305
|
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
311
306
|
}
|
|
312
307
|
}
|
|
313
|
-
let urlPath = `/v1/users/me/onboarding
|
|
308
|
+
let urlPath = `/v1/users/me/onboarding`;
|
|
314
309
|
return {
|
|
315
310
|
path: urlPath,
|
|
316
311
|
method: 'PATCH',
|
|
317
312
|
headers: headerParameters,
|
|
318
313
|
query: queryParameters,
|
|
319
|
-
body: (0, index_1.
|
|
314
|
+
body: (0, index_1.OnboardingStateUpdateToJSON)(requestParameters['onboardingStateUpdate']),
|
|
320
315
|
};
|
|
321
316
|
});
|
|
322
317
|
}
|
|
323
318
|
/**
|
|
324
|
-
*
|
|
325
|
-
* Update Onboarding Profile Handler
|
|
319
|
+
* Update Onboarding State Handler
|
|
326
320
|
*/
|
|
327
|
-
|
|
321
|
+
updateOnboardingStateRaw(requestParameters, initOverrides) {
|
|
328
322
|
return __awaiter(this, void 0, void 0, function* () {
|
|
329
|
-
const requestOptions = yield this.
|
|
323
|
+
const requestOptions = yield this.updateOnboardingStateRequestOpts(requestParameters);
|
|
330
324
|
const response = yield this.request(requestOptions, initOverrides);
|
|
331
325
|
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.UserResponseFromJSON)(jsonValue));
|
|
332
326
|
});
|
|
333
327
|
}
|
|
334
328
|
/**
|
|
335
|
-
*
|
|
336
|
-
* Update Onboarding Profile Handler
|
|
329
|
+
* Update Onboarding State Handler
|
|
337
330
|
*/
|
|
338
|
-
|
|
331
|
+
updateOnboardingState(requestParameters, initOverrides) {
|
|
339
332
|
return __awaiter(this, void 0, void 0, function* () {
|
|
340
|
-
const response = yield this.
|
|
333
|
+
const response = yield this.updateOnboardingStateRaw(requestParameters, initOverrides);
|
|
341
334
|
return yield response.value();
|
|
342
335
|
});
|
|
343
336
|
}
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { ChangePhoneNumberRequest, CreatePasswordUserRequest, CreatePhonePasswordUserRequest, DirectorySyncResponse, EmailSentResponse, EmailVerificationRequest, ErrorResponse, IdpType, PasswordResetRequest, PasswordResetTokenResponse, PasswordResetWithTokenRequest, PhoneValidationResponse, PhoneVerificationRequest, RequestPhoneChangeRequest, ResponseSendPwResetEmail, SSOInitiateResponse, SendPasswordResetRequest, SignInRequest, UserResponse, ValidateResetCodeRequest } from '../models/index';
|
|
13
|
+
import type { ChangePhoneNumberRequest, CreatePasswordUserRequest, CreatePhonePasswordUserRequest, DirectorySyncResponse, EmailSentResponse, EmailVerificationRequest, ErrorResponse, IdpType, PasswordResetRequest, PasswordResetTokenResponse, PasswordResetWithTokenRequest, PhoneValidationResponse, PhoneVerificationRequest, RequestPhoneChangeRequest, ResponseSendPwResetEmail, SSOInitiateResponse, SendPasswordResetRequest, SignInRequest, SignUpResponse, UserResponse, ValidateResetCodeRequest } from '../models/index';
|
|
14
14
|
export interface ChangePhoneNumberOperationRequest {
|
|
15
15
|
changePhoneNumberRequest: ChangePhoneNumberRequest;
|
|
16
16
|
}
|
|
@@ -32,6 +32,7 @@ export interface FanweiDirectorySync0Request {
|
|
|
32
32
|
}
|
|
33
33
|
export interface InitiateSsoRequest {
|
|
34
34
|
provider: IdpType;
|
|
35
|
+
inviteId?: string | null;
|
|
35
36
|
tenantId?: string | null;
|
|
36
37
|
}
|
|
37
38
|
export interface Oauth2CallbackRequest {
|
|
@@ -116,11 +117,11 @@ export interface AuthApiInterface {
|
|
|
116
117
|
* @throws {RequiredError}
|
|
117
118
|
* @memberof AuthApiInterface
|
|
118
119
|
*/
|
|
119
|
-
createPasswordUserRaw(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
120
|
+
createPasswordUserRaw(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignUpResponse>>;
|
|
120
121
|
/**
|
|
121
122
|
* Create Password User Handler
|
|
122
123
|
*/
|
|
123
|
-
createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
124
|
+
createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignUpResponse>;
|
|
124
125
|
/**
|
|
125
126
|
* Creates request options for createPhonePasswordUser without sending the request
|
|
126
127
|
* @param {CreatePhonePasswordUserRequest} createPhonePasswordUserRequest
|
|
@@ -195,6 +196,7 @@ export interface AuthApiInterface {
|
|
|
195
196
|
/**
|
|
196
197
|
* Creates request options for initiateSso without sending the request
|
|
197
198
|
* @param {IdpType} provider Provider to initiate SSO with
|
|
199
|
+
* @param {string} [inviteId] Invite to resolve if this sign-in creates the account; carried in the session to the callback like the OAuth state.
|
|
198
200
|
* @param {string} [tenantId] Tenant ID to initiate SSO with
|
|
199
201
|
* @throws {RequiredError}
|
|
200
202
|
* @memberof AuthApiInterface
|
|
@@ -204,6 +206,7 @@ export interface AuthApiInterface {
|
|
|
204
206
|
* Initiate SSO with the given provider and tenant ID.
|
|
205
207
|
* @summary Initiate Sso Handler
|
|
206
208
|
* @param {IdpType} provider Provider to initiate SSO with
|
|
209
|
+
* @param {string} [inviteId] Invite to resolve if this sign-in creates the account; carried in the session to the callback like the OAuth state.
|
|
207
210
|
* @param {string} [tenantId] Tenant ID to initiate SSO with
|
|
208
211
|
* @param {*} [options] Override http request option.
|
|
209
212
|
* @throws {RequiredError}
|
|
@@ -240,12 +243,12 @@ export interface AuthApiInterface {
|
|
|
240
243
|
* @throws {RequiredError}
|
|
241
244
|
* @memberof AuthApiInterface
|
|
242
245
|
*/
|
|
243
|
-
oauth2CallbackRaw(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
246
|
+
oauth2CallbackRaw(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignUpResponse>>;
|
|
244
247
|
/**
|
|
245
248
|
* Handle OAuth2 callback from the given OAuth client.
|
|
246
249
|
* Oauth2 Callback Handler
|
|
247
250
|
*/
|
|
248
|
-
oauth2Callback(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
251
|
+
oauth2Callback(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignUpResponse>;
|
|
249
252
|
/**
|
|
250
253
|
* Creates request options for pwEmailVerification without sending the request
|
|
251
254
|
* @param {EmailVerificationRequest} emailVerificationRequest
|
|
@@ -502,11 +505,11 @@ export declare class AuthApi extends runtime.BaseAPI implements AuthApiInterface
|
|
|
502
505
|
/**
|
|
503
506
|
* Create Password User Handler
|
|
504
507
|
*/
|
|
505
|
-
createPasswordUserRaw(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
508
|
+
createPasswordUserRaw(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignUpResponse>>;
|
|
506
509
|
/**
|
|
507
510
|
* Create Password User Handler
|
|
508
511
|
*/
|
|
509
|
-
createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
512
|
+
createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignUpResponse>;
|
|
510
513
|
/**
|
|
511
514
|
* Creates request options for createPhonePasswordUser without sending the request
|
|
512
515
|
*/
|
|
@@ -571,12 +574,12 @@ export declare class AuthApi extends runtime.BaseAPI implements AuthApiInterface
|
|
|
571
574
|
* Handle OAuth2 callback from the given OAuth client.
|
|
572
575
|
* Oauth2 Callback Handler
|
|
573
576
|
*/
|
|
574
|
-
oauth2CallbackRaw(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
577
|
+
oauth2CallbackRaw(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignUpResponse>>;
|
|
575
578
|
/**
|
|
576
579
|
* Handle OAuth2 callback from the given OAuth client.
|
|
577
580
|
* Oauth2 Callback Handler
|
|
578
581
|
*/
|
|
579
|
-
oauth2Callback(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
582
|
+
oauth2Callback(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignUpResponse>;
|
|
580
583
|
/**
|
|
581
584
|
* Creates request options for pwEmailVerification without sending the request
|
|
582
585
|
*/
|
package/dist/esm/apis/AuthApi.js
CHANGED
|
@@ -21,7 +21,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
21
21
|
});
|
|
22
22
|
};
|
|
23
23
|
import * as runtime from '../runtime';
|
|
24
|
-
import { ChangePhoneNumberRequestToJSON, CreatePasswordUserRequestToJSON, CreatePhonePasswordUserRequestToJSON, DirectorySyncResponseFromJSON, EmailSentResponseFromJSON, EmailVerificationRequestToJSON, ErrorResponseFromJSON, PasswordResetRequestToJSON, PasswordResetTokenResponseFromJSON, PasswordResetWithTokenRequestToJSON, PhoneValidationResponseFromJSON, PhoneVerificationRequestToJSON, RequestPhoneChangeRequestToJSON, ResponseSendPwResetEmailFromJSON, SSOInitiateResponseFromJSON, SendPasswordResetRequestToJSON, SignInRequestToJSON, UserResponseFromJSON, ValidateResetCodeRequestToJSON, } from '../models/index';
|
|
24
|
+
import { ChangePhoneNumberRequestToJSON, CreatePasswordUserRequestToJSON, CreatePhonePasswordUserRequestToJSON, DirectorySyncResponseFromJSON, EmailSentResponseFromJSON, EmailVerificationRequestToJSON, ErrorResponseFromJSON, PasswordResetRequestToJSON, PasswordResetTokenResponseFromJSON, PasswordResetWithTokenRequestToJSON, PhoneValidationResponseFromJSON, PhoneVerificationRequestToJSON, RequestPhoneChangeRequestToJSON, ResponseSendPwResetEmailFromJSON, SSOInitiateResponseFromJSON, SendPasswordResetRequestToJSON, SignInRequestToJSON, SignUpResponseFromJSON, UserResponseFromJSON, ValidateResetCodeRequestToJSON, } from '../models/index';
|
|
25
25
|
/**
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
@@ -103,7 +103,7 @@ export class AuthApi extends runtime.BaseAPI {
|
|
|
103
103
|
return __awaiter(this, void 0, void 0, function* () {
|
|
104
104
|
const requestOptions = yield this.createPasswordUserRequestOpts(requestParameters);
|
|
105
105
|
const response = yield this.request(requestOptions, initOverrides);
|
|
106
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
106
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => SignUpResponseFromJSON(jsonValue));
|
|
107
107
|
});
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
@@ -254,6 +254,9 @@ export class AuthApi extends runtime.BaseAPI {
|
|
|
254
254
|
throw new runtime.RequiredError('provider', 'Required parameter "provider" was null or undefined when calling initiateSso().');
|
|
255
255
|
}
|
|
256
256
|
const queryParameters = {};
|
|
257
|
+
if (requestParameters['inviteId'] != null) {
|
|
258
|
+
queryParameters['invite_id'] = requestParameters['inviteId'];
|
|
259
|
+
}
|
|
257
260
|
if (requestParameters['provider'] != null) {
|
|
258
261
|
queryParameters['provider'] = requestParameters['provider'];
|
|
259
262
|
}
|
|
@@ -336,7 +339,7 @@ export class AuthApi extends runtime.BaseAPI {
|
|
|
336
339
|
return __awaiter(this, void 0, void 0, function* () {
|
|
337
340
|
const requestOptions = yield this.oauth2CallbackRequestOpts(requestParameters);
|
|
338
341
|
const response = yield this.request(requestOptions, initOverrides);
|
|
339
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
342
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => SignUpResponseFromJSON(jsonValue));
|
|
340
343
|
});
|
|
341
344
|
}
|
|
342
345
|
/**
|
|
@@ -16,8 +16,9 @@ export interface DeleteFeedbackRequest {
|
|
|
16
16
|
}
|
|
17
17
|
export interface ListFeedbackRequest {
|
|
18
18
|
targetType?: FeedbackTargetType;
|
|
19
|
-
targetId?: string | null;
|
|
19
|
+
targetId?: Array<string> | null;
|
|
20
20
|
rating?: FeedbackRating;
|
|
21
|
+
mine?: boolean;
|
|
21
22
|
sortBy?: FeedbackOrder;
|
|
22
23
|
sortDir?: SortDirection;
|
|
23
24
|
limit?: number;
|
|
@@ -61,8 +62,9 @@ export interface FeedbackApiInterface {
|
|
|
61
62
|
/**
|
|
62
63
|
* Creates request options for listFeedback without sending the request
|
|
63
64
|
* @param {FeedbackTargetType} [targetType]
|
|
64
|
-
* @param {string} [targetId]
|
|
65
|
+
* @param {Array<string>} [targetId] Repeatable. Feedback on any of these targets, so a thread page reads every visible message\'s feedback in one call; more than 200 ids is a 422 (send the page you render, not the thread).
|
|
65
66
|
* @param {FeedbackRating} [rating]
|
|
67
|
+
* @param {boolean} [mine] Only the caller\'s own feedback, whatever their role, so an owner or admin reading a thread sees their own vote on each message.
|
|
66
68
|
* @param {FeedbackOrder} [sortBy] Field to sort feedback by (default: CREATED_AT)
|
|
67
69
|
* @param {SortDirection} [sortDir] Sort direction; overrides the field\'s natural default
|
|
68
70
|
* @param {number} [limit] Number of items per page
|
|
@@ -76,11 +78,12 @@ export interface FeedbackApiInterface {
|
|
|
76
78
|
*/
|
|
77
79
|
listFeedbackRequestOpts(requestParameters: ListFeedbackRequest): Promise<runtime.RequestOpts>;
|
|
78
80
|
/**
|
|
79
|
-
* List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
|
|
81
|
+
* List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users unless `mine` is set.
|
|
80
82
|
* @summary List Feedback Handler
|
|
81
83
|
* @param {FeedbackTargetType} [targetType]
|
|
82
|
-
* @param {string} [targetId]
|
|
84
|
+
* @param {Array<string>} [targetId] Repeatable. Feedback on any of these targets, so a thread page reads every visible message\'s feedback in one call; more than 200 ids is a 422 (send the page you render, not the thread).
|
|
83
85
|
* @param {FeedbackRating} [rating]
|
|
86
|
+
* @param {boolean} [mine] Only the caller\'s own feedback, whatever their role, so an owner or admin reading a thread sees their own vote on each message.
|
|
84
87
|
* @param {FeedbackOrder} [sortBy] Field to sort feedback by (default: CREATED_AT)
|
|
85
88
|
* @param {SortDirection} [sortDir] Sort direction; overrides the field\'s natural default
|
|
86
89
|
* @param {number} [limit] Number of items per page
|
|
@@ -95,7 +98,7 @@ export interface FeedbackApiInterface {
|
|
|
95
98
|
*/
|
|
96
99
|
listFeedbackRaw(requestParameters: ListFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFeedbackEventResponse>>;
|
|
97
100
|
/**
|
|
98
|
-
* List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
|
|
101
|
+
* List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users unless `mine` is set.
|
|
99
102
|
* List Feedback Handler
|
|
100
103
|
*/
|
|
101
104
|
listFeedback(requestParameters: ListFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFeedbackEventResponse>;
|
|
@@ -144,12 +147,12 @@ export declare class FeedbackApi extends runtime.BaseAPI implements FeedbackApiI
|
|
|
144
147
|
*/
|
|
145
148
|
listFeedbackRequestOpts(requestParameters: ListFeedbackRequest): Promise<runtime.RequestOpts>;
|
|
146
149
|
/**
|
|
147
|
-
* List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
|
|
150
|
+
* List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users unless `mine` is set.
|
|
148
151
|
* List Feedback Handler
|
|
149
152
|
*/
|
|
150
153
|
listFeedbackRaw(requestParameters: ListFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFeedbackEventResponse>>;
|
|
151
154
|
/**
|
|
152
|
-
* List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
|
|
155
|
+
* List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users unless `mine` is set.
|
|
153
156
|
* List Feedback Handler
|
|
154
157
|
*/
|
|
155
158
|
listFeedback(requestParameters?: ListFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFeedbackEventResponse>;
|
|
@@ -88,6 +88,9 @@ export class FeedbackApi extends runtime.BaseAPI {
|
|
|
88
88
|
if (requestParameters['rating'] != null) {
|
|
89
89
|
queryParameters['rating'] = requestParameters['rating'];
|
|
90
90
|
}
|
|
91
|
+
if (requestParameters['mine'] != null) {
|
|
92
|
+
queryParameters['mine'] = requestParameters['mine'];
|
|
93
|
+
}
|
|
91
94
|
if (requestParameters['sortBy'] != null) {
|
|
92
95
|
queryParameters['sort_by'] = requestParameters['sortBy'];
|
|
93
96
|
}
|
|
@@ -130,7 +133,7 @@ export class FeedbackApi extends runtime.BaseAPI {
|
|
|
130
133
|
});
|
|
131
134
|
}
|
|
132
135
|
/**
|
|
133
|
-
* List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
|
|
136
|
+
* List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users unless `mine` is set.
|
|
134
137
|
* List Feedback Handler
|
|
135
138
|
*/
|
|
136
139
|
listFeedbackRaw(requestParameters, initOverrides) {
|
|
@@ -141,7 +144,7 @@ export class FeedbackApi extends runtime.BaseAPI {
|
|
|
141
144
|
});
|
|
142
145
|
}
|
|
143
146
|
/**
|
|
144
|
-
* List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
|
|
147
|
+
* List feedback entries with optional filters. USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users unless `mine` is set.
|
|
145
148
|
* List Feedback Handler
|
|
146
149
|
*/
|
|
147
150
|
listFeedback() {
|