@iblai/iblai-api 0.0.2-core → 0.0.12-scan-core

package/src/models/ProgramMetadataResponse.ts

@@ -0,0 +1,34 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Response serializer for ProgramMetadataView GET endpoint.
+ */
+export type ProgramMetadataResponse = {
+    /**
+     * Program name
+     */
+    name?: string | null;
+    /**
+     * Program description
+     */
+    description?: string | null;
+    /**
+     * Whether the program is enabled
+     */
+    enabled?: boolean | null;
+    /**
+     * Program slug
+     */
+    slug?: string | null;
+    /**
+     * List of associated skills
+     */
+    skills?: Array<string>;
+    /**
+     * Platform key
+     */
+    platform_key?: string | null;
+};
+

package/src/models/ProgramReview.ts

@@ -0,0 +1,46 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for program review data.
+ */
+export type ProgramReview = {
+    /**
+     * The user identifier
+     */
+    user_id: number;
+    /**
+     * The username of the reviewer
+     */
+    username: string;
+    /**
+     * Review content/text
+     */
+    content: string;
+    /**
+     * Rating value (typically 1-5)
+     */
+    rating: number | null;
+    /**
+     * Review title
+     */
+    title: string;
+    /**
+     * Whether the review is visible
+     */
+    visible: boolean;
+    /**
+     * Date when review was created
+     */
+    created: string | null;
+    /**
+     * Date when review was last modified
+     */
+    modified: string | null;
+    /**
+     * The program key identifier
+     */
+    program_key: string;
+};
+

package/src/models/ProgramReviewPaginatedResponse.ts

@@ -0,0 +1,27 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ProgramReview } from './ProgramReview';
+/**
+ * Paginated response serializer for ProgramReviewQueryView GET endpoint.
+ */
+export type ProgramReviewPaginatedResponse = {
+    /**
+     * Total number of reviews
+     */
+    count: number;
+    /**
+     * Next page number
+     */
+    next_page: number | null;
+    /**
+     * Previous page number
+     */
+    previous_page: number | null;
+    /**
+     * List of program reviews
+     */
+    results: Array<ProgramReview>;
+};
+

package/src/models/ProgramReviewRequest.ts

@@ -0,0 +1,42 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Request serializer for ProgramReviewUpdateView POST endpoint.
+ */
+export type ProgramReviewRequest = {
+    /**
+     * The program key to review (format: program-v1:org+program_id)
+     */
+    program_key: string;
+    /**
+     * The username of the reviewer
+     */
+    username: string;
+    /**
+     * The user ID of the reviewer (alternative to username)
+     */
+    user_id?: number;
+    /**
+     * The rating value (typically 1-5)
+     */
+    rating?: number | null;
+    /**
+     * The review title
+     */
+    title?: string;
+    /**
+     * The review content/text
+     */
+    content?: string;
+    /**
+     * Whether the review is visible
+     */
+    visible?: boolean;
+    /**
+     * Additional review metadata
+     */
+    metadata?: any;
+};
+

package/src/models/RbacBaseRole.ts

@@ -0,0 +1,20 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for roles.
+ */
+export type RbacBaseRole = {
+    readonly id: number;
+    name: string;
+    /**
+     * Platform key where this role belongs
+     */
+    platform_key: string;
+    /**
+     * List of actions/permissions this role can perform (e.g., ['Ibl.Mentor/Settings/read', 'Ibl.Mentor/Settings/write'])
+     */
+    actions: Array<string>;
+};
+

package/src/models/RbacGroup.ts

@@ -0,0 +1,39 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { RbacPlatform } from './RbacPlatform';
+import type { RbacUser } from './RbacUser';
+/**
+ * Serializer for RBAC groups.
+ */
+export type RbacGroup = {
+    readonly id: number;
+    /**
+     * The unique identifier for the group
+     */
+    unique_id: string;
+    readonly platform: RbacPlatform;
+    /**
+     * The platform key
+     */
+    platform_key: string;
+    /**
+     * Optional name of the group
+     */
+    name?: string;
+    /**
+     * Optional group description
+     */
+    description?: string;
+    readonly users: Array<RbacUser>;
+    /**
+     * List of user IDs to add to this group
+     */
+    users_to_add?: Array<number>;
+    /**
+     * List of user IDs to remove from this group
+     */
+    users_to_remove?: Array<number>;
+};
+

package/src/models/RbacPlatform.ts

