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

package/src/services/NotificationBuilderService.ts

@@ -17,21 +17,31 @@ export 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
      */
-    public static notificationV1OrgsNotificationBuilderRecipientsList(
+    public static notificationV1OrgsNotificationBuilderRecipientsList({
+        id,
+        platformKey,
+        page,
+        pageSize,
+        search,
+    }: {
         id: string,
         platformKey: string,
+        /**
+         * Page number
+         */
         page?: number,
+        /**
+         * Number of items per page
+         */
         pageSize?: number,
+        /**
+         * Search recipients by username or email
+         */
         search?: string,
-    ): CancelablePromise<Array<Recipient>> {
+    }): CancelablePromise<Array<Recipient>> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/notification/v1/orgs/{platform_key}/notification-builder/{id}/recipients/',
@@ -49,13 +59,14 @@ export class NotificationBuilderService {
     /**
      * Get notification context data
      * Get all context data needed for notification building including templates, channels, and platforms
-     * @param platformKey
      * @returns ContextResponse
      * @throws ApiError
      */
-    public static notificationV1OrgsNotificationBuilderContextRetrieve(
+    public static notificationV1OrgsNotificationBuilderContextRetrieve({
+        platformKey,
+    }: {
         platformKey: string,
-    ): CancelablePromise<ContextResponse> {
+    }): CancelablePromise<ContextResponse> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/notification/v1/orgs/{platform_key}/notification-builder/context/',
@@ -67,15 +78,16 @@ export class NotificationBuilderService {
     /**
      * Preview notification
      * Preview notification recipients and get build ID for sending
-     * @param platformKey
-     * @param requestBody
      * @returns PreviewResponse
      * @throws ApiError
      */
-    public static notificationV1OrgsNotificationBuilderPreviewCreate(
+    public static notificationV1OrgsNotificationBuilderPreviewCreate({
+        platformKey,
+        requestBody,
+    }: {
         platformKey: string,
         requestBody: NotificationPreview,
-    ): CancelablePromise<PreviewResponse> {
+    }): CancelablePromise<PreviewResponse> {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/api/notification/v1/orgs/{platform_key}/notification-builder/preview/',
@@ -89,15 +101,16 @@ export class NotificationBuilderService {
     /**
      * Send notification
      * Send notifications to all recipients in a build
-     * @param platformKey
-     * @param requestBody
      * @returns SendResponse
      * @throws ApiError
      */
-    public static notificationV1OrgsNotificationBuilderSendCreate(
+    public static notificationV1OrgsNotificationBuilderSendCreate({
+        platformKey,
+        requestBody,
+    }: {
         platformKey: string,
         requestBody: SendNotification,
-    ): CancelablePromise<SendResponse> {
+    }): CancelablePromise<SendResponse> {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/api/notification/v1/orgs/{platform_key}/notification-builder/send/',
@@ -111,15 +124,16 @@ export class NotificationBuilderService {
     /**
      * Validate notification source
      * Validate a single notification source (email, username, platform, csv)
-     * @param platformKey
-     * @param requestBody
      * @returns ValidateSourceResponse
      * @throws ApiError
      */
-    public static notificationV1OrgsNotificationBuilderValidateSourceCreate(
+    public static notificationV1OrgsNotificationBuilderValidateSourceCreate({
+        platformKey,
+        requestBody,
+    }: {
         platformKey: string,
         requestBody: NotificationSource,
-    ): CancelablePromise<ValidateSourceResponse> {
+    }): CancelablePromise<ValidateSourceResponse> {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/api/notification/v1/orgs/{platform_key}/notification-builder/validate_source/',

package/src/services/NotificationService.ts

@@ -15,13 +15,14 @@ import { request as __request } from '../core/request';
 export class NotificationService {
     /**
      * Unsubscribe from a campaign using a hash
-     * @param unsubscribeHash
      * @returns any
      * @throws ApiError
      */
-    public static notificationV1CampaignsUnsubscribeRetrieve(
+    public static notificationV1CampaignsUnsubscribeRetrieve({
+        unsubscribeHash,
+    }: {
         unsubscribeHash: string,
-    ): CancelablePromise<{
+    }): CancelablePromise<{
         success?: boolean;
         message?: string;
     }> {
@@ -35,23 +36,24 @@ export class NotificationService {
     }
     /**
      * Get notifications for a user
-     * @param org
-     * @param channel
-     * @param endDate
-     * @param excludeChannel
-     * @param startDate
-     * @param status
      * @returns Notification
      * @throws ApiError
      */
-    public static notificationV1OrgsNotificationsRetrieve(
+    public static notificationV1OrgsNotificationsRetrieve({
+        org,
+        channel,
+        endDate,
+        excludeChannel,
+        startDate,
+        status,
+    }: {
         org: string,
         channel?: string,
         endDate?: string,
         excludeChannel?: string,
         startDate?: string,
         status?: string,
-    ): CancelablePromise<Notification> {
+    }): CancelablePromise<Notification> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/notification/v1/orgs/{org}/notifications/',
@@ -69,15 +71,16 @@ export class NotificationService {
     }
     /**
      * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-     * @param org
-     * @param requestBody
      * @returns Notification
      * @throws ApiError
      */
-    public static notificationV1OrgsNotificationsUpdate(
+    public static notificationV1OrgsNotificationsUpdate({
+        org,
+        requestBody,
+    }: {
         org: string,
         requestBody: Notification,
-    ): CancelablePromise<Notification> {
+    }): CancelablePromise<Notification> {
         return __request(OpenAPI, {
             method: 'PUT',
             url: '/api/notification/v1/orgs/{org}/notifications/',
@@ -90,15 +93,16 @@ export class NotificationService {
     }
     /**
      * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-     * @param org
-     * @param requestBody
      * @returns Notification
      * @throws ApiError
      */
-    public static notificationV1OrgsNotificationsBulkUpdatePartialUpdate(
+    public static notificationV1OrgsNotificationsBulkUpdatePartialUpdate({
+        org,
+        requestBody,
+    }: {
         org: string,
         requestBody?: PatchedNotification,
-    ): CancelablePromise<Notification> {
+    }): CancelablePromise<Notification> {
         return __request(OpenAPI, {
             method: 'PATCH',
             url: '/api/notification/v1/orgs/{org}/notifications/bulk-update/',
@@ -111,17 +115,18 @@ export class NotificationService {
     }
     /**
      * Get notifications for a user
-     * @param org
-     * @param userId
-     * @param channel
-     * @param endDate
-     * @param excludeChannel
-     * @param startDate
-     * @param status
      * @returns Notification
      * @throws ApiError
      */
-    public static notificationV1OrgsUsersNotificationsRetrieve(
+    public static notificationV1OrgsUsersNotificationsRetrieve({
+        org,
+        userId,
+        channel,
+        endDate,
+        excludeChannel,
+        startDate,
+        status,
+    }: {
         org: string,
         userId: string,
         channel?: string,
@@ -129,7 +134,7 @@ export class NotificationService {
         excludeChannel?: string,
         startDate?: string,
         status?: string,
-    ): CancelablePromise<Notification> {
+    }): CancelablePromise<Notification> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/notification/v1/orgs/{org}/users/{user_id}/notifications/',
@@ -148,17 +153,18 @@ export class NotificationService {
     }
     /**
      * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-     * @param org
-     * @param userId
-     * @param requestBody
      * @returns Notification
      * @throws ApiError
      */
-    public static notificationV1OrgsUsersNotificationsUpdate(
+    public static notificationV1OrgsUsersNotificationsUpdate({
+        org,
+        userId,
+        requestBody,
+    }: {
         org: string,
         userId: string,
         requestBody: Notification,
-    ): CancelablePromise<Notification> {
+    }): CancelablePromise<Notification> {
         return __request(OpenAPI, {
             method: 'PUT',
             url: '/api/notification/v1/orgs/{org}/users/{user_id}/notifications/',
@@ -172,19 +178,20 @@ export class NotificationService {
     }
     /**
      * Get notifications count for a user
-     * @param org
-     * @param userId
-     * @param channel
-     * @param status
      * @returns NotificationCount
      * @throws ApiError
      */
-    public static notificationV1OrgsUsersNotificationsCountRetrieve(
+    public static notificationV1OrgsUsersNotificationsCountRetrieve({
+        org,
+        userId,
+        channel,
+        status,
+    }: {
         org: string,
         userId: string,
         channel?: string,
         status?: string,
-    ): CancelablePromise<NotificationCount> {
+    }): CancelablePromise<NotificationCount> {
         return __request(OpenAPI, {
             method: 'GET',
             url: '/api/notification/v1/orgs/{org}/users/{user_id}/notifications-count/',
@@ -200,17 +207,18 @@ export class NotificationService {
     }
     /**
      * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-     * @param notificationId
-     * @param org
-     * @param userId
      * @returns void
      * @throws ApiError
      */
-    public static notificationV1OrgsUsersNotificationsDestroy(
+    public static notificationV1OrgsUsersNotificationsDestroy({
+        notificationId,
+        org,
+        userId,
+    }: {
         notificationId: string,
         org: string,
         userId: string,
-    ): CancelablePromise<void> {
+    }): CancelablePromise<void> {
         return __request(OpenAPI, {
             method: 'DELETE',
             url: '/api/notification/v1/orgs/{org}/users/{user_id}/notifications/{notification_id}/',
@@ -223,17 +231,18 @@ export class NotificationService {
     }
     /**
      * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-     * @param org
-     * @param userId
-     * @param requestBody
      * @returns Notification
      * @throws ApiError
      */
-    public static notificationV1OrgsUsersNotificationsBulkUpdatePartialUpdate(
+    public static notificationV1OrgsUsersNotificationsBulkUpdatePartialUpdate({
+        org,
+        userId,
+        requestBody,
+    }: {
         org: string,
         userId: string,
         requestBody?: PatchedNotification,
-    ): CancelablePromise<Notification> {
+    }): CancelablePromise<Notification> {
         return __request(OpenAPI, {
             method: 'PATCH',
             url: '/api/notification/v1/orgs/{org}/users/{user_id}/notifications/bulk-update/',
@@ -247,15 +256,16 @@ export class NotificationService {
     }
     /**
      * Re-enable campaigns for a user
-     * @param platformKey
-     * @param requestBody
      * @returns any
      * @throws ApiError
      */
-    public static notificationV1OrgsCampaignsEnableCreate(
+    public static notificationV1OrgsCampaignsEnableCreate({
+        platformKey,
+        requestBody,
+    }: {
         platformKey: string,
         requestBody?: CampaignEnablement,
-    ): CancelablePromise<{
+    }): CancelablePromise<{
         success?: boolean;
         message?: string;
     }> {
@@ -271,15 +281,16 @@ export class NotificationService {
     }
     /**
      * Exclude a user from specified campaigns
-     * @param platformKey
-     * @param requestBody
      * @returns any
      * @throws ApiError
      */
-    public static notificationV1OrgsCampaignsExcludeCreate(
+    public static notificationV1OrgsCampaignsExcludeCreate({
+        platformKey,
+        requestBody,
+    }: {
         platformKey: string,
         requestBody?: CampaignExclusion,
-    ): CancelablePromise<{
+    }): CancelablePromise<{
         success?: boolean;
         message?: string;
     }> {
@@ -295,15 +306,16 @@ export class NotificationService {
     }
     /**
      * Mark all notifications as read for a user. Optionally provide specific notification IDs.
-     * @param platformKey
-     * @param requestBody
      * @returns MarkAllReadResponse
      * @throws ApiError
      */
-    public static notificationV1OrgsMarkAllAsReadCreate(
+    public static notificationV1OrgsMarkAllAsReadCreate({
+        platformKey,
+        requestBody,
+    }: {
         platformKey: string,
         requestBody?: MarkAllReadRequest,
-    ): CancelablePromise<MarkAllReadResponse> {
+    }): CancelablePromise<MarkAllReadResponse> {
         return __request(OpenAPI, {
             method: 'POST',
             url: '/api/notification/v1/orgs/{platform_key}/mark-all-as-read',