@iblai/iblai-api 3.35.3-ai-plus → 3.35.4-core

package/src/services/ServiceService.ts

@@ -0,0 +1,320 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { StripeCheckoutSessionRequest } from '../models/StripeCheckoutSessionRequest';
+import type { StripeCheckoutSessionResponse } from '../models/StripeCheckoutSessionResponse';
+import type { StripeCustomerPortalRequest } from '../models/StripeCustomerPortalRequest';
+import type { StripeCustomerPortalResponse } from '../models/StripeCustomerPortalResponse';
+import type { StripeLocalProduct } from '../models/StripeLocalProduct';
+import type { StripeSubscriptionRenewalRequest } from '../models/StripeSubscriptionRenewalRequest';
+import type { StripeSubscriptionRenewalResponse } from '../models/StripeSubscriptionRenewalResponse';
+import type { TenantLaunchRequest } from '../models/TenantLaunchRequest';
+import type { TenantLaunchResponse } from '../models/TenantLaunchResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class ServiceService {
+    /**
+     * User/tenant creation API
+     *
+     * To create using any payment provider, ensure you use the StudentToken Authentication Mechanism
+     * and also include the correct `provider_key` in the request body:
+     *
+     * ```
+     * apple_transaction_id: str
+     * stripe_checkout_id: str
+     * x_gcp_marketplace_token: str
+     * aws_transaction_id: str
+     * google_pay_transaction_id: str
+     * ```
+     *
+     * To create a tenant without a payment provider, call the API without ny of the above provider keys in the request body
+     * @param requestBody
+     * @returns TenantLaunchResponse
+     * @throws ApiError
+     */
+    public static serviceLaunchTenantCreate(
+        requestBody: TenantLaunchRequest,
+    ): CancelablePromise<TenantLaunchResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/service/launch/tenant/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * User creation flow
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static serviceManageUserCreate(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/service/manage/user/',
+        });
+    }
+    /**
+     * Make user tenant admin
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static serviceManageUserRoleCreate(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/service/manage/user/role/',
+        });
+    }
+    /**
+     * Stripe checkout session API View for user upgrade
+     *
+     * Request the following fields:
+     *
+     * - tenant
+     * - sku
+     * - mode
+     * - success_url
+     * - cancel_url
+     *
+     * Response:
+     * {
+         * "redirect_to": "https://checkout.stripe.com/xxx/xxxx/xxxx",
+         * }
+         * @param org
+         * @param userId
+         * @param requestBody
+         * @returns StripeCheckoutSessionResponse
+         * @throws ApiError
+         */
+        public static serviceOrgsUsersStripeCheckoutSessionCreate(
+            org: string,
+            userId: string,
+            requestBody: StripeCheckoutSessionRequest,
+        ): CancelablePromise<StripeCheckoutSessionResponse> {
+            return __request(OpenAPI, {
+                method: 'POST',
+                url: '/api/service/orgs/{org}/users/{user_id}/stripe/checkout-session/',
+                path: {
+                    'org': org,
+                    'user_id': userId,
+                },
+                body: requestBody,
+                mediaType: 'application/json',
+            });
+        }
+        /**
+         * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+         * @param org
+         * @param userId
+         * @param requestBody
+         * @returns StripeCustomerPortalResponse
+         * @throws ApiError
+         */
+        public static serviceOrgsUsersStripeCustomerPortalCreate(
+            org: string,
+            userId: string,
+            requestBody: StripeCustomerPortalRequest,
+        ): CancelablePromise<StripeCustomerPortalResponse> {
+            return __request(OpenAPI, {
+                method: 'POST',
+                url: '/api/service/orgs/{org}/users/{user_id}/stripe/customer-portal/',
+                path: {
+                    'org': org,
+                    'user_id': userId,
+                },
+                body: requestBody,
+                mediaType: 'application/json',
+            });
+        }
+        /**
+         * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+         * @param org
+         * @param userId
+         * @returns StripeLocalProduct
+         * @throws ApiError
+         */
+        public static serviceOrgsUsersStripeProductsRetrieve(
+            org: string,
+            userId: string,
+        ): CancelablePromise<StripeLocalProduct> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/service/orgs/{org}/users/{user_id}/stripe/products/',
+                path: {
+                    'org': org,
+                    'user_id': userId,
+                },
+            });
+        }
+        /**
+         * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+         * @param org
+         * @param userId
+         * @returns any No response body
+         * @throws ApiError
+         */
+        public static serviceOrgsUsersStripeProductsManageCreate(
+            org: string,
+            userId: string,
+        ): CancelablePromise<any> {
+            return __request(OpenAPI, {
+                method: 'POST',
+                url: '/api/service/orgs/{org}/users/{user_id}/stripe/products/manage/',
+                path: {
+                    'org': org,
+                    'user_id': userId,
+                },
+            });
+        }
+        /**
+         * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+         * @param org
+         * @param userId
+         * @param requestBody
+         * @returns StripeSubscriptionRenewalResponse
+         * @throws ApiError
+         */
+        public static serviceOrgsUsersStripeSubscriptionRenewalCreate(
+            org: string,
+            userId: string,
+            requestBody: StripeSubscriptionRenewalRequest,
+        ): CancelablePromise<StripeSubscriptionRenewalResponse> {
+            return __request(OpenAPI, {
+                method: 'POST',
+                url: '/api/service/orgs/{org}/users/{user_id}/stripe/subscription-renewal/',
+                path: {
+                    'org': org,
+                    'user_id': userId,
+                },
+                body: requestBody,
+                mediaType: 'application/json',
+            });
+        }
+        /**
+         * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+         * @param org
+         * @param userId
+         * @returns any No response body
+         * @throws ApiError
+         */
+        public static serviceOrgsUsersStripeSubscriptionsRetrieve(
+            org: string,
+            userId: string,
+        ): CancelablePromise<any> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/service/orgs/{org}/users/{user_id}/stripe/subscriptions/',
+                path: {
+                    'org': org,
+                    'user_id': userId,
+                },
+            });
+        }
+        /**
+         * Handle course payment callback after successful Stripe checkout.
+         * Enrolls the user in the purchased course.
+         *
+         * URL Parameters:
+         * - stripe_checkout_id: The local Checkout Session UUID
+         *
+         * Response:
+         * - Redirect: Successfully processed course enrollment
+         * - 404: Checkout session not found
+         * - 400: Invalid checkout session or product
+         * - 500: Server error during processing
+         * @param platformKey
+         * @returns any No response body
+         * @throws ApiError
+         */
+        public static serviceOrgsStripeCoursePaymentCallbackRetrieve(
+            platformKey: string,
+        ): CancelablePromise<any> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/service/orgs/{platform_key}/stripe/course-payment-callback/',
+                path: {
+                    'platform_key': platformKey,
+                },
+            });
+        }
+        /**
+         * @param checkoutUuid
+         * @returns any No response body
+         * @throws ApiError
+         */
+        public static serviceStripeCheckoutRetrieve(
+            checkoutUuid: string,
+        ): CancelablePromise<any> {
+            return __request(OpenAPI, {
+                method: 'GET',
+                url: '/api/service/stripe/checkout/{checkout_uuid}/',
+                path: {
+                    'checkout_uuid': checkoutUuid,
+                },
+            });
+        }
+        /**
+         * Stripe free trial checkout session. No user auth
+         *
+         * Request the following fields:
+         *
+         * - success_url
+         * - cancel_url
+         * - product
+         *
+         * Response:
+         * {
+             * "redirect_to": "https://checkout.stripe.com/xxx/xxxx/xxxx",
+             * }
+             * @param requestBody
+             * @returns StripeCheckoutSessionResponse
+             * @throws ApiError
+             */
+            public static serviceStripeCheckoutFreeTrialCreate(
+                requestBody: StripeCheckoutSessionResponse,
+            ): CancelablePromise<StripeCheckoutSessionResponse> {
+                return __request(OpenAPI, {
+                    method: 'POST',
+                    url: '/api/service/stripe/checkout/free-trial/',
+                    body: requestBody,
+                    mediaType: 'application/json',
+                });
+            }
+            /**
+             * Check if tenant exists or not
+             * @returns any No response body
+             * @throws ApiError
+             */
+            public static serviceTenantValidationCreate(): CancelablePromise<any> {
+                return __request(OpenAPI, {
+                    method: 'POST',
+                    url: '/api/service/tenant/validation/',
+                });
+            }
+            /**
+             * GET
+             * Gets site hash_key from
+             * or
+             * Gets site_id form hash_key
+             * @returns any No response body
+             * @throws ApiError
+             */
+            public static serviceTokenRetrieve(): CancelablePromise<any> {
+                return __request(OpenAPI, {
+                    method: 'GET',
+                    url: '/api/service/token/',
+                });
+            }
+            /**
+             * Check if tenant exists or not
+             * @returns any No response body
+             * @throws ApiError
+             */
+            public static serviceUserValidationCreate(): CancelablePromise<any> {
+                return __request(OpenAPI, {
+                    method: 'POST',
+                    url: '/api/service/user/validation/',
+                });
+            }
+        }