@@ -0,0 +1,19 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for platforms.
+ */
+export type RbacPlatform = {
+    readonly id: number;
+    /**
+     * The platform key
+     */
+    key: string;
+    /**
+     * The name of the platform
+     */
+    name?: string | null;
+};
+

package/src/models/RbacPolicy.ts

@@ -0,0 +1,53 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { RbacBaseRole } from './RbacBaseRole';
+import type { RbacPlatform } from './RbacPlatform';
+import type { RbacPolicyGroup } from './RbacPolicyGroup';
+import type { RbacUser } from './RbacUser';
+/**
+ * Serializer for policies.
+ */
+export type RbacPolicy = {
+    readonly id: number;
+    /**
+     * Role information (read-only)
+     */
+    readonly role: RbacBaseRole;
+    /**
+     * Platform information (read-only)
+     */
+    readonly platform: RbacPlatform;
+    /**
+     * List of resource paths this policy grants access to (e.g., ['/platforms/1/mentors', '/platforms/1/mentors/settings'])
+     */
+    resources: Array<string>;
+    readonly users: Array<RbacUser>;
+    readonly groups: Array<RbacPolicyGroup>;
+    /**
+     * ID of the role this policy applies to
+     */
+    role_id: number;
+    /**
+     * Platform key where this policy applies
+     */
+    platform_key: string;
+    /**
+     * List of user IDs to add to this Policy
+     */
+    users_to_add?: Array<number>;
+    /**
+     * List of user IDs to remove from this Policy
+     */
+    users_to_remove?: Array<number>;
+    /**
+     * List of group IDs to add to this Policy
+     */
+    groups_to_add?: Array<number>;
+    /**
+     * List of group IDs to remove from this Policy
+     */
+    groups_to_remove?: Array<number>;
+};
+

package/src/models/RbacPolicyGroup.ts

@@ -0,0 +1,25 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for RBAC groups when returned in a policy.
+ *
+ * We are limiting the returne data since we don't need everything there
+ */
+export type RbacPolicyGroup = {
+    readonly id: number;
+    /**
+     * Optional name of the group
+     */
+    name?: string;
+    /**
+     * The unique identifier for the group
+     */
+    unique_id: string;
+    /**
+     * Optional group description
+     */
+    description?: string;
+};
+

package/src/models/RbacRole.ts

@@ -0,0 +1,25 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { RbacPlatform } from './RbacPlatform';
+/**
+ * Serializer for roles.
+ */
+export type RbacRole = {
+    readonly id: number;
+    name: string;
+    /**
+     * Platform information (read-only)
+     */
+    readonly platform: RbacPlatform;
+    /**
+     * Platform key where this role belongs
+     */
+    platform_key: string;
+    /**
+     * List of actions/permissions this role can perform (e.g., ['Ibl.Mentor/Settings/read', 'Ibl.Mentor/Settings/write'])
+     */
+    actions: Array<string>;
+};
+

package/src/models/RbacUser.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for users.
+ */
+export type RbacUser = {
+    /**
+     * edX user ID
+     */
+    readonly id: number;
+    /**
+     * edX username
+     */
+    username?: string | null;
+};
+

package/src/models/StripeBillingPageIdentifierResponse.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type StripeBillingPageIdentifierResponse = {
+    publishable_key: string;
+    pricing_table_id: string;
+    pricing_table_js: any;
+    payment_link_id: string;
+    payment_link_url: string;
+    customer_email: string;
+    client_reference_id: string;
+};
+

package/src/models/StripeContext.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type StripeContext = {
+    publishable_key: string;
+    pricing_table_id: string;
+    pricing_table_js: any;
+    payment_link_id: string;
+    payment_link_url: string;
+};
+

package/src/models/StripeNewUserTenantLaunchRequest.ts

@@ -0,0 +1,25 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type StripeNewUserTenantLaunchRequest = {
+    username?: string;
+    email?: string;
+    firstname?: string;
+    lastname?: string;
+    password?: string;
+    /**
+     * Organization name
+     */
+    name: string;
+    /**
+     * Unique key for the organization
+     */
+    key: string;
+    ignore_user_exists?: boolean;
+    /**
+     * Stripe Checkout Id to launch the tenant
+     */
+    stripe_checkout_id_alt: string;
+};
+

package/src/models/UserApp.ts

@@ -26,7 +26,5 @@ export type UserApp = {
     free_trial_started?: boolean;
     free_trial_expired?: boolean;
     has_active_subscription?: boolean;
-    readonly created_at: string;
-    readonly updated_at: string;
 };
 

