@iblai/iblai-api 0.0.1-core

package/src/services/FeaturesService.ts

@@ -0,0 +1,126 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ActivateUserFreeTrial } from '../models/ActivateUserFreeTrial';
+import type { OnboardingStatusUpdate } from '../models/OnboardingStatusUpdate';
+import type { PaginatedUserAppList } from '../models/PaginatedUserAppList';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+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(
+        page?: number,
+        pageSize?: number,
+    ): CancelablePromise<PaginatedUserAppList> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/features/apps/',
+            query: {
+                'page': page,
+                'page_size': pageSize,
+            },
+        });
+    }
+    /**
+     * Updates the user onboarding completed status
+     * @param requestBody
+     * @returns OnboardingStatusUpdate
+     * @throws ApiError
+     */
+    public static featuresAppsUpdateCreate(
+        requestBody: OnboardingStatusUpdate,
+    ): CancelablePromise<OnboardingStatusUpdate> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/features/apps/update/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * 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
+     */
+    public static featuresAppsUpdateTrialStatusCreate(
+        requestBody: ActivateUserFreeTrial,
+    ): CancelablePromise<ActivateUserFreeTrial> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/features/apps/update-trial-status/',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * POST
+     * Bulk update user feature config
+     *
+     * NOTE: Will not create user feature configs
+     *
+     * Params:
+     * platform_key
+     *
+     * config
+     * (OR)
+     * feature
+     * values
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static featuresBulkConfigCreate(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/features/bulk-config/',
+        });
+    }
+    /**
+     * Query user feature config
+     *
+     * Params:
+     * user_id/username/email
+     * platform_key
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static featuresConfigRetrieve(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/features/config/',
+        });
+    }
+    /**
+     * POST
+     * Update user feature config
+     *
+     * Params:
+     * user_id/username/email
+     * platform_key
+     *
+     * config
+     * (OR)
+     * feature
+     * values
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static featuresConfigCreate(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/features/config/',
+        });
+    }
+}

package/src/services/FinanceService.ts

@@ -0,0 +1,136 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { NetRevenueOverTime } from '../models/NetRevenueOverTime';
+import type { Order } from '../models/Order';
+import type { Product } from '../models/Product';
+import type { RevenueByProduct } from '../models/RevenueByProduct';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+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(
+        org: string,
+    ): CancelablePromise<Product> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/finance/orgs/{org}/products',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * 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(
+        itemId: string,
+        org: string,
+        endDate?: string,
+        startDate?: string,
+    ): CancelablePromise<Order> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/finance/orgs/{org}/products/{item_id}/orders',
+            path: {
+                'item_id': itemId,
+                'org': org,
+            },
+            query: {
+                'end_date': endDate,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * 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(
+        itemId: string,
+        org: string,
+        endDate?: string,
+        startDate?: string,
+    ): CancelablePromise<NetRevenueOverTime> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/finance/orgs/{org}/products/{item_id}/sales-over-time',
+            path: {
+                'item_id': itemId,
+                'org': org,
+            },
+            query: {
+                'end_date': endDate,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * 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(
+        org: string,
+        endDate?: string,
+        startDate?: string,
+    ): CancelablePromise<NetRevenueOverTime> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/finance/orgs/{org}/revenue/net-over-time',
+            path: {
+                'org': org,
+            },
+            query: {
+                'end_date': endDate,
+                'start_date': startDate,
+            },
+        });
+    }
+    /**
+     * 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(
+        org: string,
+        endDate?: string,
+        startDate?: string,
+    ): CancelablePromise<RevenueByProduct> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/finance/orgs/{org}/revenue/products',
+            path: {
+                'org': org,
+            },
+            query: {
+                'end_date': endDate,
+                'start_date': startDate,
+            },
+        });
+    }
+}

package/src/services/MediaResourcesService.ts

@@ -0,0 +1,319 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { MediaResource } from '../models/MediaResource';
+import type { PatchedMediaResource } from '../models/PatchedMediaResource';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+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(
+        org: string,
+        userId: string,
+        courseId?: string,
+        itemId?: string,
+        page?: number,
+        pageSize?: number,
+        search?: string,
+        unitId?: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'course_id': courseId,
+                'item_id': itemId,
+                'page': page,
+                'page_size': pageSize,
+                'search': search,
+                'unit_id': unitId,
+            },
+        });
+    }
+    /**
+     * 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(
+        org: string,
+        userId: string,
+        requestBody: MediaResource,
+        courseId?: string,
+        itemId?: string,
+        search?: string,
+        unitId?: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'course_id': courseId,
+                'item_id': itemId,
+                'search': search,
+                'unit_id': unitId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * 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(
+        id: number,
+        org: string,
+        userId: string,
+        courseId?: string,
+        itemId?: string,
+        search?: string,
+        unitId?: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/{id}/',
+            path: {
+                'id': id,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'course_id': courseId,
+                'item_id': itemId,
+                'search': search,
+                'unit_id': unitId,
+            },
+        });
+    }
+    /**
+     * 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(
+        id: number,
+        org: string,
+        userId: string,
+        requestBody: MediaResource,
+        courseId?: string,
+        itemId?: string,
+        search?: string,
+        unitId?: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/{id}/',
+            path: {
+                'id': id,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'course_id': courseId,
+                'item_id': itemId,
+                'search': search,
+                'unit_id': unitId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * 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(
+        id: number,
+        org: string,
+        userId: string,
+        courseId?: string,
+        itemId?: string,
+        search?: string,
+        unitId?: string,
+        requestBody?: PatchedMediaResource,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/{id}/',
+            path: {
+                'id': id,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'course_id': courseId,
+                'item_id': itemId,
+                'search': search,
+                'unit_id': unitId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * 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(
+        id: number,
+        org: string,
+        userId: string,
+        courseId?: string,
+        itemId?: string,
+        search?: string,
+        unitId?: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/{id}/',
+            path: {
+                'id': id,
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'course_id': courseId,
+                'item_id': itemId,
+                'search': search,
+                'unit_id': unitId,
+            },
+        });
+    }
+    /**
+     * 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(
+        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> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/by_item/',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'course_id': courseId,
+                'item_id': itemId,
+                'item_type': itemType,
+                'search': search,
+                'unit_id': unitId,
+            },
+        });
+    }
+    /**
+     * 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(
+        org: string,
+        q: string,
+        userId: string,
+        courseId?: string,
+        itemId?: string,
+        search?: string,
+        unitId?: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/media/orgs/{org}/users/{user_id}/media/media-resources/search/',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            query: {
+                'course_id': courseId,
+                'item_id': itemId,
+                'q': q,
+                'search': search,
+                'unit_id': unitId,
+            },
+        });
+    }
+}