@iblai/iblai-api 3.48.3-core → 3.48.4-core

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

@@ -5,30 +5,39 @@ import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class FeaturesService {
     /**
      * Returns a list of the apps that the user has access to.
-     * @param page A page number within the paginated result set.
-     * @param pageSize Number of results to return per page.
      * @returns PaginatedUserAppList
      * @throws ApiError
      */
-    static featuresAppsList(page?: number, pageSize?: number): CancelablePromise<PaginatedUserAppList>;
+    static featuresAppsList({ page, pageSize, }: {
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+    }): CancelablePromise<PaginatedUserAppList>;
     /**
      * Updates the user onboarding completed status
-     * @param requestBody
      * @returns OnboardingStatusUpdate
      * @throws ApiError
      */
-    static featuresAppsUpdateCreate(requestBody: OnboardingStatusUpdate): CancelablePromise<OnboardingStatusUpdate>;
+    static featuresAppsUpdateCreate({ requestBody, }: {
+        requestBody: OnboardingStatusUpdate;
+    }): CancelablePromise<OnboardingStatusUpdate>;
     /**
      * Activates free trial for the user
      *
      * Set free_trial_started to True| false for the user app
      *
      * App URL or ID is required as well as the platform key
-     * @param requestBody
      * @returns ActivateUserFreeTrial
      * @throws ApiError
      */
-    static featuresAppsUpdateTrialStatusCreate(requestBody: ActivateUserFreeTrial): CancelablePromise<ActivateUserFreeTrial>;
+    static featuresAppsUpdateTrialStatusCreate({ requestBody, }: {
+        requestBody: ActivateUserFreeTrial;
+    }): CancelablePromise<ActivateUserFreeTrial>;
     /**
      * POST
      * Bulk update user feature config

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

@@ -6,47 +6,76 @@ import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class FinanceService {
     /**
      * Returns table listing products and product info for all or specific org
-     * @param org
      * @returns Product
      * @throws ApiError
      */
-    static financeOrgsProductsRetrieve(org: string): CancelablePromise<Product>;
+    static financeOrgsProductsRetrieve({ org, }: {
+        org: string;
+    }): CancelablePromise<Product>;
     /**
      * Return list of WooCommerce orders for product item_id over optional date range
-     * @param itemId
-     * @param org
-     * @param endDate End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
-     * @param startDate Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
      * @returns Order
      * @throws ApiError
      */
-    static financeOrgsProductsOrdersRetrieve(itemId: string, org: string, endDate?: string, startDate?: string): CancelablePromise<Order>;
+    static financeOrgsProductsOrdersRetrieve({ itemId, org, endDate, startDate, }: {
+        itemId: string;
+        org: string;
+        /**
+         * End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+         */
+        endDate?: string;
+        /**
+         * Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+         */
+        startDate?: string;
+    }): CancelablePromise<Order>;
     /**
      * Returns Net Revenue over time for org and slug
-     * @param itemId
-     * @param org
-     * @param endDate End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
-     * @param startDate Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
      * @returns NetRevenueOverTime
      * @throws ApiError
      */
-    static financeOrgsProductsSalesOverTimeRetrieve(itemId: string, org: string, endDate?: string, startDate?: string): CancelablePromise<NetRevenueOverTime>;
+    static financeOrgsProductsSalesOverTimeRetrieve({ itemId, org, endDate, startDate, }: {
+        itemId: string;
+        org: string;
+        /**
+         * End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+         */
+        endDate?: string;
+        /**
+         * Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+         */
+        startDate?: string;
+    }): CancelablePromise<NetRevenueOverTime>;
     /**
      * Returns Net Revenue over time for org and slug
-     * @param org
-     * @param endDate End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
-     * @param startDate Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
      * @returns NetRevenueOverTime
      * @throws ApiError
      */
-    static financeOrgsRevenueNetOverTimeRetrieve(org: string, endDate?: string, startDate?: string): CancelablePromise<NetRevenueOverTime>;
+    static financeOrgsRevenueNetOverTimeRetrieve({ org, endDate, startDate, }: {
+        org: string;
+        /**
+         * End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+         */
+        endDate?: string;
+        /**
+         * Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+         */
+        startDate?: string;
+    }): CancelablePromise<NetRevenueOverTime>;
     /**
      * Returns Revenue by Product + summary for specific org
-     * @param org
-     * @param endDate End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
-     * @param startDate Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
      * @returns RevenueByProduct
      * @throws ApiError
      */
-    static financeOrgsRevenueProductsRetrieve(org: string, endDate?: string, startDate?: string): CancelablePromise<RevenueByProduct>;
+    static financeOrgsRevenueProductsRetrieve({ org, endDate, startDate, }: {
+        org: string;
+        /**
+         * End of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+         */
+        endDate?: string;
+        /**
+         * Start of date range, not-inclusive. ISO8601 Date or DateTime. Dates will have 00:00:00 set as the time.
+         */
+        startDate?: string;
+    }): CancelablePromise<RevenueByProduct>;
 }

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

