@iblai/iblai-api 0.0.1-core

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

@@ -0,0 +1,112 @@
+import type { MediaResource } from '../models/MediaResource';
+import type { PatchedMediaResource } from '../models/PatchedMediaResource';
+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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+}

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

@@ -0,0 +1,58 @@
+import type { ContextResponse } from '../models/ContextResponse';
+import type { NotificationPreview } from '../models/NotificationPreview';
+import type { NotificationSource } from '../models/NotificationSource';
+import type { PreviewResponse } from '../models/PreviewResponse';
+import type { Recipient } from '../models/Recipient';
+import type { SendNotification } from '../models/SendNotification';
+import type { SendResponse } from '../models/SendResponse';
+import type { ValidateSourceResponse } from '../models/ValidateSourceResponse';
+import type { CancelablePromise } from '../core/CancelablePromise';
+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>>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+}

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

@@ -0,0 +1,128 @@
+import type { CampaignEnablement } from '../models/CampaignEnablement';
+import type { CampaignExclusion } from '../models/CampaignExclusion';
+import type { MarkAllReadRequest } from '../models/MarkAllReadRequest';
+import type { MarkAllReadResponse } from '../models/MarkAllReadResponse';
+import type { Notification } from '../models/Notification';
+import type { NotificationCount } from '../models/NotificationCount';
+import type { PatchedNotification } from '../models/PatchedNotification';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class NotificationService {
+    /**
+     * Unsubscribe from a campaign using a hash
+     * @param unsubscribeHash
+     * @returns any
+     * @throws ApiError
+     */
+    static notificationV1CampaignsUnsubscribeRetrieve(unsubscribeHash: string): CancelablePromise<{
+        success?: boolean;
+        message?: string;
+    }>;
+    /**
+     * Get notifications for a user
+     * @param org
+     * @param channel
+     * @param endDate
+     * @param excludeChannel
+     * @param startDate
+     * @param status
+     * @returns Notification
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationsRetrieve(org: string, channel?: string, endDate?: string, excludeChannel?: string, startDate?: string, status?: string): CancelablePromise<Notification>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @param requestBody
+     * @returns Notification
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationsUpdate(org: string, requestBody: Notification): CancelablePromise<Notification>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @param requestBody
+     * @returns Notification
+     * @throws ApiError
+     */
+    static notificationV1OrgsNotificationsBulkUpdatePartialUpdate(org: string, requestBody?: PatchedNotification): CancelablePromise<Notification>;
+    /**
+     * Get notifications for a user
+     * @param org
+     * @param userId
+     * @param channel
+     * @param endDate
+     * @param excludeChannel
+     * @param startDate
+     * @param status
+     * @returns Notification
+     * @throws ApiError
+     */
+    static notificationV1OrgsUsersNotificationsRetrieve(org: string, userId: string, channel?: string, endDate?: string, excludeChannel?: string, startDate?: string, status?: string): CancelablePromise<Notification>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns Notification
+     * @throws ApiError
+     */
+    static notificationV1OrgsUsersNotificationsUpdate(org: string, userId: string, requestBody: Notification): CancelablePromise<Notification>;
+    /**
+     * Get notifications count for a user
+     * @param org
+     * @param userId
+     * @param channel
+     * @param status
+     * @returns NotificationCount
+     * @throws ApiError
+     */
+    static notificationV1OrgsUsersNotificationsCountRetrieve(org: string, userId: string, channel?: string, status?: string): CancelablePromise<NotificationCount>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param notificationId
+     * @param org
+     * @param userId
+     * @returns void
+     * @throws ApiError
+     */
+    static notificationV1OrgsUsersNotificationsDestroy(notificationId: string, org: string, userId: string): CancelablePromise<void>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns Notification
+     * @throws ApiError
+     */
+    static notificationV1OrgsUsersNotificationsBulkUpdatePartialUpdate(org: string, userId: string, requestBody?: PatchedNotification): CancelablePromise<Notification>;
+    /**
+     * Re-enable campaigns for a user
+     * @param platformKey
+     * @param requestBody
+     * @returns any
+     * @throws ApiError
+     */
+    static notificationV1OrgsCampaignsEnableCreate(platformKey: string, requestBody?: CampaignEnablement): CancelablePromise<{
+        success?: boolean;
+        message?: string;
+    }>;
+    /**
+     * Exclude a user from specified campaigns
+     * @param platformKey
+     * @param requestBody
+     * @returns any
+     * @throws ApiError
+     */
+    static notificationV1OrgsCampaignsExcludeCreate(platformKey: string, requestBody?: CampaignExclusion): CancelablePromise<{
+        success?: boolean;
+        message?: string;
+    }>;
+    /**
+     * Mark all notifications as read for a user. Optionally provide specific notification IDs.
+     * @param platformKey
+     * @param requestBody
+     * @returns MarkAllReadResponse
+     * @throws ApiError
+     */
+    static notificationV1OrgsMarkAllAsReadCreate(platformKey: string, requestBody?: MarkAllReadRequest): CancelablePromise<MarkAllReadResponse>;
+}

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

