@bluecopa/core 0.1.29 → 0.1.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,16 @@
1
+ export interface GetAllInboxItemsRequest {
2
+ page?: number;
3
+ perPage?: number;
4
+ }
5
+ export interface InboxItem {
6
+ [key: string]: any;
7
+ }
8
+ /**
9
+ * Gets all inbox items
10
+ * @param params - The inbox items request parameters
11
+ * @param params.page - Optional: Page number (default: 0)
12
+ * @param params.perPage - Optional: Items per page (default: 50)
13
+ * @returns Promise<InboxItem[]> Array of inbox items
14
+ * @throws Error if the request fails
15
+ */
16
+ export declare function getAllInboxItems({ page, perPage, }?: GetAllInboxItemsRequest): Promise<InboxItem[]>;
@@ -0,0 +1,6 @@
1
+ export { getAllInboxItems } from './getAllInboxItems';
2
+ export { markItemAsRead } from './markItemAsRead';
3
+ export { markItemAsUnread } from './markItemAsUnread';
4
+ export type { GetAllInboxItemsRequest, InboxItem } from './getAllInboxItems';
5
+ export type { MarkItemAsReadRequest } from './markItemAsRead';
6
+ export type { MarkItemAsUnreadRequest } from './markItemAsUnread';
@@ -0,0 +1,11 @@
1
+ export interface MarkItemAsReadRequest {
2
+ inboxItemIds: string[];
3
+ }
4
+ /**
5
+ * Marks inbox items as read
6
+ * @param params - The mark as read request parameters
7
+ * @param params.inboxItemIds - Required: Array of inbox item IDs to mark as read
8
+ * @returns Promise<void>
9
+ * @throws Error if the request fails
10
+ */
11
+ export declare function markItemAsRead({ inboxItemIds, }: MarkItemAsReadRequest): Promise<void>;
@@ -0,0 +1,11 @@
1
+ export interface MarkItemAsUnreadRequest {
2
+ inboxItemIds: string[];
3
+ }
4
+ /**
5
+ * Marks inbox items as unread
6
+ * @param params - The mark as unread request parameters
7
+ * @param params.inboxItemIds - Required: Array of inbox item IDs to mark as unread
8
+ * @returns Promise<void>
9
+ * @throws Error if the request fails
10
+ */
11
+ export declare function markItemAsUnread({ inboxItemIds, }: MarkItemAsUnreadRequest): Promise<void>;
@@ -16,3 +16,4 @@ export * as form from './form';
16
16
  export * as audit from './audit';
17
17
  export * as templatedPipeline from './templatedPipeline';
18
18
  export * as process from './process';
19
+ export * as inboxItems from './inboxItems';
package/dist/index.d.ts CHANGED
@@ -20,3 +20,6 @@ export type { User } from './api/user/getAllUsers';
20
20
  export type { HttpTrigger } from './api/workflow/getAllHttpTriggers';
21
21
  export type { GetRowsOptions, GetRowsResponse } from './api/inputTable/getRows';
22
22
  export type { UpdateRowOptions } from './api/inputTable/updateRow';
23
+ export type { GetAllInboxItemsRequest, InboxItem } from './api/inboxItems/getAllInboxItems';
24
+ export type { MarkItemAsReadRequest } from './api/inboxItems/markItemAsRead';
25
+ export type { MarkItemAsUnreadRequest } from './api/inboxItems/markItemAsUnread';