@@ -4,109 +4,285 @@ import type { CancelablePromise } from '../core/CancelablePromise';
 export declare class MediaResourcesService {
     /**
      * List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
-     * @param org Organization identifier
-     * @param userId User identifier
-     * @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
-     * @param itemId Filter by item ID
-     * @param page A page number within the paginated result set.
-     * @param pageSize Number of results to return per page.
-     * @param search Search across title, description, course_id, unit_id, item_id, and file_url
-     * @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
      * @returns any Successfully retrieved media resources
      * @throws ApiError
      */
-    static mediaOrgsUsersMediaMediaResourcesList(org: string, userId: string, courseId?: string, itemId?: string, page?: number, pageSize?: number, search?: string, unitId?: string): CancelablePromise<any>;
+    static mediaOrgsUsersMediaMediaResourcesList({ org, userId, courseId, itemId, page, pageSize, search, unitId, }: {
+        /**
+         * Organization identifier
+         */
+        org: string;
+        /**
+         * User identifier
+         */
+        userId: string;
+        /**
+         * Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
+         */
+        courseId?: string;
+        /**
+         * Filter by item ID
+         */
+        itemId?: string;
+        /**
+         * A page number within the paginated result set.
+         */
+        page?: number;
+        /**
+         * Number of results to return per page.
+         */
+        pageSize?: number;
+        /**
+         * Search across title, description, course_id, unit_id, item_id, and file_url
+         */
+        search?: string;
+        /**
+         * Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
+         */
+        unitId?: string;
+    }): CancelablePromise<any>;
     /**
      * List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
-     * @param org Organization identifier
-     * @param userId User identifier
-     * @param requestBody
-     * @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
-     * @param itemId Filter by item ID
-     * @param search Search across title, description, course_id, unit_id, item_id, and file_url
-     * @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
      * @returns any Successfully retrieved media resources
      * @throws ApiError
      */
-    static mediaOrgsUsersMediaMediaResourcesCreate(org: string, userId: string, requestBody: MediaResource, courseId?: string, itemId?: string, search?: string, unitId?: string): CancelablePromise<any>;
+    static mediaOrgsUsersMediaMediaResourcesCreate({ org, userId, requestBody, courseId, itemId, search, unitId, }: {
+        /**
+         * Organization identifier
+         */
+        org: string;
+        /**
+         * User identifier
+         */
+        userId: string;
+        requestBody: MediaResource;
+        /**
+         * Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
+         */
+        courseId?: string;
+        /**
+         * Filter by item ID
+         */
+        itemId?: string;
+        /**
+         * Search across title, description, course_id, unit_id, item_id, and file_url
+         */
+        search?: string;
+        /**
+         * Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
+         */
+        unitId?: string;
+    }): CancelablePromise<any>;
     /**
      * List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
-     * @param id A unique integer value identifying this Media Resource.
-     * @param org Organization identifier
-     * @param userId User identifier
-     * @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
-     * @param itemId Filter by item ID
-     * @param search Search across title, description, course_id, unit_id, item_id, and file_url
-     * @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
      * @returns any Successfully retrieved media resources
      * @throws ApiError
      */
-    static mediaOrgsUsersMediaMediaResourcesRetrieve(id: number, org: string, userId: string, courseId?: string, itemId?: string, search?: string, unitId?: string): CancelablePromise<any>;
+    static mediaOrgsUsersMediaMediaResourcesRetrieve({ id, org, userId, courseId, itemId, search, unitId, }: {
+        /**
+         * A unique integer value identifying this Media Resource.
+         */
+        id: number;
+        /**
+         * Organization identifier
+         */
+        org: string;
+        /**
+         * User identifier
+         */
+        userId: string;
+        /**
+         * Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
+         */
+        courseId?: string;
+        /**
+         * Filter by item ID
+         */
+        itemId?: string;
+        /**
+         * Search across title, description, course_id, unit_id, item_id, and file_url
+         */
+        search?: string;
+        /**
+         * Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
+         */
+        unitId?: string;
+    }): CancelablePromise<any>;
     /**
      * List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
-     * @param id A unique integer value identifying this Media Resource.
-     * @param org Organization identifier
-     * @param userId User identifier
-     * @param requestBody
-     * @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
-     * @param itemId Filter by item ID
-     * @param search Search across title, description, course_id, unit_id, item_id, and file_url
-     * @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
      * @returns any Successfully retrieved media resources
      * @throws ApiError
      */
-    static mediaOrgsUsersMediaMediaResourcesUpdate(id: number, org: string, userId: string, requestBody: MediaResource, courseId?: string, itemId?: string, search?: string, unitId?: string): CancelablePromise<any>;
+    static mediaOrgsUsersMediaMediaResourcesUpdate({ id, org, userId, requestBody, courseId, itemId, search, unitId, }: {
+        /**
+         * A unique integer value identifying this Media Resource.
+         */
+        id: number;
+        /**
+         * Organization identifier
+         */
+        org: string;
+        /**
+         * User identifier
+         */
+        userId: string;
+        requestBody: MediaResource;
+        /**
+         * Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
+         */
+        courseId?: string;
+        /**
+         * Filter by item ID
+         */
+        itemId?: string;
+        /**
+         * Search across title, description, course_id, unit_id, item_id, and file_url
+         */
+        search?: string;
+        /**
+         * Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
+         */
+        unitId?: string;
+    }): CancelablePromise<any>;
     /**
      * List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
-     * @param id A unique integer value identifying this Media Resource.
-     * @param org Organization identifier
-     * @param userId User identifier
-     * @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
-     * @param itemId Filter by item ID
-     * @param search Search across title, description, course_id, unit_id, item_id, and file_url
-     * @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
-     * @param requestBody
      * @returns any Successfully retrieved media resources
      * @throws ApiError
      */
-    static mediaOrgsUsersMediaMediaResourcesPartialUpdate(id: number, org: string, userId: string, courseId?: string, itemId?: string, search?: string, unitId?: string, requestBody?: PatchedMediaResource): CancelablePromise<any>;
+    static mediaOrgsUsersMediaMediaResourcesPartialUpdate({ id, org, userId, courseId, itemId, search, unitId, requestBody, }: {
+        /**
+         * A unique integer value identifying this Media Resource.
+         */
+        id: number;
+        /**
+         * Organization identifier
+         */
+        org: string;
+        /**
+         * User identifier
+         */
+        userId: string;
+        /**
+         * Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
+         */
+        courseId?: string;
+        /**
+         * Filter by item ID
+         */
+        itemId?: string;
+        /**
+         * Search across title, description, course_id, unit_id, item_id, and file_url
+         */
+        search?: string;
+        /**
+         * Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
+         */
+        unitId?: string;
+        requestBody?: PatchedMediaResource;
+    }): CancelablePromise<any>;
     /**
      * List and filter media resources. Supports filtering by course_id, unit_id, item_id and searching across multiple fields.
-     * @param id A unique integer value identifying this Media Resource.
-     * @param org Organization identifier
-     * @param userId User identifier
-     * @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
-     * @param itemId Filter by item ID
-     * @param search Search across title, description, course_id, unit_id, item_id, and file_url
-     * @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
      * @returns any Successfully retrieved media resources
      * @throws ApiError
      */
-    static mediaOrgsUsersMediaMediaResourcesDestroy(id: number, org: string, userId: string, courseId?: string, itemId?: string, search?: string, unitId?: string): CancelablePromise<any>;
+    static mediaOrgsUsersMediaMediaResourcesDestroy({ id, org, userId, courseId, itemId, search, unitId, }: {
+        /**
+         * A unique integer value identifying this Media Resource.
+         */
+        id: number;
+        /**
+         * Organization identifier
+         */
+        org: string;
+        /**
+         * User identifier
+         */
+        userId: string;
+        /**
+         * Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
+         */
+        courseId?: string;
+        /**
+         * Filter by item ID
+         */
+        itemId?: string;
+        /**
+         * Search across title, description, course_id, unit_id, item_id, and file_url
+         */
+        search?: string;
+        /**
+         * Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
+         */
+        unitId?: string;
+    }): CancelablePromise<any>;
     /**
      * Get media resources for a specific item. The item_type determines which resources are returned based on the provided item_id.
-     * @param itemId ID of the item
-     * @param itemType Type of item. Valid values: course, unit, resource, course_unit, course_resource, unit_resource, all
-     * @param org Organization identifier
-     * @param userId User identifier
-     * @param courseId Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
-     * @param search Search across title, description, course_id, unit_id, item_id, and file_url
-     * @param unitId Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
      * @returns any Successfully retrieved media resources for item
      * @throws ApiError
      */
-    static mediaOrgsUsersMediaMediaResourcesByItemRetrieve(itemId: string, itemType: 'all' | 'course' | 'course_resource' | 'course_unit' | 'resource' | 'unit' | 'unit_resource', org: string, userId: string, courseId?: string, search?: string, unitId?: string): CancelablePromise<any>;
+    static mediaOrgsUsersMediaMediaResourcesByItemRetrieve({ itemId, itemType, org, userId, courseId, search, unitId, }: {
+        /**
+         * ID of the item
+         */
+        itemId: string;
+        /**
+         * Type of item. Valid values: course, unit, resource, course_unit, course_resource, unit_resource, all
+         */
+        itemType: 'all' | 'course' | 'course_resource' | 'course_unit' | 'resource' | 'unit' | 'unit_resource';
+        /**
+         * Organization identifier
+         */
+        org: string;
+        /**
+         * User identifier
+         */
+        userId: string;
+        /**
+         * Filter by course ID (e.g., course-v1:main+NB101+2025-T1)
+         */
+        courseId?: string;
+        /**
+         * Search across title, description, course_id, unit_id, item_id, and file_url
+         */
+        search?: string;
+        /**
+         * Filter by unit ID (e.g., block-v1:main+NB101+2025-T1+type@vertical+block@12345)
+         */
+        unitId?: string;
+    }): CancelablePromise<any>;
     /**
      * Search media resources by title, description, or IDs. Supports filtering results by course_id, unit_id, and item_id.
-     * @param org Organization identifier
-     * @param q Search query string
-     * @param userId User identifier
-     * @param courseId Filter results by course ID
-     * @param itemId Filter results by item ID
-     * @param search Search across title, description, course_id, unit_id, item_id, and file_url
-     * @param unitId Filter results by unit ID
      * @returns any Successfully searched media resources
      * @throws ApiError
      */
-    static mediaOrgsUsersMediaMediaResourcesSearchRetrieve(org: string, q: string, userId: string, courseId?: string, itemId?: string, search?: string, unitId?: string): CancelablePromise<any>;
+    static mediaOrgsUsersMediaMediaResourcesSearchRetrieve({ org, q, userId, courseId, itemId, search, unitId, }: {
+        /**
+         * Organization identifier
+         */
+        org: string;
+        /**
+         * Search query string
+         */
+        q: string;
+        /**
+         * User identifier
+         */
+        userId: string;
+        /**
+         * Filter results by course ID
+         */
+        courseId?: string;
+        /**
+         * Filter results by item ID
+         */
+        itemId?: string;
+        /**
+         * Search across title, description, course_id, unit_id, item_id, and file_url
+         */
+        search?: string;
+        /**
+         * Filter results by unit ID
+         */
+        unitId?: string;
+    }): CancelablePromise<any>;
 }

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