@@ -0,0 +1,262 @@
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class OrgsService {
+    /**
+     * GET /scim/v2/DepartmentMembers
+     * List all department members in the system.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2DepartmentMembersRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * POST /scim/v2/DepartmentMembers
+     * Create or update a department member using core logic. SCIM format.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2DepartmentMembersCreate(org: string): CancelablePromise<any>;
+    /**
+     * GET /scim/v2/DepartmentMembers/{id}
+     * Get department members for a specific department (must belong to the requesting platform/org). SCIM format.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2DepartmentMembersRetrieve2(id: string, org: string): CancelablePromise<any>;
+    /**
+     * PUT /scim/v2/DepartmentMembers/{id}
+     * Update a department member using core logic. SCIM format.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2DepartmentMembersUpdate(id: string, org: string): CancelablePromise<any>;
+    /**
+     * DELETE /scim/v2/DepartmentMembers/{id}
+     * Delete a department member using core logic. SCIM format.
+     * @param id
+     * @param org
+     * @returns void
+     * @throws ApiError
+     */
+    static orgsScimV2DepartmentMembersDestroy(id: string, org: string): CancelablePromise<void>;
+    /**
+     * GET /scim/v2/Departments
+     *
+     * List departments in the system. Supports filtering and pagination.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2DepartmentsRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * POST /scim/v2/Departments
+     *
+     * Create a new department in the system.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2DepartmentsCreate(org: string): CancelablePromise<any>;
+    /**
+     * GET /scim/v2/Departments/{id}
+     *
+     * Get details of a specific department.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2DepartmentsRetrieve2(id: string, org: string): CancelablePromise<any>;
+    /**
+     * PUT /scim/v2/Departments/{id}
+     *
+     * Update a department's information.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2DepartmentsUpdate(id: string, org: string): CancelablePromise<any>;
+    /**
+     * DELETE /scim/v2/Departments/{id}
+     *
+     * Delete a department from the system.
+     * @param id
+     * @param org
+     * @returns void
+     * @throws ApiError
+     */
+    static orgsScimV2DepartmentsDestroy(id: string, org: string): CancelablePromise<void>;
+    /**
+     * POST /scim/v2/Departments/{id}/add_members
+     *
+     * Add members to a department.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2DepartmentsAddMembersCreate(id: string, org: string): CancelablePromise<any>;
+    /**
+     * POST /scim/v2/Departments/{id}/remove_members
+     *
+     * Remove members from a department.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2DepartmentsRemoveMembersCreate(id: string, org: string): CancelablePromise<any>;
+    /**
+     * SCIM Group Member endpoints for managing group members in the system.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2GroupMembersRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * SCIM Group Member endpoints for managing group members in the system.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2GroupMembersCreate(org: string): CancelablePromise<any>;
+    /**
+     * SCIM Group Member endpoints for managing group members in the system.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2GroupMembersRetrieve2(id: string, org: string): CancelablePromise<any>;
+    /**
+     * SCIM Group Member endpoints for managing group members in the system.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2GroupMembersUpdate(id: string, org: string): CancelablePromise<any>;
+    /**
+     * SCIM Group Member endpoints for managing group members in the system.
+     * @param id
+     * @param org
+     * @returns void
+     * @throws ApiError
+     */
+    static orgsScimV2GroupMembersDestroy(id: string, org: string): CancelablePromise<void>;
+    /**
+     * SCIM Group endpoints for managing user groups in the system (SCIM 2.0).
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2GroupsRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * SCIM Group endpoints for managing user groups in the system (SCIM 2.0).
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2GroupsCreate(org: string): CancelablePromise<any>;
+    /**
+     * GET /scim/v2/groups/{id}
+     *
+     * Get details of a specific user group.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2GroupsRetrieve2(id: string, org: string): CancelablePromise<any>;
+    /**
+     * PUT /scim/v2/groups/{id}
+     *
+     * Update a user group's information.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2GroupsUpdate(id: string, org: string): CancelablePromise<any>;
+    /**
+     * DELETE /scim/v2/groups/{id}
+     *
+     * Delete a user group from the system.
+     * @param id
+     * @param org
+     * @returns void
+     * @throws ApiError
+     */
+    static orgsScimV2GroupsDestroy(id: string, org: string): CancelablePromise<void>;
+    /**
+     * POST /scim/v2/groups/{id}/add_members
+     *
+     * Add members to a user group.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2GroupsAddMembersCreate(id: string, org: string): CancelablePromise<any>;
+    /**
+     * POST /scim/v2/groups/{id}/remove_members
+     *
+     * Remove members from a user group.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2GroupsRemoveMembersCreate(id: string, org: string): CancelablePromise<any>;
+    /**
+     * GET /scim/v2/users
+     *
+     * List users in the system. Supports filtering and pagination.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2UsersRetrieve(org: string): CancelablePromise<any>;
+    /**
+     * POST /scim/v2/users
+     *
+     * Create a new user in the system.
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2UsersCreate(org: string): CancelablePromise<any>;
+    /**
+     * GET /scim/v2/users/{id}
+     *
+     * Get details of a specific user.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2UsersRetrieve2(id: string, org: string): CancelablePromise<any>;
+    /**
+     * PUT /scim/v2/users/{id}
+     *
+     * Update a user's information.
+     * @param id
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    static orgsScimV2UsersUpdate(id: string, org: string): CancelablePromise<any>;
+    /**
+     * DELETE /scim/v2/users/{id} is not supported.
+     * @param id
+     * @param org
+     * @returns void
+     * @throws ApiError
+     */
+    static orgsScimV2UsersDestroy(id: string, org: string): CancelablePromise<void>;
+}