@caraer/client 2.0.455 → 2.0.456

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.
@@ -130,6 +130,7 @@ docs/GridItemDTO.md
130
130
  docs/GridItemSettingsDTO.md
131
131
  docs/HasAppDTO.md
132
132
  docs/InstallAppRequest.md
133
+ docs/Item.md
133
134
  docs/Leadscore.md
134
135
  docs/LinkedProperty.md
135
136
  docs/LoadAppSettingOptionsRequest.md
@@ -144,6 +145,7 @@ docs/MultiValueMapStringString.md
144
145
  docs/NotFoundError.md
145
146
  docs/NotFoundErrorCause.md
146
147
  docs/NotFoundErrorCauseStackTraceInner.md
148
+ docs/NotificationInboxDTO.md
147
149
  docs/NotificationsApi.md
148
150
  docs/Number.md
149
151
  docs/NumberRange.md
@@ -255,6 +257,7 @@ docs/ShowResponseMapStringAnalyticsDashboardConfig.md
255
257
  docs/ShowResponseMapStringBoolean.md
256
258
  docs/ShowResponseMapStringObject.md
257
259
  docs/ShowResponseMapStringString.md
260
+ docs/ShowResponseNotificationInboxDTO.md
258
261
  docs/ShowResponseObject.md
259
262
  docs/ShowResponseObjectAccessGrantCandidatesDTO.md
260
263
  docs/ShowResponsePageContentDTO.md
package/api.ts CHANGED
@@ -2800,6 +2800,23 @@ export interface InstallAppRequest {
2800
2800
  */
2801
2801
  'appBarVisibility'?: { [key: string]: AppBarVisibilityEntry; };
2802
2802
  }
2803
+ export interface Item {
2804
+ 'id'?: string;
2805
+ 'title'?: string;
2806
+ 'body'?: string;
2807
+ 'type'?: string;
2808
+ 'icon'?: string;
2809
+ 'actionTitle'?: string;
2810
+ 'action'?: string;
2811
+ 'data'?: { [key: string]: any | null; };
2812
+ 'sender'?: string;
2813
+ 'company'?: string;
2814
+ 'createdAt'?: string;
2815
+ 'updatedAt'?: string;
2816
+ 'readAt'?: string;
2817
+ 'sourceAppUuid'?: string;
2818
+ 'appLogo'?: string;
2819
+ }
2803
2820
  /**
2804
2821
  * DTO representing a lead score rule
2805
2822
  */
@@ -3060,6 +3077,10 @@ export interface NotFoundErrorCauseStackTraceInner {
3060
3077
  'className'?: string;
3061
3078
  'nativeMethod'?: boolean;
3062
3079
  }
3080
+ export interface NotificationInboxDTO {
3081
+ 'notifications'?: Array<Item>;
3082
+ 'unreadCount'?: number;
3083
+ }
3063
3084
  export interface Number extends PropertyFormat {
3064
3085
  }
3065
3086
  export interface NumberRange extends PropertyFormat {
@@ -5480,6 +5501,19 @@ export interface ShowResponseMapStringString {
5480
5501
  'message'?: string;
5481
5502
  'data'?: { [key: string]: any; };
5482
5503
  }
5504
+ /**
5505
+ * Represents the response for viewing or showing a specific resource.
5506
+ */
5507
+ export interface ShowResponseNotificationInboxDTO {
5508
+ /**
5509
+ * A message detailing the result of the operation.
5510
+ */
5511
+ 'message'?: string;
5512
+ /**
5513
+ * The data payload of the response, if any.
5514
+ */
5515
+ 'data'?: NotificationInboxDTO;
5516
+ }
5483
5517
  /**
5484
5518
  * Represents the response for viewing or showing a specific resource.
5485
5519
  */
@@ -16362,6 +16396,50 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
16362
16396
  options: localVarRequestOptions,
16363
16397
  };
16364
16398
  },