package/src/models/UserLicenseAssignmentDetail.ts

@@ -33,7 +33,7 @@ export type UserLicenseAssignmentDetail = {
     /**
      * URL to redirect to after fulfillment
      */
-    redirect_to: string | null;
+    redirect_to?: string | null;
     /**
      * Additional metadata for the assignment
      */

package/src/models/UserLicenseDetail.ts

@@ -50,9 +50,13 @@ export type UserLicenseDetail = {
      * The platform key associated with the license
      */
     platform_key: string;
+    /**
+     * Number of assignments using this license
+     */
+    usage_count?: number;
     /**
      * Assignment counts by status (only included in verbose mode)
      */
-    assignments?: Record<string, number>;
+    assignments?: any;
 };
 

package/src/models/UserLicenseGroupAssignmentDetail.ts

@@ -25,11 +25,11 @@ export type UserLicenseGroupAssignmentDetail = {
     /**
      * Whether the assignment has been fulfilled
      */
-    fulfilled: boolean;
+    fulfilled?: boolean;
     /**
      * URL to redirect to after fulfillment
      */
-    redirect_to: string | null;
+    redirect_to?: string | null;
     /**
      * Additional metadata for the assignment
      */

package/src/services/AnalyticsService.ts

@@ -32,15 +32,16 @@ export class AnalyticsService {
          *
          * Notes:
          * This API must be enabled via the ENABLE_TIME_SPENT_UPDATE_API setting.
-         * @param org
-         * @param requestBody
          * @returns TimeSpentUpdateResponse
          * @throws ApiError
          */
-        public static analyticsOrgsTimeUpdateCreate(
+        public static analyticsOrgsTimeUpdateCreate({
+            org,
+            requestBody,
+        }: {
             org: string,
             requestBody: TimeSpentUpdateRequest,
-        ): CancelablePromise<TimeSpentUpdateResponse> {
+        }): CancelablePromise<TimeSpentUpdateResponse> {
             return __request(OpenAPI, {
                 method: 'POST',
                 url: '/api/analytics/orgs/{org}/time/update/',
@@ -57,29 +58,57 @@ export class AnalyticsService {
          * Returns the total time spent (in seconds) for the current authenticated user.
          * Can be filtered by platform, date range, course ID, URL, mentor UUID, and session UUID.
          *
-         * @param courseId Course ID to filter by (can be partial)
-         * @param endDate End date for time range (YYYY-MM-DD)
-         * @param includeMainPlatform Whether to include main platform data
-         * @param learnerId Username to get data for (admin users only)
-         * @param mentorUuid Mentor UUID to filter by
-         * @param platform Platform name or key to filter by
-         * @param sessionUuid Session UUID to filter by
-         * @param startDate Start date for time range (YYYY-MM-DD)
-         * @param url URL to filter by (can be partial)
          * @returns TimeSpentPerUserResponse
          * @throws ApiError
          */
-        public static analyticsTimeSpentUserRetrieve(
+        public static analyticsTimeSpentUserRetrieve({
+            courseId,
+            endDate,
+            includeMainPlatform = true,
+            learnerId,
+            mentorUuid,
+            platform,
+            sessionUuid,
+            startDate,
+            url,
+        }: {
+            /**
+             * Course ID to filter by (can be partial)
+             */
             courseId?: string,
+            /**
+             * End date for time range (YYYY-MM-DD)
+             */
             endDate?: string,
-            includeMainPlatform: boolean = true,
+            /**
+             * Whether to include main platform data
+             */
+            includeMainPlatform?: boolean,
+            /**
+             * Username to get data for (admin users only)
+             */
             learnerId?: string,
+            /**
+             * Mentor UUID to filter by
+             */
             mentorUuid?: string,
+            /**
+             * Platform name or key to filter by
+             */
             platform?: string | null,
+            /**
+             * Session UUID to filter by
+             */
             sessionUuid?: string,
+            /**
+             * Start date for time range (YYYY-MM-DD)
+             */
             startDate?: string,
+            /**
+             * URL to filter by (can be partial)
+             */
             url?: string,
-        ): CancelablePromise<TimeSpentPerUserResponse> {
+        }): CancelablePromise<TimeSpentPerUserResponse> {
             return __request(OpenAPI, {
                 method: 'GET',
                 url: '/api/analytics/time-spent/user/',