package/dist/types/models/AIGeneratedImage.d.ts

@@ -1,13 +0,0 @@
-export type AIGeneratedImage = {
-    readonly id: number;
-    /**
-     * edX user ID
-     */
-    user: number;
-    image: string;
-    platform: number;
-    prompt?: string;
-    model?: string;
-    provider?: string;
-    readonly date_created: string;
-};

package/dist/types/models/APITokenCost.d.ts

@@ -1,14 +0,0 @@
-export type APITokenCost = {
-    /**
-     * Week start date for token usage aggregation
-     */
-    date: string;
-    /**
-     * Total completion tokens used in this week
-     */
-    completion_tokens: number;
-    /**
-     * Total prompt tokens used in this week
-     */
-    prompt_tokens: number;
-};

package/dist/types/models/AccessEnum.d.ts

@@ -1,8 +0,0 @@
-/**
- * * `public` - Public
- * * `private` - Private
- */
-export declare enum AccessEnum {
-    PUBLIC = "public",
-    PRIVATE = "private"
-}

package/dist/types/models/AlignMentorBubbleEnum.d.ts

@@ -1,8 +0,0 @@
-/**
- * * `left` - Left
- * * `right` - Right
- */
-export declare enum AlignMentorBubbleEnum {
-    LEFT = "left",
-    RIGHT = "right"
-}