16399
+ /**
16400
+ *
16401
+ * @summary List in-app notifications for the logged-in user
16402
+ * @param {string} [company]
16403
+ * @param {number} [limit]
16404
+ * @param {*} [options] Override http request option.
16405
+ * @throws {RequiredError}
16406
+ */
16407
+ listNotifications: async (company?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
16408
+ const localVarPath = `/api/v2/notifications`;
16409
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
16410
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
16411
+ let baseOptions;
16412
+ if (configuration) {
16413
+ baseOptions = configuration.baseOptions;
16414
+ }
16415
+
16416
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
16417
+ const localVarHeaderParameter = {} as any;
16418
+ const localVarQueryParameter = {} as any;
16419
+
16420
+ // authentication bearerAuth required
16421
+ // http bearer authentication required
16422
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
16423
+
16424
+ if (company !== undefined) {
16425
+ localVarQueryParameter['company'] = company;
16426
+ }
16427
+
16428
+ if (limit !== undefined) {
16429
+ localVarQueryParameter['limit'] = limit;
16430
+ }
16431
+
16432
+ localVarHeaderParameter['Accept'] = 'application/json';
16433
+
16434
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
16435
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16436
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
16437
+
16438
+ return {
16439
+ url: toPathString(localVarUrlObj),
16440
+ options: localVarRequestOptions,
16441
+ };
16442
+ },
16365
16443
  /**
16366
16444
  *
16367
16445
  * @summary Mark all notifications as read for the current company
@@ -16495,6 +16573,20 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
16495
16573
  const localVarOperationServerBasePath = operationServerMap['NotificationsApi.dismissNotification']?.[localVarOperationServerIndex]?.url;
16496
16574
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16497
16575
  },
16576
+ /**
16577
+ *
16578
+ * @summary List in-app notifications for the logged-in user
16579
+ * @param {string} [company]
16580
+ * @param {number} [limit]
16581
+ * @param {*} [options] Override http request option.
16582
+ * @throws {RequiredError}
16583
+ */
16584
+ async listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseNotificationInboxDTO>> {
16585
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listNotifications(company, limit, options);
16586
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
16587
+ const localVarOperationServerBasePath = operationServerMap['NotificationsApi.listNotifications']?.[localVarOperationServerIndex]?.url;
16588
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16589
+ },
16498
16590
  /**
16499
16591
  *
16500
16592
  * @summary Mark all notifications as read for the current company
@@ -16552,6 +16644,17 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
16552
16644
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponseString> {
16553
16645
  return localVarFp.dismissNotification(notificationId, options).then((request) => request(axios, basePath));
16554
16646
  },
16647
+ /**
16648
+ *
16649
+ * @summary List in-app notifications for the logged-in user
16650
+ * @param {string} [company]
16651
+ * @param {number} [limit]
16652
+ * @param {*} [options] Override http request option.
16653
+ * @throws {RequiredError}
16654
+ */
16655
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseNotificationInboxDTO> {
16656
+ return localVarFp.listNotifications(company, limit, options).then((request) => request(axios, basePath));
16657
+ },
16555
16658
  /**
16556
16659
  *
16557
16660
  * @summary Mark all notifications as read for the current company
@@ -16599,6 +16702,18 @@ export class NotificationsApi extends BaseAPI {
16599
16702
  return NotificationsApiFp(this.configuration).dismissNotification(notificationId, options).then((request) => request(this.axios, this.basePath));
16600
16703
  }
16601
16704
 
16705
+ /**
16706
+ *
16707
+ * @summary List in-app notifications for the logged-in user
16708
+ * @param {string} [company]
16709
+ * @param {number} [limit]
16710
+ * @param {*} [options] Override http request option.
16711
+ * @throws {RequiredError}
16712
+ */
16713
+ public listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig) {
16714
+ return NotificationsApiFp(this.configuration).listNotifications(company, limit, options).then((request) => request(this.axios, this.basePath));
16715
+ }
16716
+
16602
16717
  /**
16603
16718
  *
16604
16719
  * @summary Mark all notifications as read for the current company
package/dist/api.d.ts CHANGED
@@ -2792,6 +2792,25 @@ export interface InstallAppRequest {
2792
2792
  [key: string]: AppBarVisibilityEntry;
2793
2793
  };
2794
2794
  }
2795
+ export interface Item {
2796
+ 'id'?: string;
2797
+ 'title'?: string;
2798
+ 'body'?: string;
2799
+ 'type'?: string;
2800
+ 'icon'?: string;
2801
+ 'actionTitle'?: string;
2802
+ 'action'?: string;
2803
+ 'data'?: {
2804
+ [key: string]: any | null;
2805
+ };
2806
+ 'sender'?: string;
2807
+ 'company'?: string;
2808
+ 'createdAt'?: string;
2809
+ 'updatedAt'?: string;
2810
+ 'readAt'?: string;
2811
+ 'sourceAppUuid'?: string;
2812
+ 'appLogo'?: string;
2813
+ }
2795
2814
  /**
2796
2815
  * DTO representing a lead score rule
2797
2816
  */
