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

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

@@ -9,120 +9,127 @@ 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<{
+    static notificationV1CampaignsUnsubscribeRetrieve({ unsubscribeHash, }: {
+        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>;
+    static notificationV1OrgsNotificationsRetrieve({ org, channel, endDate, excludeChannel, startDate, status, }: {
+        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>;
+    static notificationV1OrgsNotificationsUpdate({ org, requestBody, }: {
+        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>;
+    static notificationV1OrgsNotificationsBulkUpdatePartialUpdate({ org, requestBody, }: {
+        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>;
+    static notificationV1OrgsUsersNotificationsRetrieve({ org, userId, channel, endDate, excludeChannel, startDate, status, }: {
+        org: 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>;
+    static notificationV1OrgsUsersNotificationsUpdate({ org, userId, requestBody, }: {
+        org: 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>;
+    static notificationV1OrgsUsersNotificationsCountRetrieve({ org, userId, channel, status, }: {
+        org: 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>;
+    static notificationV1OrgsUsersNotificationsDestroy({ notificationId, org, userId, }: {
+        notificationId: string;
+        org: 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>;
+    static notificationV1OrgsUsersNotificationsBulkUpdatePartialUpdate({ org, userId, requestBody, }: {
+        org: 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<{
+    static notificationV1OrgsCampaignsEnableCreate({ platformKey, requestBody, }: {
+        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<{
+    static notificationV1OrgsCampaignsExcludeCreate({ platformKey, requestBody, }: {
+        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>;
+    static notificationV1OrgsMarkAllAsReadCreate({ platformKey, requestBody, }: {
+        platformKey: string;
+        requestBody?: MarkAllReadRequest;
+    }): CancelablePromise<MarkAllReadResponse>;
 }

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

@@ -3,260 +3,289 @@ 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>;
+    static orgsScimV2DepartmentMembersRetrieve({ org, }: {
+        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>;
+    static orgsScimV2DepartmentMembersCreate({ org, }: {
+        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>;
+    static orgsScimV2DepartmentMembersRetrieve2({ id, org, }: {
+        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>;
+    static orgsScimV2DepartmentMembersUpdate({ id, org, }: {
+        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>;
+    static orgsScimV2DepartmentMembersDestroy({ id, org, }: {
+        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>;
+    static orgsScimV2DepartmentsRetrieve({ org, }: {
+        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>;
+    static orgsScimV2DepartmentsCreate({ org, }: {
+        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>;
+    static orgsScimV2DepartmentsRetrieve2({ id, org, }: {
+        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>;
+    static orgsScimV2DepartmentsUpdate({ id, org, }: {
+        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>;
+    static orgsScimV2DepartmentsDestroy({ id, org, }: {
+        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>;
+    static orgsScimV2DepartmentsAddMembersCreate({ id, org, }: {
+        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>;
+    static orgsScimV2DepartmentsRemoveMembersCreate({ id, org, }: {
+        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>;
+    static orgsScimV2GroupMembersRetrieve({ org, }: {
+        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>;
+    static orgsScimV2GroupMembersCreate({ org, }: {
+        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>;
+    static orgsScimV2GroupMembersRetrieve2({ id, org, }: {
+        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>;
+    static orgsScimV2GroupMembersUpdate({ id, org, }: {
+        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>;
+    static orgsScimV2GroupMembersDestroy({ id, org, }: {
+        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>;
+    static orgsScimV2GroupsRetrieve({ org, }: {
+        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>;
+    static orgsScimV2GroupsCreate({ org, }: {
+        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>;
+    static orgsScimV2GroupsRetrieve2({ id, org, }: {
+        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>;
+    static orgsScimV2GroupsUpdate({ id, org, }: {
+        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>;
+    static orgsScimV2GroupsDestroy({ id, org, }: {
+        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>;
+    static orgsScimV2GroupsAddMembersCreate({ id, org, }: {
+        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>;
+    static orgsScimV2GroupsRemoveMembersCreate({ id, org, }: {
+        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>;
+    static orgsScimV2UsersRetrieve({ org, }: {
+        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>;
+    static orgsScimV2UsersCreate({ org, }: {
+        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>;
+    static orgsScimV2UsersRetrieve2({ id, org, }: {
+        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>;
+    static orgsScimV2UsersUpdate({ id, org, }: {
+        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>;
+    static orgsScimV2UsersDestroy({ id, org, }: {
+        id: string;
+        org: string;
+    }): CancelablePromise<void>;
 }