package/dist/types/models/AnalyticsOverview.d.ts

@@ -1,7 +0,0 @@
-import type { MetricChange } from './MetricChange';
-export type AnalyticsOverview = {
-    conversation_volume: MetricChange;
-    users: MetricChange;
-    topics: MetricChange;
-    user_rating: MetricChange;
-};

package/dist/types/models/Answer.d.ts

@@ -1,11 +0,0 @@
-/**
- * Serializer for an individual answer choice for a question.
- *
- * Attributes:
- * text (str): The text of the answer.
- * is_correct (Optional[bool]): Boolean indicating if this answer is correct.
- */
-export type Answer = {
-    text: string;
-    is_correct?: boolean;
-};

package/dist/types/models/AssumedKnowledge.d.ts

@@ -1,4 +0,0 @@
-import type { AssumedKnowledgeLevel } from './AssumedKnowledgeLevel';
-export type AssumedKnowledge = {
-    levels: Array<AssumedKnowledgeLevel>;
-};

package/dist/types/models/AssumedKnowledgeLevel.d.ts

@@ -1,4 +0,0 @@
-export type AssumedKnowledgeLevel = {
-    category: string;
-    level: string;
-};

package/dist/types/models/AudioToTextRequest.d.ts

@@ -1,3 +0,0 @@
-export type AudioToTextRequest = {
-    file: string;
-};