@@ -11,48 +11,62 @@ export declare class NotificationBuilderService {
     /**
      * Get build recipients
      * Get paginated list of recipients for a notification build
-     * @param id
-     * @param platformKey
-     * @param page Page number
-     * @param pageSize Number of items per page
-     * @param search Search recipients by username or email
      * @returns Recipient
      * @throws ApiError
      */
-    static notificationV1OrgsNotificationBuilderRecipientsList(id: string, platformKey: string, page?: number, pageSize?: number, search?: string): CancelablePromise<Array<Recipient>>;
+    static notificationV1OrgsNotificationBuilderRecipientsList({ id, platformKey, page, pageSize, search, }: {
+        id: string;
+        platformKey: string;
+        /**
+         * Page number
+         */
+        page?: number;
+        /**
+         * Number of items per page
+         */
+        pageSize?: number;
+        /**
+         * Search recipients by username or email
+         */
+        search?: string;
+    }): CancelablePromise<Array<Recipient>>;
     /**
      * Get notification context data
      * Get all context data needed for notification building including templates, channels, and platforms
-     * @param platformKey
      * @returns ContextResponse
      * @throws ApiError
      */
-    static notificationV1OrgsNotificationBuilderContextRetrieve(platformKey: string): CancelablePromise<ContextResponse>;
+    static notificationV1OrgsNotificationBuilderContextRetrieve({ platformKey, }: {
+        platformKey: string;
+    }): CancelablePromise<ContextResponse>;
     /**
      * Preview notification
      * Preview notification recipients and get build ID for sending
-     * @param platformKey
-     * @param requestBody
      * @returns PreviewResponse
      * @throws ApiError
      */
-    static notificationV1OrgsNotificationBuilderPreviewCreate(platformKey: string, requestBody: NotificationPreview): CancelablePromise<PreviewResponse>;
+    static notificationV1OrgsNotificationBuilderPreviewCreate({ platformKey, requestBody, }: {
+        platformKey: string;
+        requestBody: NotificationPreview;
+    }): CancelablePromise<PreviewResponse>;
     /**
      * Send notification
      * Send notifications to all recipients in a build
-     * @param platformKey
-     * @param requestBody
      * @returns SendResponse
      * @throws ApiError
      */
-    static notificationV1OrgsNotificationBuilderSendCreate(platformKey: string, requestBody: SendNotification): CancelablePromise<SendResponse>;
+    static notificationV1OrgsNotificationBuilderSendCreate({ platformKey, requestBody, }: {
+        platformKey: string;
+        requestBody: SendNotification;
+    }): CancelablePromise<SendResponse>;
     /**
      * Validate notification source
      * Validate a single notification source (email, username, platform, csv)
-     * @param platformKey
-     * @param requestBody
      * @returns ValidateSourceResponse
      * @throws ApiError
      */
-    static notificationV1OrgsNotificationBuilderValidateSourceCreate(platformKey: string, requestBody: NotificationSource): CancelablePromise<ValidateSourceResponse>;
+    static notificationV1OrgsNotificationBuilderValidateSourceCreate({ platformKey, requestBody, }: {
+        platformKey: string;
+        requestBody: NotificationSource;
+    }): CancelablePromise<ValidateSourceResponse>;
 }