@iblai/iblai-api 0.0.1-core

package/dist/types/services/PlatformService.d.ts

@@ -0,0 +1,391 @@
+import type { Count } from '../models/Count';
+import type { OverTimeWithTotal } from '../models/OverTimeWithTotal';
+import type { PerlearnerCourseProgress } from '../models/PerlearnerCourseProgress';
+import type { VideosCount } from '../models/VideosCount';
+import type { WatchedVideosPerCourse } from '../models/WatchedVideosPerCourse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class PlatformService {
+    /**
+     * Get a list of registered users on the platform.
+     *
+     * This endpoint provides a list of all registered users with basic profile
+     * information including username, name, email, and registration date.
+     *
+     * Returns:
+     * A list of registered users with their profile information.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * Completion information per enrolled user
+     *
+     * Gives Percentage of units completed in course
+     *
+     * Query Params
+     * course_id <required>
+     * user_id <optional>
+     * @param courseId
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsCoursesProgressRetrieve(courseId: string, org: string): CancelablePromise<any>;
+    /**
+     * Average days used to complete a course
+     *
+     * Query Params
+     * 1. course_id <optional> e.g course-v1:Org+Course4+Run
+     * @param courseId
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsCoursesProgressAverageDaysToCompleteRetrieve(courseId: string, org: string): CancelablePromise<any>;
+    /**
+     * Average time used to complete a course in secs
+     *
+     * Query Params
+     * 1. course_id <optional> e.g course-v1:Org+Course4+Run
+     * @param courseId
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsCoursesProgressAverageTimeToCompleteRetrieve(courseId: string, org: string): CancelablePromise<any>;
+    /**
+     * Get completion count statistics.
+     *
+     * This endpoint returns completion counts at different levels:
+     * - Platform level: Total users who have completed at least one course
+     * - Course level: Total completions for a specific course
+     * - Learner level: Total courses completed by a specific learner
+     *
+     * Query Parameters:
+     * course_id (str, optional): Filter by course ID
+     * user_id (str, optional): Filter by username or email
+     *
+     * Returns:
+     * A count of completions based on the specified filters.
+     * @param courseId
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsCoursesProgressCompletedRetrieve(courseId: string, org: string): CancelablePromise<any>;
+    /**
+     * Average of total completed units
+     * @param courseId
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsCoursesProgressCompletionRateRetrieve(courseId: string, org: string): CancelablePromise<any>;
+    /**
+     * In Progress means any unit completion in the past 30 days
+     *
+     * For platform :  Total users who have atleast a course in_progress on the platform
+     * For course : Total users
+     * For learner : Total courses in progress
+     *
+     * Query Params
+     * 1. course_id <optional> e.g course-v1:Org+Course4+Run
+     * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
+     * @param courseId
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsCoursesProgressInProgressRetrieve(courseId: string, org: string): CancelablePromise<any>;
+    /**
+     * Started means an enrollment
+     *
+     * For platform :  Total users who have atleast an enrollment
+     * For course : Total users enrolled
+     * For learner : Total courses in progress
+     *
+     * Query Params
+     * 1. course_id <optional> e.g course-v1:Org+Course4+Run
+     * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
+     * @param courseId
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsCoursesProgressStartedRetrieve(courseId: string, org: string): CancelablePromise<any>;
+    /**
+     * Base class for API views that return a single count value.
+     *
+     * This class formats the response as {"data": {value_key: count}} where
+     * value_key is configurable (defaults to "count").
+     *
+     * Attributes:
+     * value_key: The key used in the response for the count value
+     * @param courseId
+     * @param org
+     * @param userId
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsCoursesUsersGradesPassedRetrieve(courseId: string, org: string, userId: string): CancelablePromise<any>;
+    /**
+     * Gives Percentage of units completed in course for a specific learner
+     * @param courseId
+     * @param org
+     * @param userId
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @returns PerlearnerCourseProgress
+     * @throws ApiError
+     */
+    static platformOrgsCoursesUsersProgressRetrieve(courseId: string, org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<PerlearnerCourseProgress>;
+    /**
+     * Average days used to complete a course
+     *
+     * Query Params
+     * 1. course_id <optional> e.g course-v1:Org+Course4+Run
+     * @param courseId
+     * @param org
+     * @param userId
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsCoursesUsersProgressDaysToCompleteRetrieve(courseId: string, org: string, userId: string): CancelablePromise<any>;
+    /**
+     * Time spent count in seconds within a course by a learner
+     * @param courseId
+     * @param org
+     * @param userId
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns Count
+     * @throws ApiError
+     */
+    static platformOrgsCoursesUsersTimeCountRetrieve(courseId: string, org: string, userId: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<Count>;
+    /**
+     * (Total videos watched / Total Course Videos) or Total Videos watched in a course by a learner
+     * @param courseId
+     * @param org
+     * @param userId
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @returns VideosCount
+     * @throws ApiError
+     */
+    static platformOrgsCoursesUsersVideosCountRetrieve(courseId: string, org: string, userId: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<VideosCount>;
+    /**
+     * Count of total videos in a course
+     *
+     * Query Params
+     * course_id  e.g course-v1:Org+Course4+Run
+     * @param courseId
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsCoursesVideosRetrieve2(courseId: string, org: string): CancelablePromise<any>;
+    /**
+     * Get total count of courses on the platform.
+     *
+     * This endpoint returns the total number of courses available on the platform.
+     *
+     * Returns:
+     * The total count of courses on the platform.
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @returns Count
+     * @throws ApiError
+     */
+    static platformOrgsCoursesCountRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<Count>;
+    /**
+     * List grading information on a per-course basis.
+     *
+     * This endpoint provides grading statistics for all courses, including
+     * average grades and completion rates.
+     *
+     * Returns:
+     * A list of courses with their associated grading metrics.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsCoursesGradesRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * Get video watch statistics on a per-course basis.
+     *
+     * This endpoint provides a list of courses with aggregated video watch metrics,
+     * including total views and completion percentages.
+     *
+     * Returns:
+     * A list of courses with:
+     * - Course identification (ID and name)
+     * - Video watch count
+     * - Percentage of total videos watched
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @returns WatchedVideosPerCourse
+     * @throws ApiError
+     */
+    static platformOrgsCoursesVideosRetrieve(org: string, departmentId?: number, format?: 'json', includeMainPlatform?: boolean): CancelablePromise<WatchedVideosPerCourse>;
+    /**
+     * Get completion count statistics.
+     *
+     * This endpoint returns completion counts at different levels:
+     * - Platform level: Total users who have completed at least one course
+     * - Course level: Total completions for a specific course
+     * - Learner level: Total courses completed by a specific learner
+     *
+     * Query Parameters:
+     * course_id (str, optional): Filter by course ID
+     * user_id (str, optional): Filter by username or email
+     *
+     * Returns:
+     * A count of completions based on the specified filters.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsProgressCompletedRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * Average of total completed units
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsProgressCompletionRateRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * In Progress means any unit completion in the past 30 days
+     *
+     * For platform :  Total users who have atleast a course in_progress on the platform
+     * For course : Total users
+     * For learner : Total courses in progress
+     *
+     * Query Params
+     * 1. course_id <optional> e.g course-v1:Org+Course4+Run
+     * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsProgressInProgressRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * Started means an enrollment
+     *
+     * For platform :  Total users who have atleast an enrollment
+     * For course : Total users enrolled
+     * For learner : Total courses in progress
+     *
+     * Query Params
+     * 1. course_id <optional> e.g course-v1:Org+Course4+Run
+     * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsProgressStartedRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * Total time spent count on the platform within specified range or all time
+     *
+     * Query Params
+     * 1. start_date e.g 2020-10-01
+     * 2. end_date e.g 2020-10-10
+     *
+     * Default result is all time
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static platformOrgsTimeCountRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * Get count of active users on the platform.
+     *
+     * This endpoint returns the number of users who have had activity on the platform,
+     * either for all time or within a specified date range.
+     *
+     * Query Parameters:
+     * start_date (str, optional): Start date for filtering (ISO format)
+     * end_date (str, optional): End date for filtering (ISO format)
+     *
+     * Returns:
+     * The count of active users and change metrics compared to previous periods.
+     *
+     * Default behavior returns the count for all time if no date range is specified.
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OverTimeWithTotal
+     * @throws ApiError
+     */
+    static platformOrgsUsersActiveCountRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    /**
+     * Get count of registered users on the platform.
+     *
+     * This endpoint returns the number of users registered on the platform,
+     * either for all time or within a specified date range.
+     *
+     * Query Parameters:
+     * start_date (str, optional): Start date for filtering (ISO format)
+     * end_date (str, optional): End date for filtering (ISO format)
+     *
+     * Returns:
+     * The count of registered users and change metrics compared to previous periods.
+     *
+     * Default behavior returns the count for all time if no date range is specified.
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OverTimeWithTotal
+     * @throws ApiError
+     */
+    static platformOrgsUsersCountRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+    /**
+     * Count of users who have completed a course on the platform within specified range or all time
+     *
+     * Query Params
+     * 1. start_date e.g 2020-10-01
+     * 2. end_date e.g 2020-10-10
+     *
+     * Default is all time
+     * @param org
+     * @param departmentId When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
+     * @param endDate end date. ISO 8601
+     * @param format Format
+     *
+     * * `json` - json
+     * @param includeMainPlatform Include main platform data
+     * @param startDate start date. ISO 8601
+     * @returns OverTimeWithTotal
+     * @throws ApiError
+     */
+    static platformOrgsUsersCoursesCompletedCountRetrieve(org: string, departmentId?: number, endDate?: string, format?: 'json', includeMainPlatform?: boolean, startDate?: string): CancelablePromise<OverTimeWithTotal>;
+}

package/dist/types/services/ProviderAssociationService.d.ts

@@ -0,0 +1,16 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ProviderAssociationService {
+    /**
+     * Handle callbacks from Stripe after successful checkout.
+     *
+     * Updates:
+     * - Platform launch state
+     * - Association configuration status
+     * @param launchId
+     * @returns any
+     * @throws ApiError
+     */
+    static providerAssociationStripeCallbackRetrieve(launchId: string): CancelablePromise<{
+        message?: string;
+    }>;
+}

package/dist/types/services/ProvidersService.d.ts

@@ -0,0 +1,142 @@
+import type { AppleSubscriptionStatusRequest } from '../models/AppleSubscriptionStatusRequest';
+import type { AppleSubscriptionStatusView } from '../models/AppleSubscriptionStatusView';
+import type { AppleVerifyTransactionId } from '../models/AppleVerifyTransactionId';
+import type { AssociateAccountResponse } from '../models/AssociateAccountResponse';
+import type { AssociateAppleAccount } from '../models/AssociateAppleAccount';
+import type { AWSTenantLaunchRequest } from '../models/AWSTenantLaunchRequest';
+import type { BaseResponse } from '../models/BaseResponse';
+import type { GCPTenantLaunchRequest } from '../models/GCPTenantLaunchRequest';
+import type { GooglePayAccountResponse } from '../models/GooglePayAccountResponse';
+import type { GooglePayVerifyToken } from '../models/GooglePayVerifyToken';
+import type { TenantLaunchResponse } from '../models/TenantLaunchResponse';
+import type { VerifyGCPMarketPlaceRequest } from '../models/VerifyGCPMarketPlaceRequest';
+import type { VerifyGCPMarketPlaceResponse } from '../models/VerifyGCPMarketPlaceResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ProvidersService {
+    /**
+     * Associate an Apple account with a user known user
+     * @param requestBody
+     * @returns AssociateAccountResponse
+     * @throws ApiError
+     */
+    static providersAppleAssociateAccountCreate(requestBody: AssociateAppleAccount): CancelablePromise<AssociateAccountResponse>;
+    /**
+     * View to handle apple webhooks
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersAppleHookCreate(): CancelablePromise<any>;
+    /**
+     * Returns information about a user subscription status
+     * @param requestBody
+     * @returns AppleSubscriptionStatusView
+     * @throws ApiError
+     */
+    static providersAppleSubscriptionStatusCreate(requestBody?: AppleSubscriptionStatusRequest): CancelablePromise<AppleSubscriptionStatusView>;
+    /**
+     * Checks if a provided transaction_id is valid
+     * @param requestBody
+     * @returns BaseResponse
+     * @throws ApiError
+     */
+    static providersAppleValidateTransactionIdCreate(requestBody: AppleVerifyTransactionId): CancelablePromise<BaseResponse>;
+    /**
+     * Serves a view that redirects to the AWS marketplace create organization page
+     *
+     * Set CREATE_ORGANIZATION_URL in GlobalConfigurationFetcher to the
+     * URL of the AWS marketplace create organization page
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersAwsCreateOrganizationCreate(): CancelablePromise<any>;
+    /**
+     * API endpoint to get domain setup status
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersAwsDomainStatusRetrieve(): CancelablePromise<any>;
+    /**
+     * Proxy to the Platform launch API
+     *
+     * We cannot expose launching a tenant to an authorized user hence the need for the API
+     *
+     * The API validates the x_amzn_marketplace_token and then proxies the request to the Platform Launch API
+     * @param requestBody
+     * @returns TenantLaunchResponse
+     * @throws ApiError
+     */
+    static providersAwsLaunchTenantCreate(requestBody: AWSTenantLaunchRequest): CancelablePromise<TenantLaunchResponse>;
+    /**
+     * API endpoint to get/update CNAME records for domain setup
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersAwsSyncDomainRecordsRetrieve(): CancelablePromise<any>;
+    /**
+     * API endpoint to get/update CNAME records for domain setup
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersAwsSyncDomainRecordsCreate(): CancelablePromise<any>;
+    /**
+     * Serves a view that redirects to the GCP marketplace create organization page
+     *
+     * Set CREATE_ORGANIZATION_URL in GlobalConfigurationFetcher to the URL of the GCP marketplace create organization
+     * page
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersGcpCreateOrganizationCreate(): CancelablePromise<any>;
+    /**
+     * Serves a view that redirects to the GCP marketplace create organization page
+     *
+     * Set CREATE_ORGANIZATION_URL in GlobalConfigurationFetcher to the URL of the GCP marketplace create organization
+     * page
+     * @param productId
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersGcpCreateOrganizationCreate2(productId: string): CancelablePromise<any>;
+    /**
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersGcpHookCreate(): CancelablePromise<any>;
+    /**
+     * Proxy to the Platform launch API
+     *
+     * We cannot expose launching a tenant to an authorized user hence the need for the API
+     *
+     * The API validates the x_gcp_marketplace_token and then proxies the request to the Platform Launc API
+     * @param requestBody
+     * @returns TenantLaunchResponse
+     * @throws ApiError
+     */
+    static providersGcpLaunchTenantCreate(requestBody: GCPTenantLaunchRequest): CancelablePromise<TenantLaunchResponse>;
+    /**
+     * @param requestBody
+     * @returns VerifyGCPMarketPlaceResponse
+     * @throws ApiError
+     */
+    static providersGcpValidateSignupTokenCreate(requestBody: VerifyGCPMarketPlaceRequest): CancelablePromise<VerifyGCPMarketPlaceResponse>;
+    /**
+     * Google Allows us to pass an obfuscated account id to be sent to during a subscription purchase
+     * @param bundleId
+     * @returns GooglePayAccountResponse
+     * @throws ApiError
+     */
+    static providersGooglePayGetAccountRetrieve(bundleId: string): CancelablePromise<GooglePayAccountResponse>;
+    /**
+     * View to handle Google Pay webhooks
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static providersGooglePayHookCreate(): CancelablePromise<any>;
+    /**
+     * Associate a Google Pay account with a known user
+     * @param requestBody
+     * @returns BaseResponse
+     * @throws ApiError
+     */
+    static providersGooglePayValidateTransactionIdCreate(requestBody: GooglePayVerifyToken): CancelablePromise<BaseResponse>;
+}

package/dist/types/services/ProvisionService.d.ts

@@ -0,0 +1,14 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ProvisionService {
+    /**
+     * POST
+     * Update platform provisioning config
+     *
+     * request body:
+     * {"config_name": "demo_config}
+     * @param configName
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static provisionCreate(configName: string): CancelablePromise<any>;
+}

package/dist/types/services/RecommendationsService.d.ts

@@ -0,0 +1,13 @@
+import type { RecommendationSearchAPI } from '../models/RecommendationSearchAPI';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class RecommendationsService {
+    /**
+     * API endpoint that returns a search api url prepopulated with context data
+     * See http://localhost:8000/api/schema/swagger-ui/#/recommendations
+     * @param org
+     * @param userId
+     * @returns RecommendationSearchAPI
+     * @throws ApiError
+     */
+    static recommendationsOrgsUsersRetrieve(org: string, userId: string): CancelablePromise<RecommendationSearchAPI>;
+}