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

package/src/services/FeaturesService.ts

@@ -11,15 +11,22 @@ import { request as __request } from '../core/request';
 export 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
      */
-    public static featuresAppsList(
+    public 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> {
+    }): CancelablePromise<PaginatedUserAppList> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/features/apps/',
@@ -31,13 +38,14 @@ export class FeaturesService {
     }
     /**
      * Updates the user onboarding completed status
-     * @param requestBody
      * @returns OnboardingStatusUpdate
      * @throws ApiError
      */
-    public static featuresAppsUpdateCreate(
+    public static featuresAppsUpdateCreate({
+        requestBody,
+    }: {
         requestBody: OnboardingStatusUpdate,
-    ): CancelablePromise<OnboardingStatusUpdate> {
+    }): CancelablePromise<OnboardingStatusUpdate> {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/api/features/apps/update/',
@@ -51,13 +59,14 @@ export class FeaturesService {
      * 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
      */
-    public static featuresAppsUpdateTrialStatusCreate(
+    public static featuresAppsUpdateTrialStatusCreate({
+        requestBody,
+    }: {
         requestBody: ActivateUserFreeTrial,
-    ): CancelablePromise<ActivateUserFreeTrial> {
+    }): CancelablePromise<ActivateUserFreeTrial> {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/api/features/apps/update-trial-status/',

package/src/services/FinanceService.ts

@@ -12,13 +12,14 @@ import { request as __request } from '../core/request';
 export class FinanceService {
     /**
      * Returns table listing products and product info for all or specific org
-     * @param org
      * @returns Product
      * @throws ApiError
      */
-    public static financeOrgsProductsRetrieve(
+    public static financeOrgsProductsRetrieve({
+        org,
+    }: {
         org: string,
-    ): CancelablePromise<Product> {
+    }): CancelablePromise<Product> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/finance/orgs/{org}/products',
@@ -29,19 +30,26 @@ export class FinanceService {
     }
     /**
      * 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
      */
-    public static financeOrgsProductsOrdersRetrieve(
+    public 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> {
+    }): CancelablePromise<Order> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/finance/orgs/{org}/products/{item_id}/orders',
@@ -57,19 +65,26 @@ export class FinanceService {
     }
     /**
      * 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
      */
-    public static financeOrgsProductsSalesOverTimeRetrieve(
+    public 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> {
+    }): CancelablePromise<NetRevenueOverTime> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/finance/orgs/{org}/products/{item_id}/sales-over-time',
@@ -85,17 +100,24 @@ export class FinanceService {
     }
     /**
      * 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
      */
-    public static financeOrgsRevenueNetOverTimeRetrieve(
+    public 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> {
+    }): CancelablePromise<NetRevenueOverTime> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/finance/orgs/{org}/revenue/net-over-time',
@@ -110,17 +132,24 @@ export class FinanceService {
     }
     /**
      * 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
      */
-    public static financeOrgsRevenueProductsRetrieve(
+    public 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> {
+    }): CancelablePromise<RevenueByProduct> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/finance/orgs/{org}/revenue/products',

package/src/services/MediaResourcesService.ts

@@ -10,27 +10,52 @@ import { request as __request } from '../core/request';
 export 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
      */
-    public static mediaOrgsUsersMediaMediaResourcesList(
+    public 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> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/',
@@ -50,25 +75,44 @@ export 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 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
      */
-    public static mediaOrgsUsersMediaMediaResourcesCreate(
+    public 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> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/',
@@ -88,25 +132,47 @@ export class MediaResourcesService {
     }
     /**
      * 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
      */
-    public static mediaOrgsUsersMediaMediaResourcesRetrieve(
+    public 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> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/{id}/',
@@ -125,27 +191,49 @@ export class MediaResourcesService {
     }
     /**
      * 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
      */
-    public static mediaOrgsUsersMediaMediaResourcesUpdate(
+    public 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> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'PUT',
             url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/{id}/',
@@ -166,27 +254,49 @@ export class MediaResourcesService {
     }
     /**
      * 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
      */
-    public static mediaOrgsUsersMediaMediaResourcesPartialUpdate(
+    public 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> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'PATCH',
             url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/{id}/',
@@ -207,25 +317,47 @@ export class MediaResourcesService {
     }
     /**
      * 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
      */
-    public static mediaOrgsUsersMediaMediaResourcesDestroy(
+    public 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> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'DELETE',
             url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/{id}/',
@@ -244,25 +376,47 @@ export class MediaResourcesService {
     }
     /**
      * 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
      */
-    public static mediaOrgsUsersMediaMediaResourcesByItemRetrieve(
+    public 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> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/by_item/',
@@ -281,25 +435,47 @@ export class MediaResourcesService {
     }
     /**
      * 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
      */
-    public static mediaOrgsUsersMediaMediaResourcesSearchRetrieve(
+    public 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> {
+    }): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/search/',