package/dist/types/models/AudioToTextResponse.d.ts

@@ -1,3 +0,0 @@
-export type AudioToTextResponse = {
-    text: string;
-};

package/dist/types/models/Bot.d.ts

@@ -1,15 +0,0 @@
-import type { Provider05cEnum } from './Provider05cEnum';
-export type Bot = {
-    readonly id: number;
-    readonly platform: number;
-    readonly tenant: string;
-    name: string;
-    provider: Provider05cEnum;
-    readonly is_configured: boolean;
-    slack_config: number;
-    readonly discord_config: number;
-    readonly webex_config: number;
-    readonly whatsapp_config: number;
-    readonly teams_config: number;
-    readonly webhook_url: string;
-};

package/dist/types/models/BotCommand.d.ts

@@ -1,6 +0,0 @@
-export type BotCommand = {
-    readonly id: number;
-    command: string;
-    mentor: number;
-    bot: number;
-};

package/dist/types/models/BotCreate.d.ts

@@ -1,12 +0,0 @@
-import type { Provider05cEnum } from './Provider05cEnum';
-export type BotCreate = {
-    readonly id: number;
-    name: string;
-    provider: Provider05cEnum;
-    readonly is_configured: boolean;
-    readonly webhook_url: string;
-    readonly discord_config: number;
-    readonly webex_config: number;
-    readonly whatsapp_config: number;
-    readonly teams_config: number;
-};

package/dist/types/models/CallAuthenticationRequest.d.ts

@@ -1,13 +0,0 @@
-/**
- * Serializer for IBL Call Pro authentication request.
- */
-export type CallAuthenticationRequest = {
-    /**
-     * The ID of the session for the call
-     */
-    session_id: string;
-    /**
-     * The pathway identifier for the call context
-     */
-    pathway: string;
-};

package/dist/types/models/CallAuthenticationResponse.d.ts

@@ -1,21 +0,0 @@
-/**
- * Serializer for IBL Call Pro authentication parameters.
- */
-export type CallAuthenticationResponse = {
-    /**
-     * The WebSocket URL for the IBL Call Pro server
-     */
-    ws_url: string;
-    /**
-     * The name of the IBL Call Pro room
-     */
-    room_name: string;
-    /**
-     * The name of the participant joining the room
-     */
-    participant_name: string;
-    /**
-     * The JWT token for authenticating the participant
-     */
-    participant_token: string;
-};

package/dist/types/models/ChatHistory.d.ts

@@ -1,8 +0,0 @@
-export type ChatHistory = {
-    readonly id: number;
-    message?: any;
-    readonly inserted_at: string;
-    title?: string | null;
-    readonly feedback: any;
-    document_sources?: any;
-};

package/dist/types/models/ChatHistoryFilterData.d.ts

@@ -1,9 +0,0 @@
-import type { ChatHistoryFilterUser } from './ChatHistoryFilterUser';
-import type { DateRange } from './DateRange';
-import type { TopicModel } from './TopicModel';
-export type ChatHistoryFilterData = {
-    topics: Array<TopicModel>;
-    date_ranges?: Array<DateRange>;
-    sentiment?: Array<string>;
-    users: Array<ChatHistoryFilterUser>;
-};

package/dist/types/models/ChatHistoryFilterUser.d.ts

@@ -1,5 +0,0 @@
-export type ChatHistoryFilterUser = {
-    username: string;
-    email: string;
-    readonly lti_email: string;
-};

package/dist/types/models/ChatHistoryItem.d.ts

@@ -1,5 +0,0 @@
-export type ChatHistoryItem = {
-    type: string;
-    content: string;
-    timestamp: string;
-};

package/dist/types/models/ChatHistorySessionId.d.ts

@@ -1,3 +0,0 @@
-export type ChatHistorySessionId = {
-    id: string;
-};

package/dist/types/models/ChatSessionRequest.d.ts