@@ -3055,6 +3074,10 @@ export interface NotFoundErrorCauseStackTraceInner {
3055
3074
  'className'?: string;
3056
3075
  'nativeMethod'?: boolean;
3057
3076
  }
3077
+ export interface NotificationInboxDTO {
3078
+ 'notifications'?: Array<Item>;
3079
+ 'unreadCount'?: number;
3080
+ }
3058
3081
  export interface Number extends PropertyFormat {
3059
3082
  }
3060
3083
  export interface NumberRange extends PropertyFormat {
@@ -5537,6 +5560,19 @@ export interface ShowResponseMapStringString {
5537
5560
  [key: string]: any;
5538
5561
  };
5539
5562
  }
5563
+ /**
5564
+ * Represents the response for viewing or showing a specific resource.
5565
+ */
5566
+ export interface ShowResponseNotificationInboxDTO {
5567
+ /**
5568
+ * A message detailing the result of the operation.
5569
+ */
5570
+ 'message'?: string;
5571
+ /**
5572
+ * The data payload of the response, if any.
5573
+ */
5574
+ 'data'?: NotificationInboxDTO;
5575
+ }
5540
5576
  /**
5541
5577
  * Represents the response for viewing or showing a specific resource.
5542
5578
  */
@@ -11642,6 +11678,15 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
11642
11678
  * @throws {RequiredError}
11643
11679
  */
