@iblai/iblai-api 3.35.3-core → 3.35.4-core

package/dist/types/models/{StatusEnum.d.ts → NotificationStatusEnum.d.ts}

@@ -3,7 +3,7 @@
  * * `UNREAD` - Unread
  * * `CANCELLED` - Cancelled
  */
-export declare enum StatusEnum {
+export declare enum NotificationStatusEnum {
     READ = "READ",
     UNREAD = "UNREAD",
     CANCELLED = "CANCELLED"

package/dist/types/models/OnboardingStatusUpdate.d.ts

@@ -0,0 +1,7 @@
+export type OnboardingStatusUpdate = {
+    onboarding_completed: boolean;
+    /**
+     * The app url or name or id
+     */
+    app: string;
+};

package/dist/types/models/PaginatedUserAppList.d.ts

@@ -0,0 +1,7 @@
+import type { UserApp } from './UserApp';
+export type PaginatedUserAppList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<UserApp>;
+};

package/dist/types/models/PatchedMediaResource.d.ts

@@ -0,0 +1,71 @@
+import type { ItemTypeEnum } from './ItemTypeEnum';
+import type { MediaTypeEnum } from './MediaTypeEnum';
+export type PatchedMediaResource = {
+    readonly id?: number;
+    /**
+     * Title of the media resource
+     */
+    title?: string;
+    /**
+     * Description of the media resource
+     */
+    description?: string | null;
+    /**
+     * Type of media
+     *
+     * * `video` - Video
+     * * `image` - Image
+     * * `document` - Document
+     * * `audio` - Audio
+     * * `other` - Other
+     */
+    media_type?: MediaTypeEnum;
+    /**
+     * Type of item this media is associated with
+     *
+     * * `course` - Course
+     * * `unit` - Unit
+     * * `resource` - Resource
+     * * `course_unit` - Course and Unit
+     * * `course_resource` - Course and Resource
+     * * `unit_resource` - Unit and Resource
+     * * `all` - Course, Unit, and Resource
+     */
+    readonly item_type?: ItemTypeEnum;
+    /**
+     * ID of the associated course
+     */
+    course_id?: string | null;
+    /**
+     * ID of the associated unit
+     */
+    unit_id?: string | null;
+    /**
+     * ID of the associated item (resource)
+     */
+    item_id?: string | null;
+    /**
+     * The platform this media resource belongs to
+     */
+    readonly platform?: number;
+    /**
+     * External URL for the media resource
+     */
+    file_url?: string | null;
+    /**
+     * Uploaded media file
+     */
+    file?: string | null;
+    /**
+     * User who created this media resource
+     */
+    readonly created_by?: number | null;
+    /**
+     * When this record was created
+     */
+    readonly created_at?: string;
+    /**
+     * When this record was last updated
+     */
+    readonly updated_at?: string;
+};

package/dist/types/models/PatchedNotification.d.ts

@@ -1,11 +1,11 @@
 import type { BlankEnum } from './BlankEnum';
-import type { StatusEnum } from './StatusEnum';
+import type { NotificationStatusEnum } from './NotificationStatusEnum';
 export type PatchedNotification = {
     readonly id?: string;
     username?: string;
     readonly title?: string;
     readonly body?: string;
-    status?: (StatusEnum | BlankEnum);
+    status?: (NotificationStatusEnum | BlankEnum);
     readonly channel?: string | null;
     context?: any;
     readonly short_message?: string;

package/dist/types/models/Platform.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Note: Create and update operations deprecated.
+ */
+export type Platform = {
+    /**
+     * The platform key
+     */
+    key: string;
+    /**
+     * The name of the platform
+     */
+    name?: string | null;
+    /**
+     * The associated edX org code
+     */
+    org?: string | null;
+    /**
+     * The LMS URL for the platform
+     */
+    lms_url?: string | null;
+    /**
+     * The CMS URL for the platform
+     */
+    cms_url?: string | null;
+    /**
+     * The portal URL for the platform
+     */
+    portal_url?: string | null;
+};

package/dist/types/models/PlatformApiKey.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Serializer for PlatformApiKey's
+ */
+export type PlatformApiKey = {
+    /**
+     * Username that created token
+     */
+    readonly username: string;
+    /**
+     * Name of the token. Used by the user to identify the token.
+     */
+    name: string;
+    readonly key: string;
+    /**
+     * The platform key
+     */
+    platform_key: string;
+    /**
+     * When token expires
+     */
+    readonly expires: string;
+    /**
+     * Optional duration until key expires. Format: [DD] [HH:[MM:]]ss[.uuuuuu]
+     */
+    expires_in?: string | null;
+    /**
+     * When token was created
+     */
+    readonly created: string;
+};

package/dist/types/models/PlatformList.d.ts

@@ -0,0 +1,29 @@
+import type { PlatformListStatusEnum } from './PlatformListStatusEnum';
+export type PlatformList = {
+    /**
+     * The platform key
+     */
+    key: string;
+    /**
+     * The name of the platform
+     */
+    name?: string | null;
+    /**
+     * The associated edX org code
+     */
+    org?: string | null;
+    /**
+     * The LMS URL for the platform
+     */
+    lms_url?: string | null;
+    /**
+     * The CMS URL for the platform
+     */
+    cms_url?: string | null;
+    /**
+     * The portal URL for the platform
+     */
+    portal_url?: string | null;
+    status?: PlatformListStatusEnum;
+    active?: boolean;
+};

package/dist/types/models/PlatformListStatusEnum.d.ts

@@ -0,0 +1,22 @@
+/**
+ * * `-2` - FAILED
+ * * `-1` - TERMINATED
+ * * `0` - PENDING
+ * * `1` - BUILDING
+ * * `2` - RUNNING
+ * * `3` - PAUSED
+ * * `4` - STOPPING
+ * * `5` - STOPPED
+ * * `6` - REPAIR
+ */
+export declare enum PlatformListStatusEnum {
+    '_-2' = -2,
+    '_-1' = -1,
+    '_0' = 0,
+    '_1' = 1,
+    '_2' = 2,
+    '_3' = 3,
+    '_4' = 4,
+    '_5' = 5,
+    '_6' = 6
+}

package/dist/types/models/PlatformUpdatePostRequest.d.ts

@@ -0,0 +1,9 @@
+export type PlatformUpdatePostRequest = {
+    user_id: number;
+    key: string;
+    new_key?: string;
+    name?: string;
+    lms_url?: string;
+    cms_url?: string;
+    portal_url?: string;
+};

package/dist/types/models/ReportedRole.d.ts

@@ -0,0 +1,4 @@
+import type { Role } from './Role';
+export type ReportedRole = {
+    roles: Array<Role>;
+};

package/dist/types/models/Resource.d.ts

@@ -0,0 +1,22 @@
+export type Resource = {
+    item_id?: string;
+    readonly id: number;
+    /**
+     * The display name of the resource.
+     */
+    readonly name: string | null;
+    /**
+     * Resource URL.
+     */
+    readonly url: string | null;
+    /**
+     * Resource type.
+     */
+    readonly resource_type: string | null;
+    /**
+     * Metadata
+     */
+    readonly data: any;
+    image?: string | null;
+    description?: string | null;
+};

package/dist/types/models/ResourceCreateUpdate.d.ts

@@ -0,0 +1,42 @@
+export type ResourceCreateUpdate = {
+    /**
+     * Resource ID for updates
+     */
+    id?: number;
+    /**
+     * User ID of the resource owner
+     */
+    user_id?: number;
+    /**
+     * Username of the resource owner
+     */
+    username?: string;
+    /**
+     * Type of resource (e.g., video, document)
+     */
+    resource_type: string;
+    /**
+     * URL of the resource
+     */
+    url: string;
+    /**
+     * Name of the resource
+     */
+    name: string;
+    /**
+     * Description of the resource
+     */
+    description?: string;
+    /**
+     * List of skill names associated with the resource
+     */
+    skills?: Array<string>;
+    /**
+     * Image file
+     */
+    image?: string;
+    /**
+     * Additional metadata for the resource
+     */
+    data?: any;
+};

package/dist/types/models/Role.d.ts

@@ -0,0 +1,7 @@
+export type Role = {
+    readonly id: number;
+    /**
+     * The display name of the role.
+     */
+    name?: string | null;
+};

package/dist/types/models/StripeCheckoutSessionRequest.d.ts

@@ -0,0 +1,54 @@
+import type { ModeEnum } from './ModeEnum';
+/**
+ * Serializer for Stripe checkout session creation requests.
+ */
+export type StripeCheckoutSessionRequest = {
+    /**
+     * Product SKU
+     */
+    sku?: string;
+    /**
+     * Alternative to SKU
+     */
+    product?: string;
+    /**
+     * URL to redirect after successful payment
+     */
+    success_url: string;
+    /**
+     * URL to redirect if checkout cancelled
+     */
+    cancel_url: string;
+    /**
+     * Checkout mode
+     *
+     * * `subscription` - subscription
+     * * `payment` - payment
+     * * `setup` - setup
+     */
+    mode?: ModeEnum;
+    /**
+     * Whether to use metered billing
+     */
+    metered?: boolean;
+    /**
+     * Subscription quantity
+     */
+    quantity?: number;
+    /**
+     * Coupon code to apply
+     */
+    coupon?: string;
+    /**
+     * Enable free trial
+     */
+    is_free_trial?: boolean;
+    /**
+     * Trial period in days
+     */
+    trial_days?: number;
+    /**
+     * Skip card collection for trial
+     */
+    skip_card?: boolean;
+};

package/dist/types/models/StripeCheckoutSessionResponse.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Stripe checkout session serialized response
+ */
+export type StripeCheckoutSessionResponse = {
+    redirect_to: string;
+};

package/dist/types/models/StripeCustomerPortalRequest.d.ts

@@ -0,0 +1,3 @@
+export type StripeCustomerPortalRequest = {
+    return_url: string;
+};

package/dist/types/models/StripeCustomerPortalResponse.d.ts

@@ -0,0 +1,3 @@
+export type StripeCustomerPortalResponse = {
+    url: string;
+};

package/dist/types/models/StripeLocalProduct.d.ts

@@ -0,0 +1,8 @@
+export type StripeLocalProduct = {
+    name: string;
+    description?: string | null;
+    readonly price: string;
+    stripe_product_id?: string | null;
+    sku: string;
+    readonly platform: string;
+};

package/dist/types/models/StripeSubscriptionRenewalRequest.d.ts

@@ -0,0 +1,4 @@
+export type StripeSubscriptionRenewalRequest = {
+    checkout_session_uuid: string;
+    return_url: string;
+};

package/dist/types/models/StripeSubscriptionRenewalResponse.d.ts

@@ -0,0 +1,3 @@
+export type StripeSubscriptionRenewalResponse = {
+    subscription_id: string;
+};

package/dist/types/models/TenantLaunchError.d.ts

@@ -0,0 +1,10 @@
+/**
+ * An unexpected error occurred during launch process
+ */
+export type TenantLaunchError = {
+    success?: boolean;
+    message: any;
+    data?: any;
+    id?: string;
+    timestamp?: string;
+};

package/dist/types/models/TenantLaunchFailed.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Launch process started but could not complete
+ */
+export type TenantLaunchFailed = {
+    success?: boolean;
+    message: any;
+    data?: any;
+    id?: string;
+    timestamp?: string;
+    org: string;
+    lms_url: string;
+    cms_url: string;
+    portal_url: string;
+    edx_role: string;
+};

package/dist/types/models/TenantLaunchRequest.d.ts

@@ -0,0 +1,16 @@
+export type TenantLaunchRequest = {
+    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;
+};

package/dist/types/models/TenantLaunchResponse.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Launch process completed successfully
+ */
+export type TenantLaunchResponse = {
+    success?: boolean;
+    message: any;
+    data?: any;
+    id?: string;
+    timestamp?: string;
+    org: string;
+    lms_url: string;
+    cms_url: string;
+    portal_url: string;
+    edx_role: string;
+};

package/dist/types/models/TokenProxyInput.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Serializer for TokenProxyView POST request input data
+ */
+export type TokenProxyInput = {
+    /**
+     * Edx User ID
+     */
+    user_id?: number;
+    /**
+     * Edx Username
+     */
+    username?: string;
+    /**
+     * Edx Email
+     */
+    email?: string;
+    /**
+     * Platform key axd token should belong to
+     */
+    platform_key: string;
+};

package/dist/types/models/TokenProxyOutput.d.ts

@@ -0,0 +1,7 @@
+import type { TokenProxyOutputSerializerData } from './TokenProxyOutputSerializerData';
+/**
+ * The SPA expects this outer data key so we need to create an extra layer
+ */
+export type TokenProxyOutput = {
+    data: TokenProxyOutputSerializerData;
+};

package/dist/types/models/TokenProxyOutputSerializerData.d.ts

@@ -0,0 +1,20 @@
+import type { AuthToken } from './AuthToken';
+import type { ManagerAuthToken } from './ManagerAuthToken';
+import type { TokenProxyUser } from './TokenProxyUser';
+/**
+ * Core data for Response
+ */
+export type TokenProxyOutputSerializerData = {
+    /**
+     * User details
+     */
+    user: TokenProxyUser;
+    /**
+     * Axd Token details
+     */
+    axd_token: AuthToken;
+    /**
+     * DM Token details
+     */
+    dm_token: ManagerAuthToken;
+};

package/dist/types/models/TokenProxyUser.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Serializer for User model for TokenProxyOutputSerializerData
+ */
+export type TokenProxyUser = {
+    /**
+     * Edx User ID
+     */
+    user_id: number;
+    /**
+     * User's Edx Email
+     */
+    user_email: string;
+    /**
+     * Username
+     */
+    user_nicename: string;
+    /**
+     * User's display name
+     */
+    user_display_name: string;
+    /**
+     * Edx Full Name
+     */
+    readonly user_fullname: string;
+};

package/dist/types/models/UserApp.d.ts

@@ -0,0 +1,27 @@
+import type { App } from './App';
+import type { Platform } from './Platform';
+export type UserApp = {
+    readonly id: number;
+    /**
+     * The app details
+     */
+    app: App;
+    /**
+     * The platform details
+     */
+    readonly platform: Platform;
+    /**
+     * The subscription details, would contain identifier, active, created_on, last_updated
+     */
+    readonly subscription: Record<string, any> | null;
+    provider: string;
+    readonly is_admin: boolean;
+    readonly is_active: boolean;
+    metadata?: any;
+    onboarding_completed?: boolean;
+    free_trial_started?: boolean;
+    free_trial_expired?: boolean;
+    has_active_subscription?: boolean;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

package/dist/types/models/UserDeleteAPIError.d.ts

@@ -0,0 +1,3 @@
+export type UserDeleteAPIError = {
+    error: string;
+};

package/dist/types/models/UserDeleteAPIRequest.d.ts

@@ -0,0 +1,3 @@
+export type UserDeleteAPIRequest = {
+    username?: string;
+};

package/dist/types/models/UserDeleteAPIResponse.d.ts

@@ -0,0 +1,3 @@
+export type UserDeleteAPIResponse = {
+    message: string;
+};

package/dist/types/models/UserPlatformLink.d.ts

@@ -0,0 +1,17 @@
+export type UserPlatformLink = {
+    user_id: number;
+    username: string;
+    email: string;
+    user_active: boolean;
+    key: string;
+    org: string;
+    lms_url: string;
+    cms_url: string;
+    portal_url: string;
+    is_admin?: boolean;
+    is_staff?: boolean;
+    added_on?: string | null;
+    expired_on?: string | null;
+    readonly public: string;
+    active?: boolean;
+};

package/dist/types/models/UserPlatformManagementListViewGetResponse.d.ts

@@ -0,0 +1,6 @@
+export type UserPlatformManagementListViewGetResponse = {
+    count: number;
+    next_page: number;
+    previous_page: number;
+    results: Array<Record<string, any>>;
+};

package/dist/types/models/UserPlatformViewPostRequest.d.ts

@@ -0,0 +1,8 @@
+export type UserPlatformViewPostRequest = {
+    user_id: number;
+    platform_key: string;
+    added_on?: string;
+    expired_on?: string;
+    is_admin?: boolean;
+    active?: boolean;
+};

package/dist/types/models/UserProxyBulkRequest.d.ts

@@ -0,0 +1,3 @@
+export type UserProxyBulkRequest = {
+    users: Array<Record<string, string>>;
+};

package/dist/types/models/UserProxyGetResponse.d.ts

@@ -0,0 +1,8 @@
+export type UserProxyGetResponse = {
+    user_id: number;
+    username: string;
+    email: string;
+    active: boolean;
+    edx_data: any;
+    data: any;
+};

package/dist/types/models/UserProxyPostRequest.d.ts

@@ -0,0 +1,7 @@
+export type UserProxyPostRequest = {
+    user_id: number;
+    username: string;
+    email: string;
+    edx_data: any;
+    data: any;
+};

package/dist/types/models/UserProxyPostResponse.d.ts

@@ -0,0 +1,8 @@
+export type UserProxyPostResponse = {
+    user_id: number;
+    username: string;
+    email: string;
+    active: boolean;
+    edx_data: any;
+    data: any;
+};

package/dist/types/models/UserSearchViewGetResponse.d.ts

@@ -0,0 +1,6 @@
+export type UserSearchViewGetResponse = {
+    count: number;
+    next_page: number;
+    previous_page: number;
+    results: Array<Record<string, any>>;
+};