@@ -1,10 +0,0 @@
-export type ChatSessionRequest = {
-    /**
-     * Name of mentor
-     */
-    mentor: string;
-    /**
-     * List of tools slugs to use. Passing `null` will use all tools assigned to the mentor. For no tools, pass an empty list.
-     */
-    tools?: Array<string>;
-};

package/dist/types/models/ChatSessionResponse.d.ts

@@ -1,5 +0,0 @@
-import type { ToolResponse } from './ToolResponse';
-export type ChatSessionResponse = {
-    session_id: string;
-    tools: Array<ToolResponse>;
-};

package/dist/types/models/CheckDocumentTrainingStatus.d.ts

@@ -1,10 +0,0 @@
-export type CheckDocumentTrainingStatus = {
-    /**
-     * Status of the training
-     */
-    status: string;
-    /**
-     * Message of the training
-     */
-    message: string;
-};

package/dist/types/models/ComponentBlock.d.ts

@@ -1,9 +0,0 @@
-import type { ComponentBlockTypeEnum } from './ComponentBlockTypeEnum';
-export type ComponentBlock = {
-    readonly id: number;
-    unit: number;
-    type?: ComponentBlockTypeEnum;
-    display_name: string;
-    readonly created_at: string;
-    readonly updated_at: string;
-};

package/dist/types/models/ComponentBlockTypeEnum.d.ts

@@ -1,8 +0,0 @@
-/**
- * * `html` - Html
- * * `multiple_choice` - Multiple Choice
- */
-export declare enum ComponentBlockTypeEnum {
-    HTML = "html",
-    MULTIPLE_CHOICE = "multiple_choice"
-}

package/dist/types/models/ConversationMessage.d.ts

@@ -1,11 +0,0 @@
-import type { TopicModel } from './TopicModel';
-export type ConversationMessage = {
-    readonly first_message: string;
-    topics: Array<TopicModel>;
-    id: string;
-    user_id: string;
-    readonly message_count: number;
-    model: string;
-    inserted_at: string;
-    readonly user_sentiment: string;
-};

package/dist/types/models/ConversationRating.d.ts

@@ -1,6 +0,0 @@
-export type ConversationRating = {
-    readonly id: number;
-    full_conversation_text: string;
-    rating_text?: string | null;
-    score?: number | null;
-};

package/dist/types/models/ConversationSummary.d.ts

@@ -1,5 +0,0 @@
-export type ConversationSummary = {
-    total_conversations: number;
-    total_human_messages: number;
-    total_ai_messages: number;
-};

package/dist/types/models/ConversationVolume.d.ts

@@ -1,4 +0,0 @@
-export type ConversationVolume = {
-    date: string;
-    conversation_count: number;
-};

package/dist/types/models/Conversations.d.ts

@@ -1,28 +0,0 @@
-import type { TopicModel } from './TopicModel';
-export type Conversations = {
-    readonly id: string;
-    readonly messages: string;
-    topics: Array<TopicModel>;
-    readonly sentiment: string;
-    mentor: string;
-    readonly student: string;
-    readonly email: string;
-    model: string;
-    readonly rating: number;
-    platform: string;
-    /**
-     * Email claim from LTI1.3 JWT if an LTI user and available
-     */
-    readonly lti_email: string;
-    /**
-     * Username claim from LTI1.3 JWT if an LTI user and available
-     */
-    readonly lti_username: string;
-    readonly inserted_at: string;
-    has_document?: boolean;
-    memory_tracked?: boolean;
-    llm_name?: string | null;
-    llm_provider?: string | null;
-    metadata?: any;
-    tools?: Array<number>;
-};

package/dist/types/models/Cost.d.ts

@@ -1,3 +0,0 @@
-export type Cost = {
-    total_cost: number;
-};

package/dist/types/models/CostPerTenant.d.ts

@@ -1,6 +0,0 @@
-import type { ModelCost } from './ModelCost';
-export type CostPerTenant = {
-    platform_key: string;
-    total_cost: number;
-    model_costs: Array<ModelCost>;
-};