@knowledge-stack/ksapi 3.10.2 → 3.12.0

package/src/apis/AuthApi.ts

@@ -34,6 +34,7 @@ import type {
   SSOInitiateResponse,
   SendPasswordResetRequest,
   SignInRequest,
+  SignUpResponse,
   UserResponse,
   ValidateResetCodeRequest,
 } from '../models/index';
@@ -76,6 +77,8 @@ import {
     SendPasswordResetRequestToJSON,
     SignInRequestFromJSON,
     SignInRequestToJSON,
+    SignUpResponseFromJSON,
+    SignUpResponseToJSON,
     UserResponseFromJSON,
     UserResponseToJSON,
     ValidateResetCodeRequestFromJSON,
@@ -108,6 +111,7 @@ export interface FanweiDirectorySync0Request {
 
 export interface InitiateSsoRequest {
     provider: IdpType;
+    inviteId?: string | null;
     tenantId?: string | null;
 }
 
@@ -208,12 +212,12 @@ export interface AuthApiInterface {
      * @throws {RequiredError}
      * @memberof AuthApiInterface
      */
-    createPasswordUserRaw(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
+    createPasswordUserRaw(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignUpResponse>>;
 
     /**
      * Create Password User Handler
      */
-    createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
+    createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignUpResponse>;
 
     /**
      * Creates request options for createPhonePasswordUser without sending the request
@@ -298,6 +302,7 @@ export interface AuthApiInterface {
     /**
      * Creates request options for initiateSso without sending the request
      * @param {IdpType} provider Provider to initiate SSO with
+     * @param {string} [inviteId] Invite to resolve if this sign-in creates the account; carried in the session to the callback like the OAuth state.
      * @param {string} [tenantId] Tenant ID to initiate SSO with
      * @throws {RequiredError}
      * @memberof AuthApiInterface
@@ -308,6 +313,7 @@ export interface AuthApiInterface {
      * Initiate SSO with the given provider and tenant ID.
      * @summary Initiate Sso Handler
      * @param {IdpType} provider Provider to initiate SSO with
+     * @param {string} [inviteId] Invite to resolve if this sign-in creates the account; carried in the session to the callback like the OAuth state.
      * @param {string} [tenantId] Tenant ID to initiate SSO with
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -347,13 +353,13 @@ export interface AuthApiInterface {
      * @throws {RequiredError}
      * @memberof AuthApiInterface
      */
-    oauth2CallbackRaw(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>>;
+    oauth2CallbackRaw(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignUpResponse>>;
 
     /**
      * Handle OAuth2 callback from the given OAuth client.
      * Oauth2 Callback Handler
      */
-    oauth2Callback(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse>;
+    oauth2Callback(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignUpResponse>;
 
     /**
      * Creates request options for pwEmailVerification without sending the request
@@ -714,17 +720,17 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
     /**
      * Create Password User Handler
      */
-    async createPasswordUserRaw(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+    async createPasswordUserRaw(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignUpResponse>> {
         const requestOptions = await this.createPasswordUserRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => SignUpResponseFromJSON(jsonValue));
     }
 
     /**
      * Create Password User Handler
      */
-    async createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
+    async createPasswordUser(requestParameters: CreatePasswordUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignUpResponse> {
         const response = await this.createPasswordUserRaw(requestParameters, initOverrides);
         return await response.value();
     }
@@ -893,6 +899,10 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
 
         const queryParameters: any = {};
 
+        if (requestParameters['inviteId'] != null) {
+            queryParameters['invite_id'] = requestParameters['inviteId'];
+        }
+
         if (requestParameters['provider'] != null) {
             queryParameters['provider'] = requestParameters['provider'];
         }
@@ -988,18 +998,18 @@ export class AuthApi extends runtime.BaseAPI implements AuthApiInterface {
      * Handle OAuth2 callback from the given OAuth client.
      * Oauth2 Callback Handler
      */
-    async oauth2CallbackRaw(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResponse>> {
+    async oauth2CallbackRaw(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SignUpResponse>> {
         const requestOptions = await this.oauth2CallbackRequestOpts(requestParameters);
         const response = await this.request(requestOptions, initOverrides);
 
-        return new runtime.JSONApiResponse(response, (jsonValue) => UserResponseFromJSON(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => SignUpResponseFromJSON(jsonValue));
     }
 
     /**
      * Handle OAuth2 callback from the given OAuth client.
      * Oauth2 Callback Handler
      */
-    async oauth2Callback(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResponse> {
+    async oauth2Callback(requestParameters: Oauth2CallbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SignUpResponse> {
         const response = await this.oauth2CallbackRaw(requestParameters, initOverrides);
         return await response.value();
     }

package/src/apis/FeedbackApi.ts

@@ -52,8 +52,9 @@ export interface DeleteFeedbackRequest {
 
 export interface ListFeedbackRequest {
     targetType?: FeedbackTargetType;
-    targetId?: string | null;
+    targetId?: Array<string> | null;
     rating?: FeedbackRating;
+    mine?: boolean;
     sortBy?: FeedbackOrder;
     sortDir?: SortDirection;
     limit?: number;
@@ -102,8 +103,9 @@ export interface FeedbackApiInterface {
     /**
      * Creates request options for listFeedback without sending the request
      * @param {FeedbackTargetType} [targetType] 
-     * @param {string} [targetId] 
+     * @param {Array<string>} [targetId] Repeatable. Feedback on any of these targets, so a thread page reads every visible message\&#39;s feedback in one call; more than 200 ids is a 422 (send the page you render, not the thread).
      * @param {FeedbackRating} [rating] 
+     * @param {boolean} [mine] Only the caller\&#39;s own feedback, whatever their role, so an owner or admin reading a thread sees their own vote on each message.
      * @param {FeedbackOrder} [sortBy] Field to sort feedback by (default: CREATED_AT)
      * @param {SortDirection} [sortDir] Sort direction; overrides the field\&#39;s natural default
      * @param {number} [limit] Number of items per page
@@ -118,11 +120,12 @@ export interface FeedbackApiInterface {
     listFeedbackRequestOpts(requestParameters: ListFeedbackRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
+     * 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.
      * @summary List Feedback Handler
      * @param {FeedbackTargetType} [targetType] 
-     * @param {string} [targetId] 
+     * @param {Array<string>} [targetId] Repeatable. Feedback on any of these targets, so a thread page reads every visible message\&#39;s feedback in one call; more than 200 ids is a 422 (send the page you render, not the thread).
      * @param {FeedbackRating} [rating] 
+     * @param {boolean} [mine] Only the caller\&#39;s own feedback, whatever their role, so an owner or admin reading a thread sees their own vote on each message.
      * @param {FeedbackOrder} [sortBy] Field to sort feedback by (default: CREATED_AT)
      * @param {SortDirection} [sortDir] Sort direction; overrides the field\&#39;s natural default
      * @param {number} [limit] Number of items per page
@@ -138,7 +141,7 @@ export interface FeedbackApiInterface {
     listFeedbackRaw(requestParameters: ListFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFeedbackEventResponse>>;
 
     /**
-     * List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
+     * 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.
      * List Feedback Handler
      */
     listFeedback(requestParameters: ListFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFeedbackEventResponse>;
@@ -246,6 +249,10 @@ export class FeedbackApi extends runtime.BaseAPI implements FeedbackApiInterface
             queryParameters['rating'] = requestParameters['rating'];
         }
 
+        if (requestParameters['mine'] != null) {
+            queryParameters['mine'] = requestParameters['mine'];
+        }
+
         if (requestParameters['sortBy'] != null) {
             queryParameters['sort_by'] = requestParameters['sortBy'];
         }
@@ -300,7 +307,7 @@ export class FeedbackApi extends runtime.BaseAPI implements FeedbackApiInterface
     }
 
     /**
-     * List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
+     * 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.
      * List Feedback Handler
      */
     async listFeedbackRaw(requestParameters: ListFeedbackRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedResponseFeedbackEventResponse>> {
@@ -311,7 +318,7 @@ export class FeedbackApi extends runtime.BaseAPI implements FeedbackApiInterface
     }
 
     /**
-     * List feedback entries with optional filters.  USER role: only returns their own feedback. OWNER/ADMIN role: returns feedback from all users.
+     * 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.
      * List Feedback Handler
      */
     async listFeedback(requestParameters: ListFeedbackRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseFeedbackEventResponse> {

package/src/apis/InvitesApi.ts

@@ -19,6 +19,7 @@ import type {
   ErrorResponse,
   HTTPValidationError,
   InviteOrder,
+  InvitePreviewResponse,
   InviteResponse,
   InviteStatus,
   InviteUserRequest,
@@ -36,6 +37,8 @@ import {
     HTTPValidationErrorToJSON,
     InviteOrderFromJSON,
     InviteOrderToJSON,
+    InvitePreviewResponseFromJSON,
+    InvitePreviewResponseToJSON,
     InviteResponseFromJSON,
     InviteResponseToJSON,
     InviteStatusFromJSON,
@@ -79,6 +82,10 @@ export interface ListInvitesRequest {
     updatedBefore?: Date | null;
 }
 
+export interface PreviewInviteRequest {
+    inviteId: string;
+}
+
 export interface UpdateInviteOperationRequest {
     inviteId: string;
     updateInviteRequest: UpdateInviteRequest;
@@ -209,6 +216,30 @@ export interface InvitesApiInterface {
      */
     listInvites(requestParameters: ListInvitesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseInviteResponse>;
 
+    /**
+     * Creates request options for previewInvite without sending the request
+     * @param {string} inviteId 
+     * @throws {RequiredError}
+     * @memberof InvitesApiInterface
+     */
+    previewInviteRequestOpts(requestParameters: PreviewInviteRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Unauthenticated; the invite id in the emailed link is the only credential.
+     * @summary Preview Invite Handler
+     * @param {string} inviteId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof InvitesApiInterface
+     */
+    previewInviteRaw(requestParameters: PreviewInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvitePreviewResponse>>;
+
+    /**
+     * Unauthenticated; the invite id in the emailed link is the only credential.
+     * Preview Invite Handler
+     */
+    previewInvite(requestParameters: PreviewInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvitePreviewResponse>;
+
     /**
      * Creates request options for updateInvite without sending the request
      * @param {string} inviteId 
@@ -503,6 +534,53 @@ export class InvitesApi extends runtime.BaseAPI implements InvitesApiInterface {
         return await response.value();
     }
 
+    /**
+     * Creates request options for previewInvite without sending the request
+     */
+    async previewInviteRequestOpts(requestParameters: PreviewInviteRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['inviteId'] == null) {
+            throw new runtime.RequiredError(
+                'inviteId',
+                'Required parameter "inviteId" was null or undefined when calling previewInvite().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/v1/invites/{invite_id}/preview`;
+        urlPath = urlPath.replace(`{${"invite_id"}}`, encodeURIComponent(String(requestParameters['inviteId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Unauthenticated; the invite id in the emailed link is the only credential.
+     * Preview Invite Handler
+     */
+    async previewInviteRaw(requestParameters: PreviewInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InvitePreviewResponse>> {
+        const requestOptions = await this.previewInviteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InvitePreviewResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Unauthenticated; the invite id in the emailed link is the only credential.
+     * Preview Invite Handler
+     */
+    async previewInvite(requestParameters: PreviewInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InvitePreviewResponse> {
+        const response = await this.previewInviteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for updateInvite without sending the request
      */