@iblai/iblai-api 3.58.0-core → 3.59.0-ai

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

@@ -1,496 +0,0 @@
-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.
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsRetrieve({ org, }: {
-        org: string;
-    }): CancelablePromise<any>;
-    /**
-     * Completion information per enrolled user
-     *
-     * Gives Percentage of units completed in course
-     *
-     * Query Params
-     * course_id <required>
-     * user_id <optional>
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsCoursesProgressRetrieve({ courseId, org, }: {
-        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
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsCoursesProgressAverageDaysToCompleteRetrieve({ courseId, org, }: {
-        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
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsCoursesProgressAverageTimeToCompleteRetrieve({ courseId, org, }: {
-        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.
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsCoursesProgressCompletedRetrieve({ courseId, org, }: {
-        courseId: string;
-        org: string;
-    }): CancelablePromise<any>;
-    /**
-     * Average of total completed units
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsCoursesProgressCompletionRateRetrieve({ courseId, org, }: {
-        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)
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsCoursesProgressInProgressRetrieve({ courseId, org, }: {
-        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)
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsCoursesProgressStartedRetrieve({ courseId, org, }: {
-        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
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsCoursesUsersGradesPassedRetrieve({ courseId, org, userId, }: {
-        courseId: string;
-        org: string;
-    }): CancelablePromise<any>;
-    /**
-     * Gives Percentage of units completed in course for a specific learner
-     * @returns PerlearnerCourseProgress
-     * @throws ApiError
-     */
-    static platformOrgsCoursesUsersProgressRetrieve({ courseId, org, userId, departmentId, format, includeMainPlatform, }: {
-        courseId: string;
-        org: string; /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number; /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json'; /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-    }): CancelablePromise<PerlearnerCourseProgress>;
-    /**
-     * Average days used to complete a course
-     *
-     * Query Params
-     * 1. course_id <optional> e.g course-v1:Org+Course4+Run
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsCoursesUsersProgressDaysToCompleteRetrieve({ courseId, org, userId, }: {
-        courseId: string;
-        org: string;
-    }): CancelablePromise<any>;
-    /**
-     * Time spent count in seconds within a course by a learner
-     * @returns Count
-     * @throws ApiError
-     */
-    static platformOrgsCoursesUsersTimeCountRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        courseId: string;
-        org: string; /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number; /**
-         * end date. ISO 8601
-         */
-        endDate?: string; /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json'; /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean; /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<Count>;
-    /**
-     * (Total videos watched / Total Course Videos) or Total Videos watched in a course by a learner
-     * @returns VideosCount
-     * @throws ApiError
-     */
-    static platformOrgsCoursesUsersVideosCountRetrieve({ courseId, org, userId, departmentId, format, includeMainPlatform, }: {
-        courseId: string;
-        org: string; /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number; /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json'; /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-    }): CancelablePromise<VideosCount>;
-    /**
-     * Count of total videos in a course
-     *
-     * Query Params
-     * course_id  e.g course-v1:Org+Course4+Run
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsCoursesVideosRetrieve2({ courseId, org, }: {
-        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.
-     * @returns Count
-     * @throws ApiError
-     */
-    static platformOrgsCoursesCountRetrieve({ org, departmentId, format, includeMainPlatform, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        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.
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsCoursesGradesRetrieve({ org, }: {
-        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
-     * @returns WatchedVideosPerCourse
-     * @throws ApiError
-     */
-    static platformOrgsCoursesVideosRetrieve({ org, departmentId, format, includeMainPlatform, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        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.
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsProgressCompletedRetrieve({ org, }: {
-        org: string;
-    }): CancelablePromise<any>;
-    /**
-     * Average of total completed units
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsProgressCompletionRateRetrieve({ org, }: {
-        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)
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsProgressInProgressRetrieve({ org, }: {
-        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)
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsProgressStartedRetrieve({ org, }: {
-        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
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static platformOrgsTimeCountRetrieve({ org, }: {
-        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.
-     * @returns OverTimeWithTotal
-     * @throws ApiError
-     */
-    static platformOrgsUsersActiveCountRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-        /**
-         * start date. ISO 8601
-         */
-        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.
-     * @returns OverTimeWithTotal
-     * @throws ApiError
-     */
-    static platformOrgsUsersCountRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-        /**
-         * start date. ISO 8601
-         */
-        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
-     * @returns OverTimeWithTotal
-     * @throws ApiError
-     */
-    static platformOrgsUsersCoursesCompletedCountRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
-        org: string;
-        /**
-         * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
-         */
-        departmentId?: number;
-        /**
-         * end date. ISO 8601
-         */
-        endDate?: string;
-        /**
-         * Format
-         *
-         * * `json` - json
-         */
-        format?: 'json';
-        /**
-         * Include main platform data
-         */
-        includeMainPlatform?: boolean;
-        /**
-         * start date. ISO 8601
-         */
-        startDate?: string;
-    }): CancelablePromise<OverTimeWithTotal>;
-}

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

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

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

@@ -1,164 +0,0 @@
-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 { StripeNewUserTenantLaunchRequest } from '../models/StripeNewUserTenantLaunchRequest';
-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
-     * @returns AssociateAccountResponse
-     * @throws ApiError
-     */
-    static providersAppleAssociateAccountCreate({ requestBody, }: {
-        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
-     * @returns AppleSubscriptionStatusView
-     * @throws ApiError
-     */
-    static providersAppleSubscriptionStatusCreate({ requestBody, }: {
-        requestBody?: AppleSubscriptionStatusRequest;
-    }): CancelablePromise<AppleSubscriptionStatusView>;
-    /**
-     * Checks if a provided transaction_id is valid
-     * @returns BaseResponse
-     * @throws ApiError
-     */
-    static providersAppleValidateTransactionIdCreate({ requestBody, }: {
-        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
-     * @returns TenantLaunchResponse
-     * @throws ApiError
-     */
-    static providersAwsLaunchTenantCreate({ requestBody, }: {
-        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
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static providersGcpCreateOrganizationCreate2({ productId, }: {
-        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
-     * @returns TenantLaunchResponse
-     * @throws ApiError
-     */
-    static providersGcpLaunchTenantCreate({ requestBody, }: {
-        requestBody: GCPTenantLaunchRequest;
-    }): CancelablePromise<TenantLaunchResponse>;
-    /**
-     * @returns VerifyGCPMarketPlaceResponse
-     * @throws ApiError
-     */
-    static providersGcpValidateSignupTokenCreate({ requestBody, }: {
-        requestBody: VerifyGCPMarketPlaceRequest;
-    }): CancelablePromise<VerifyGCPMarketPlaceResponse>;
-    /**
-     * Google Allows us to pass an obfuscated account id to be sent to during a subscription purchase
-     * @returns GooglePayAccountResponse
-     * @throws ApiError
-     */
-    static providersGooglePayGetAccountRetrieve({ bundleId, }: {
-        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
-     * @returns BaseResponse
-     * @throws ApiError
-     */
-    static providersGooglePayValidateTransactionIdCreate({ requestBody, }: {
-        requestBody: GooglePayVerifyToken;
-    }): CancelablePromise<BaseResponse>;
-    /**
-     * Proxy to the Platform launch API
-     *
-     * We cannot expose launching a tenant to an unauthorized user hence the need for the API
-     *
-     * The API validates the stripe_checkout_id and then proxies the request to the Platform Launch API
-     * @returns TenantLaunchResponse
-     * @throws ApiError
-     */
-    static providersStripeCreateOrganizationCreate({ requestBody, }: {
-        requestBody: StripeNewUserTenantLaunchRequest;
-    }): CancelablePromise<TenantLaunchResponse>;
-}

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

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