11644
11680
  dismissNotification: (notificationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11681
+ /**
11682
+ *
11683
+ * @summary List in-app notifications for the logged-in user
11684
+ * @param {string} [company]
11685
+ * @param {number} [limit]
11686
+ * @param {*} [options] Override http request option.
11687
+ * @throws {RequiredError}
11688
+ */
11689
+ listNotifications: (company?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11645
11690
  /**
11646
11691
  *
11647
11692
  * @summary Mark all notifications as read for the current company
@@ -11678,6 +11723,15 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
11678
11723
  * @throws {RequiredError}
11679
11724
  */
11680
11725
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseString>>;
11726
+ /**
11727
+ *
11728
+ * @summary List in-app notifications for the logged-in user
11729
+ * @param {string} [company]
11730
+ * @param {number} [limit]
11731
+ * @param {*} [options] Override http request option.
11732
+ * @throws {RequiredError}
11733
+ */
11734
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseNotificationInboxDTO>>;
11681
11735
  /**
11682
11736
  *
11683
11737
  * @summary Mark all notifications as read for the current company
@@ -11714,6 +11768,15 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
11714
11768
  * @throws {RequiredError}
11715
11769
  */
11716
11770
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponseString>;
11771
+ /**
11772
+ *
11773
+ * @summary List in-app notifications for the logged-in user
11774
+ * @param {string} [company]
11775
+ * @param {number} [limit]
11776
+ * @param {*} [options] Override http request option.
11777
+ * @throws {RequiredError}
11778
+ */
11779
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseNotificationInboxDTO>;
11717
11780
  /**
11718
11781
  *
11719
11782
  * @summary Mark all notifications as read for the current company
@@ -11750,6 +11813,15 @@ export declare class NotificationsApi extends BaseAPI {
11750
11813
  * @throws {RequiredError}
11751
11814
  */
11752
11815
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseString, any, {}>>;
11816
+ /**
11817
+ *
11818
+ * @summary List in-app notifications for the logged-in user
11819
+ * @param {string} [company]
11820
+ * @param {number} [limit]
11821
+ * @param {*} [options] Override http request option.
11822
+ * @throws {RequiredError}
11823
+ */
11824
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseNotificationInboxDTO, any, {}>>;
11753
11825
  /**
11754
11826
  *
11755
11827
  * @summary Mark all notifications as read for the current company
package/dist/api.js CHANGED
@@ -8704,6 +8704,43 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
8704
8704
  options: localVarRequestOptions,
8705
8705
  };
8706
8706
  }),
8707
+ /**
8708
+ *
8709
+ * @summary List in-app notifications for the logged-in user
8710
+ * @param {string} [company]
8711
+ * @param {number} [limit]
8712
+ * @param {*} [options] Override http request option.
8713
+ * @throws {RequiredError}
8714
+ */
8715
+ listNotifications: (company_1, limit_1, ...args_1) => __awaiter(this, [company_1, limit_1, ...args_1], void 0, function* (company, limit, options = {}) {
8716
+ const localVarPath = `/api/v2/notifications`;
8717
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8718
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
8719
+ let baseOptions;
8720
+ if (configuration) {
8721
+ baseOptions = configuration.baseOptions;
8722
+ }
8723
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
8724
+ const localVarHeaderParameter = {};
8725
+ const localVarQueryParameter = {};
8726
+ // authentication bearerAuth required
8727
+ // http bearer authentication required
8728
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
8729
+ if (company !== undefined) {
8730
+ localVarQueryParameter['company'] = company;
8731
+ }
8732
+ if (limit !== undefined) {
8733
+ localVarQueryParameter['limit'] = limit;
8734
+ }
8735
+ localVarHeaderParameter['Accept'] = 'application/json';
8736
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
8737
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8738
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
8739
+ return {
8740
+ url: (0, common_1.toPathString)(localVarUrlObj),
8741
+ options: localVarRequestOptions,
8742
+ };
8743
+ }),
8707
8744
  /**
8708
8745
  *
8709
8746
  * @summary Mark all notifications as read for the current company
@@ -8825,6 +8862,23 @@ const NotificationsApiFp = function (configuration) {
8825
8862
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8826
8863
  });
8827
8864
  },
8865
+ /**
8866
+ *
8867
+ * @summary List in-app notifications for the logged-in user
8868
+ * @param {string} [company]
8869
+ * @param {number} [limit]
8870
+ * @param {*} [options] Override http request option.
8871
+ * @throws {RequiredError}
8872
+ */
8873
+ listNotifications(company, limit, options) {
8874
+ return __awaiter(this, void 0, void 0, function* () {
8875
+ var _a, _b, _c;
8876
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listNotifications(company, limit, options);
8877
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
8878
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['NotificationsApi.listNotifications']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
8879
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8880
+ });
8881
+ },
8828
8882
  /**
8829
8883
  *
8830
8884
  * @summary Mark all notifications as read for the current company
@@ -8891,6 +8945,17 @@ const NotificationsApiFactory = function (configuration, basePath, axios) {
8891
8945
  dismissNotification(notificationId, options) {
8892
8946
  return localVarFp.dismissNotification(notificationId, options).then((request) => request(axios, basePath));
8893
8947
  },
8948
+ /**
8949
+ *
8950
+ * @summary List in-app notifications for the logged-in user
8951
+ * @param {string} [company]
8952
+ * @param {number} [limit]
8953
+ * @param {*} [options] Override http request option.
8954
+ * @throws {RequiredError}
8955
+ */
8956
+ listNotifications(company, limit, options) {
8957
+ return localVarFp.listNotifications(company, limit, options).then((request) => request(axios, basePath));
8958
+ },
8894
8959
  /**
8895
8960
  *
8896
8961
  * @summary Mark all notifications as read for the current company
@@ -8937,6 +9002,17 @@ class NotificationsApi extends base_1.BaseAPI {
8937
9002
  dismissNotification(notificationId, options) {
8938
9003
  return (0, exports.NotificationsApiFp)(this.configuration).dismissNotification(notificationId, options).then((request) => request(this.axios, this.basePath));
8939
9004
  }
9005
+ /**
9006
+ *
9007
+ * @summary List in-app notifications for the logged-in user
9008
+ * @param {string} [company]
9009
+ * @param {number} [limit]
9010
+ * @param {*} [options] Override http request option.
9011
+ * @throws {RequiredError}
9012
+ */
9013
+ listNotifications(company, limit, options) {
9014
+ return (0, exports.NotificationsApiFp)(this.configuration).listNotifications(company, limit, options).then((request) => request(this.axios, this.basePath));
9015
+ }
8940
9016
  /**
8941
9017
  *
8942
9018
  * @summary Mark all notifications as read for the current company
package/dist/esm/api.d.ts CHANGED
@@ -2792,6 +2792,25 @@ export interface InstallAppRequest {
2792
2792
  [key: string]: AppBarVisibilityEntry;
2793
2793
  };
2794
2794
  }
2795
+ export interface Item {
2796
+ 'id'?: string;
2797
+ 'title'?: string;
2798
+ 'body'?: string;
2799
+ 'type'?: string;
2800
+ 'icon'?: string;
2801
+ 'actionTitle'?: string;
2802
+ 'action'?: string;
2803
+ 'data'?: {
2804
+ [key: string]: any | null;
2805
+ };
2806
+ 'sender'?: string;
2807
+ 'company'?: string;
2808
+ 'createdAt'?: string;
2809
+ 'updatedAt'?: string;
2810
+ 'readAt'?: string;
2811
+ 'sourceAppUuid'?: string;
2812
+ 'appLogo'?: string;
2813
+ }
2795
2814
  /**
2796
2815
  * DTO representing a lead score rule
2797
2816
  */
@@ -3055,6 +3074,10 @@ export interface NotFoundErrorCauseStackTraceInner {
3055
3074
  'className'?: string;
3056
3075
  'nativeMethod'?: boolean;
3057
3076
  }
3077
+ export interface NotificationInboxDTO {
3078
+ 'notifications'?: Array<Item>;
3079
+ 'unreadCount'?: number;
3080
+ }
3058
3081
  export interface Number extends PropertyFormat {
3059
3082
  }
3060
3083
  export interface NumberRange extends PropertyFormat {
@@ -5537,6 +5560,19 @@ export interface ShowResponseMapStringString {
5537
5560
  [key: string]: any;
5538
5561
  };
5539
5562
  }
5563
+ /**
5564
+ * Represents the response for viewing or showing a specific resource.
5565
+ */
5566
+ export interface ShowResponseNotificationInboxDTO {
5567
+ /**
5568
+ * A message detailing the result of the operation.
5569
+ */
5570
+ 'message'?: string;
5571
+ /**
5572
+ * The data payload of the response, if any.
5573
+ */
5574
+ 'data'?: NotificationInboxDTO;
5575
+ }
5540
5576
  /**
5541
5577
  * Represents the response for viewing or showing a specific resource.
5542
5578
  */
@@ -11642,6 +11678,15 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
11642
11678
  * @throws {RequiredError}
11643
11679
  */
11644
11680
  dismissNotification: (notificationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11681
+ /**
11682
+ *
11683
+ * @summary List in-app notifications for the logged-in user
11684
+ * @param {string} [company]
11685
+ * @param {number} [limit]
11686
+ * @param {*} [options] Override http request option.
11687
+ * @throws {RequiredError}
11688
+ */
11689
+ listNotifications: (company?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11645
11690
  /**
11646
11691
  *
11647
11692
  * @summary Mark all notifications as read for the current company
@@ -11678,6 +11723,15 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
11678
11723
  * @throws {RequiredError}
11679
11724
  */
11680
11725
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseString>>;
11726
+ /**
11727
+ *
11728
+ * @summary List in-app notifications for the logged-in user
11729
+ * @param {string} [company]
11730
+ * @param {number} [limit]
11731
+ * @param {*} [options] Override http request option.
11732
+ * @throws {RequiredError}
11733
+ */
11734
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseNotificationInboxDTO>>;
11681
11735
  /**
11682
11736
  *
11683
11737
  * @summary Mark all notifications as read for the current company
@@ -11714,6 +11768,15 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
11714
11768
  * @throws {RequiredError}
11715
11769
  */
11716
11770
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponseString>;
11771
+ /**
11772
+ *
11773
+ * @summary List in-app notifications for the logged-in user
11774
+ * @param {string} [company]
11775
+ * @param {number} [limit]
11776
+ * @param {*} [options] Override http request option.
11777
+ * @throws {RequiredError}
11778
+ */
11779
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseNotificationInboxDTO>;
11717
11780
  /**
11718
11781
  *
11719
11782
  * @summary Mark all notifications as read for the current company
@@ -11750,6 +11813,15 @@ export declare class NotificationsApi extends BaseAPI {
11750
11813
  * @throws {RequiredError}
11751
11814
  */
11752
11815
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseString, any, {}>>;
11816
+ /**
11817
+ *
11818
+ * @summary List in-app notifications for the logged-in user
11819
+ * @param {string} [company]
11820
+ * @param {number} [limit]
11821
+ * @param {*} [options] Override http request option.
11822
+ * @throws {RequiredError}
11823
+ */
11824
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseNotificationInboxDTO, any, {}>>;
11753
11825
  /**
11754
11826
  *
11755
11827
  * @summary Mark all notifications as read for the current company
package/dist/esm/api.js CHANGED
@@ -8643,6 +8643,43 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
8643
8643
  options: localVarRequestOptions,
8644
8644
  };
8645
8645
  }),
8646
+ /**
8647
+ *
8648
+ * @summary List in-app notifications for the logged-in user
8649
+ * @param {string} [company]
8650
+ * @param {number} [limit]
8651
+ * @param {*} [options] Override http request option.
8652
+ * @throws {RequiredError}
8653
+ */
8654
+ listNotifications: (company_1, limit_1, ...args_1) => __awaiter(this, [company_1, limit_1, ...args_1], void 0, function* (company, limit, options = {}) {
8655
+ const localVarPath = `/api/v2/notifications`;
8656
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8657
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8658
+ let baseOptions;
8659
+ if (configuration) {
8660
+ baseOptions = configuration.baseOptions;
8661
+ }
8662
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
8663
+ const localVarHeaderParameter = {};
8664
+ const localVarQueryParameter = {};
8665
+ // authentication bearerAuth required
8666
+ // http bearer authentication required
8667
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
8668
+ if (company !== undefined) {
8669
+ localVarQueryParameter['company'] = company;
8670
+ }
8671
+ if (limit !== undefined) {
8672
+ localVarQueryParameter['limit'] = limit;
8673
+ }
8674
+ localVarHeaderParameter['Accept'] = 'application/json';
8675
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
8676
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8677
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
8678
+ return {
8679
+ url: toPathString(localVarUrlObj),
8680
+ options: localVarRequestOptions,
8681
+ };
8682
+ }),
8646
8683
  /**
8647
8684
  *
8648
8685
  * @summary Mark all notifications as read for the current company
@@ -8763,6 +8800,23 @@ export const NotificationsApiFp = function (configuration) {
8763
8800
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8764
8801
  });
8765
8802
  },
8803
+ /**
8804
+ *
8805
+ * @summary List in-app notifications for the logged-in user
8806
+ * @param {string} [company]
8807
+ * @param {number} [limit]
8808
+ * @param {*} [options] Override http request option.
8809
+ * @throws {RequiredError}
8810
+ */
8811
+ listNotifications(company, limit, options) {
8812
+ return __awaiter(this, void 0, void 0, function* () {
8813
+ var _a, _b, _c;
8814
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listNotifications(company, limit, options);
8815
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
8816
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NotificationsApi.listNotifications']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
8817
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8818
+ });
8819
+ },
8766
8820
  /**
8767
8821
  *
8768
8822
  * @summary Mark all notifications as read for the current company
@@ -8828,6 +8882,17 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
8828
8882
  dismissNotification(notificationId, options) {
8829
8883
  return localVarFp.dismissNotification(notificationId, options).then((request) => request(axios, basePath));
8830
8884
  },
8885
+ /**
8886
+ *
8887
+ * @summary List in-app notifications for the logged-in user
8888
+ * @param {string} [company]
8889
+ * @param {number} [limit]
8890
+ * @param {*} [options] Override http request option.
8891
+ * @throws {RequiredError}
8892
+ */
8893
+ listNotifications(company, limit, options) {
8894
+ return localVarFp.listNotifications(company, limit, options).then((request) => request(axios, basePath));
8895
+ },
8831
8896
  /**
8832
8897
  *
8833
8898
  * @summary Mark all notifications as read for the current company
@@ -8873,6 +8938,17 @@ export class NotificationsApi extends BaseAPI {
8873
8938
  dismissNotification(notificationId, options) {
8874
8939
  return NotificationsApiFp(this.configuration).dismissNotification(notificationId, options).then((request) => request(this.axios, this.basePath));
8875
8940
  }
8941
+ /**
8942
+ *
8943
+ * @summary List in-app notifications for the logged-in user
8944
+ * @param {string} [company]
8945
+ * @param {number} [limit]
8946
+ * @param {*} [options] Override http request option.
8947
+ * @throws {RequiredError}
8948
+ */
8949
+ listNotifications(company, limit, options) {
8950
+ return NotificationsApiFp(this.configuration).listNotifications(company, limit, options).then((request) => request(this.axios, this.basePath));
8951
+ }
8876
8952
  /**
8877
8953
  *
8878
8954
  * @summary Mark all notifications as read for the current company
package/docs/Item.md ADDED
@@ -0,0 +1,48 @@
1
+ # Item
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [optional] [default to undefined]
9
+ **title** | **string** | | [optional] [default to undefined]
10
+ **body** | **string** | | [optional] [default to undefined]
11
+ **type** | **string** | | [optional] [default to undefined]
12
+ **icon** | **string** | | [optional] [default to undefined]
13
+ **actionTitle** | **string** | | [optional] [default to undefined]
14
+ **action** | **string** | | [optional] [default to undefined]
15
+ **data** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
16
+ **sender** | **string** | | [optional] [default to undefined]
17
+ **company** | **string** | | [optional] [default to undefined]
18
+ **createdAt** | **string** | | [optional] [default to undefined]
19
+ **updatedAt** | **string** | | [optional] [default to undefined]
20
+ **readAt** | **string** | | [optional] [default to undefined]
21
+ **sourceAppUuid** | **string** | | [optional] [default to undefined]
22
+ **appLogo** | **string** | | [optional] [default to undefined]
23
+
24
+ ## Example
25
+
26
+ ```typescript
27
+ import { Item } from '@caraer/client';
28
+
29
+ const instance: Item = {
30
+ id,
31
+ title,
32
+ body,
33
+ type,
34
+ icon,
35
+ actionTitle,
36
+ action,
37
+ data,
38
+ sender,
39
+ company,
40
+ createdAt,
41
+ updatedAt,
42
+ readAt,
43
+ sourceAppUuid,
44
+ appLogo,
45
+ };
46
+ ```
47
+
48
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # NotificationInboxDTO
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **notifications** | [**Array&lt;Item&gt;**](Item.md) | | [optional] [default to undefined]
9
+ **unreadCount** | **number** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { NotificationInboxDTO } from '@caraer/client';
15
+
16
+ const instance: NotificationInboxDTO = {
17
+ notifications,
18
+ unreadCount,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -5,6 +5,7 @@ All URIs are relative to *https://v2.api.caraer.com*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**dismissNotification**](#dismissnotification) | **DELETE** /api/v2/notifications/{notificationId} | Dismiss a notification|
8
+ |[**listNotifications**](#listnotifications) | **GET** /api/v2/notifications | List in-app notifications for the logged-in user|
8
9
  |[**markAllAsRead**](#markallasread) | **PATCH** /api/v2/notifications/read-all | Mark all notifications as read for the current company|
9
10
  |[**markAsRead**](#markasread) | **PATCH** /api/v2/notifications/{notificationId}/read | Mark a notification as read|
10
11
  |[**sendNotification**](#sendnotification) | **POST** /api/v2/notifications | Send a notification (app token)|
@@ -63,6 +64,63 @@ const { status, data } = await apiInstance.dismissNotification(
63
64
 
64
65
  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
65
66
 
67
+ # **listNotifications**
68
+ > ShowResponseNotificationInboxDTO listNotifications()
69
+
70
+
71
+ ### Example
72
+
73
+ ```typescript
74
+ import {
75
+ NotificationsApi,
76
+ Configuration
77
+ } from '@caraer/client';
78
+
79
+ const configuration = new Configuration();
80
+ const apiInstance = new NotificationsApi(configuration);
81
+
82
+ let company: string; // (optional) (default to undefined)
83
+ let limit: number; // (optional) (default to undefined)
84
+
85
+ const { status, data } = await apiInstance.listNotifications(
86
+ company,
87
+ limit
88
+ );
89
+ ```
90
+
91
+ ### Parameters
92
+
93
+ |Name | Type | Description | Notes|
94
+ |------------- | ------------- | ------------- | -------------|
95
+ | **company** | [**string**] | | (optional) defaults to undefined|
96
+ | **limit** | [**number**] | | (optional) defaults to undefined|
97
+
98
+
99
+ ### Return type
100
+
101
+ **ShowResponseNotificationInboxDTO**
102
+
103
+ ### Authorization
104
+
105
+ [bearerAuth](../README.md#bearerAuth)
106
+
107
+ ### HTTP request headers
108
+
109
+ - **Content-Type**: Not defined
110
+ - **Accept**: application/json
111
+
112
+
113
+ ### HTTP response details
114
+ | Status code | Description | Response headers |
115
+ |-------------|-------------|------------------|
116
+ |**200** | OK | - |
117
+ |**401** | Authentication is required or the token is invalid. | - |
118
+ |**403** | The caller is missing a required role or scope. | - |
119
+ |**404** | The requested resource was not found. | - |
120
+ |**500** | An internal server error occurred. | - |
121
+
122
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
123
+
66
124
  # **markAllAsRead**
67
125
  > SuccessResponseString markAllAsRead()
68
126
 
@@ -0,0 +1,23 @@
1
+ # ShowResponseNotificationInboxDTO
2
+
3
+ Represents the response for viewing or showing a specific resource.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
10
+ **data** | [**NotificationInboxDTO**](NotificationInboxDTO.md) | The data payload of the response, if any. | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { ShowResponseNotificationInboxDTO } from '@caraer/client';
16
+
17
+ const instance: ShowResponseNotificationInboxDTO = {
18
+ message,
19
+ data,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caraer/client",
3
- "version": "2.0.455",
3
+ "version": "2.0.456",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {