@caraer/client 2.0.455 → 2.0.457

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
@@ -2215,8 +2215,8 @@ export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof t
2215
2215
 
2216
2216
  export interface ExistingWidgetSummary {
2217
2217
  'ymetric'?: string;
2218
- 'yproperty'?: string;
2219
2218
  'xproperty'?: string;
2219
+ 'yproperty'?: string;
2220
2220
  'title'?: string;
2221
2221
  'chartType'?: string;
2222
2222
  'xProperty'?: string;
@@ -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 {
@@ -5474,11 +5495,30 @@ export interface ShowResponseMapStringObject {
5474
5495
  'data'?: { [key: string]: any | null; };
5475
5496
  }
5476
5497
  /**
5477
- * Success response (ShowResponseMapStringString).
5498
+ * Represents the response for viewing or showing a specific resource.
5478
5499
  */
5479
5500
  export interface ShowResponseMapStringString {
5501
+ /**
5502
+ * A message detailing the result of the operation.
5503
+ */
5480
5504
  'message'?: string;
5481
- 'data'?: { [key: string]: any; };
5505
+ /**
5506
+ * The data payload of the response, if any.
5507
+ */
5508
+ 'data'?: { [key: string]: string; };
5509
+ }
5510
+ /**
5511
+ * Represents the response for viewing or showing a specific resource.
5512
+ */
5513
+ export interface ShowResponseNotificationInboxDTO {
5514
+ /**
5515
+ * A message detailing the result of the operation.
5516
+ */
5517
+ 'message'?: string;
5518
+ /**
5519
+ * The data payload of the response, if any.
5520
+ */
5521
+ 'data'?: NotificationInboxDTO;
5482
5522
  }
5483
5523
  /**
5484
5524
  * Represents the response for viewing or showing a specific resource.
@@ -16362,6 +16402,84 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
16362
16402
  options: localVarRequestOptions,
16363
16403
  };
16364
16404
  },
16405
+ /**
16406
+ *
16407
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
16408
+ * @param {*} [options] Override http request option.
16409
+ * @throws {RequiredError}
16410
+ */
16411
+ firebaseToken: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
16412
+ const localVarPath = `/api/v2/notifications/firebase-token`;
16413
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
16414
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
16415
+ let baseOptions;
16416
+ if (configuration) {
16417
+ baseOptions = configuration.baseOptions;
16418
+ }
16419
+
16420
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
16421
+ const localVarHeaderParameter = {} as any;
16422
+ const localVarQueryParameter = {} as any;
16423
+
16424
+ // authentication bearerAuth required
16425
+ // http bearer authentication required
16426
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
16427
+
16428
+ localVarHeaderParameter['Accept'] = 'application/json';
16429
+
16430
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
16431
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16432
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
16433
+
16434
+ return {
16435
+ url: toPathString(localVarUrlObj),
16436
+ options: localVarRequestOptions,
16437
+ };
16438
+ },
16439
+ /**
16440
+ *
16441
+ * @summary List in-app notifications for the logged-in user
16442
+ * @param {string} [company]
16443
+ * @param {number} [limit]
16444
+ * @param {*} [options] Override http request option.
16445
+ * @throws {RequiredError}
16446
+ */
16447
+ listNotifications: async (company?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
16448
+ const localVarPath = `/api/v2/notifications`;
16449
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
16450
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
16451
+ let baseOptions;
16452
+ if (configuration) {
16453
+ baseOptions = configuration.baseOptions;
16454
+ }
16455
+
16456
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
16457
+ const localVarHeaderParameter = {} as any;
16458
+ const localVarQueryParameter = {} as any;
16459
+
16460
+ // authentication bearerAuth required
16461
+ // http bearer authentication required
16462
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
16463
+
16464
+ if (company !== undefined) {
16465
+ localVarQueryParameter['company'] = company;
16466
+ }
16467
+
16468
+ if (limit !== undefined) {
16469
+ localVarQueryParameter['limit'] = limit;
16470
+ }
16471
+
16472
+ localVarHeaderParameter['Accept'] = 'application/json';
16473
+
16474
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
16475
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
16476
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
16477
+
16478
+ return {
16479
+ url: toPathString(localVarUrlObj),
16480
+ options: localVarRequestOptions,
16481
+ };
16482
+ },
16365
16483
  /**
16366
16484
  *
16367
16485
  * @summary Mark all notifications as read for the current company
@@ -16495,6 +16613,32 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
16495
16613
  const localVarOperationServerBasePath = operationServerMap['NotificationsApi.dismissNotification']?.[localVarOperationServerIndex]?.url;
16496
16614
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16497
16615
  },
16616
+ /**
16617
+ *
16618
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
16619
+ * @param {*} [options] Override http request option.
16620
+ * @throws {RequiredError}
16621
+ */
16622
+ async firebaseToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>> {
16623
+ const localVarAxiosArgs = await localVarAxiosParamCreator.firebaseToken(options);
16624
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
16625
+ const localVarOperationServerBasePath = operationServerMap['NotificationsApi.firebaseToken']?.[localVarOperationServerIndex]?.url;
16626
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16627
+ },
16628
+ /**
16629
+ *
16630
+ * @summary List in-app notifications for the logged-in user
16631
+ * @param {string} [company]
16632
+ * @param {number} [limit]
16633
+ * @param {*} [options] Override http request option.
16634
+ * @throws {RequiredError}
16635
+ */
16636
+ async listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseNotificationInboxDTO>> {
16637
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listNotifications(company, limit, options);
16638
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
16639
+ const localVarOperationServerBasePath = operationServerMap['NotificationsApi.listNotifications']?.[localVarOperationServerIndex]?.url;
16640
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16641
+ },
16498
16642
  /**
16499
16643
  *
16500
16644
  * @summary Mark all notifications as read for the current company
@@ -16552,6 +16696,26 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
16552
16696
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponseString> {
16553
16697
  return localVarFp.dismissNotification(notificationId, options).then((request) => request(axios, basePath));
16554
16698
  },
16699
+ /**
16700
+ *
16701
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
16702
+ * @param {*} [options] Override http request option.
16703
+ * @throws {RequiredError}
16704
+ */
16705
+ firebaseToken(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString> {
16706
+ return localVarFp.firebaseToken(options).then((request) => request(axios, basePath));
16707
+ },
16708
+ /**
16709
+ *
16710
+ * @summary List in-app notifications for the logged-in user
16711
+ * @param {string} [company]
16712
+ * @param {number} [limit]
16713
+ * @param {*} [options] Override http request option.
16714
+ * @throws {RequiredError}
16715
+ */
16716
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseNotificationInboxDTO> {
16717
+ return localVarFp.listNotifications(company, limit, options).then((request) => request(axios, basePath));
16718
+ },
16555
16719
  /**
16556
16720
  *
16557
16721
  * @summary Mark all notifications as read for the current company
@@ -16599,6 +16763,28 @@ export class NotificationsApi extends BaseAPI {
16599
16763
  return NotificationsApiFp(this.configuration).dismissNotification(notificationId, options).then((request) => request(this.axios, this.basePath));
16600
16764
  }
16601
16765
 
16766
+ /**
16767
+ *
16768
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
16769
+ * @param {*} [options] Override http request option.
16770
+ * @throws {RequiredError}
16771
+ */
16772
+ public firebaseToken(options?: RawAxiosRequestConfig) {
16773
+ return NotificationsApiFp(this.configuration).firebaseToken(options).then((request) => request(this.axios, this.basePath));
16774
+ }
16775
+
16776
+ /**
16777
+ *
16778
+ * @summary List in-app notifications for the logged-in user
16779
+ * @param {string} [company]
16780
+ * @param {number} [limit]
16781
+ * @param {*} [options] Override http request option.
16782
+ * @throws {RequiredError}
16783
+ */
16784
+ public listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig) {
16785
+ return NotificationsApiFp(this.configuration).listNotifications(company, limit, options).then((request) => request(this.axios, this.basePath));
16786
+ }
16787
+
16602
16788
  /**
16603
16789
  *
16604
16790
  * @summary Mark all notifications as read for the current company
package/dist/api.d.ts CHANGED
@@ -2193,8 +2193,8 @@ export declare const EventRsvpRequestScopeEnum: {
2193
2193
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2194
2194
  export interface ExistingWidgetSummary {
2195
2195
  'ymetric'?: string;
2196
- 'yproperty'?: string;
2197
2196
  'xproperty'?: string;
2197
+ 'yproperty'?: string;
2198
2198
  'title'?: string;
2199
2199
  'chartType'?: string;
2200
2200
  'xProperty'?: string;
@@ -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 {
@@ -5529,14 +5552,33 @@ export interface ShowResponseMapStringObject {
5529
5552
  };
5530
5553
  }
5531
5554
  /**
5532
- * Success response (ShowResponseMapStringString).
5555
+ * Represents the response for viewing or showing a specific resource.
5533
5556
  */
5534
5557
  export interface ShowResponseMapStringString {
5558
+ /**
5559
+ * A message detailing the result of the operation.
5560
+ */
5535
5561
  'message'?: string;
5562
+ /**
5563
+ * The data payload of the response, if any.
5564
+ */
5536
5565
  'data'?: {
5537
- [key: string]: any;
5566
+ [key: string]: string;
5538
5567
  };
5539
5568
  }
5569
+ /**
5570
+ * Represents the response for viewing or showing a specific resource.
5571
+ */
5572
+ export interface ShowResponseNotificationInboxDTO {
5573
+ /**
5574
+ * A message detailing the result of the operation.
5575
+ */
5576
+ 'message'?: string;
5577
+ /**
5578
+ * The data payload of the response, if any.
5579
+ */
5580
+ 'data'?: NotificationInboxDTO;
5581
+ }
5540
5582
  /**
5541
5583
  * Represents the response for viewing or showing a specific resource.
5542
5584
  */
@@ -11642,6 +11684,22 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
11642
11684
  * @throws {RequiredError}
11643
11685
  */
11644
11686
  dismissNotification: (notificationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11687
+ /**
11688
+ *
11689
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
11690
+ * @param {*} [options] Override http request option.
11691
+ * @throws {RequiredError}
11692
+ */
11693
+ firebaseToken: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11694
+ /**
11695
+ *
11696
+ * @summary List in-app notifications for the logged-in user
11697
+ * @param {string} [company]
11698
+ * @param {number} [limit]
11699
+ * @param {*} [options] Override http request option.
11700
+ * @throws {RequiredError}
11701
+ */
11702
+ listNotifications: (company?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11645
11703
  /**
11646
11704
  *
11647
11705
  * @summary Mark all notifications as read for the current company
@@ -11678,6 +11736,22 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
11678
11736
  * @throws {RequiredError}
11679
11737
  */
11680
11738
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseString>>;
11739
+ /**
11740
+ *
11741
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
11742
+ * @param {*} [options] Override http request option.
11743
+ * @throws {RequiredError}
11744
+ */
11745
+ firebaseToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>>;
11746
+ /**
11747
+ *
11748
+ * @summary List in-app notifications for the logged-in user
11749
+ * @param {string} [company]
11750
+ * @param {number} [limit]
11751
+ * @param {*} [options] Override http request option.
11752
+ * @throws {RequiredError}
11753
+ */
11754
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseNotificationInboxDTO>>;
11681
11755
  /**
11682
11756
  *
11683
11757
  * @summary Mark all notifications as read for the current company
@@ -11714,6 +11788,22 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
11714
11788
  * @throws {RequiredError}
11715
11789
  */
11716
11790
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponseString>;
11791
+ /**
11792
+ *
11793
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
11794
+ * @param {*} [options] Override http request option.
11795
+ * @throws {RequiredError}
11796
+ */
11797
+ firebaseToken(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString>;
11798
+ /**
11799
+ *
11800
+ * @summary List in-app notifications for the logged-in user
11801
+ * @param {string} [company]
11802
+ * @param {number} [limit]
11803
+ * @param {*} [options] Override http request option.
11804
+ * @throws {RequiredError}
11805
+ */
11806
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseNotificationInboxDTO>;
11717
11807
  /**
11718
11808
  *
11719
11809
  * @summary Mark all notifications as read for the current company
@@ -11750,6 +11840,22 @@ export declare class NotificationsApi extends BaseAPI {
11750
11840
  * @throws {RequiredError}
11751
11841
  */
11752
11842
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseString, any, {}>>;
11843
+ /**
11844
+ *
11845
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
11846
+ * @param {*} [options] Override http request option.
11847
+ * @throws {RequiredError}
11848
+ */
11849
+ firebaseToken(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringString, any, {}>>;
11850
+ /**
11851
+ *
11852
+ * @summary List in-app notifications for the logged-in user
11853
+ * @param {string} [company]
11854
+ * @param {number} [limit]
11855
+ * @param {*} [options] Override http request option.
11856
+ * @throws {RequiredError}
11857
+ */
11858
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseNotificationInboxDTO, any, {}>>;
11753
11859
  /**
11754
11860
  *
11755
11861
  * @summary Mark all notifications as read for the current company
package/dist/api.js CHANGED
@@ -8704,6 +8704,72 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
8704
8704
  options: localVarRequestOptions,
8705
8705
  };
8706
8706
  }),
8707
+ /**
8708
+ *
8709
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
8710
+ * @param {*} [options] Override http request option.
8711
+ * @throws {RequiredError}
8712
+ */
8713
+ firebaseToken: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
8714
+ const localVarPath = `/api/v2/notifications/firebase-token`;
8715
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8716
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
8717
+ let baseOptions;
8718
+ if (configuration) {
8719
+ baseOptions = configuration.baseOptions;
8720
+ }
8721
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
8722
+ const localVarHeaderParameter = {};
8723
+ const localVarQueryParameter = {};
8724
+ // authentication bearerAuth required
8725
+ // http bearer authentication required
8726
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
8727
+ localVarHeaderParameter['Accept'] = 'application/json';
8728
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
8729
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8730
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
8731
+ return {
8732
+ url: (0, common_1.toPathString)(localVarUrlObj),
8733
+ options: localVarRequestOptions,
8734
+ };
8735
+ }),
8736
+ /**
8737
+ *
8738
+ * @summary List in-app notifications for the logged-in user
8739
+ * @param {string} [company]
8740
+ * @param {number} [limit]
8741
+ * @param {*} [options] Override http request option.
8742
+ * @throws {RequiredError}
8743
+ */
8744
+ listNotifications: (company_1, limit_1, ...args_1) => __awaiter(this, [company_1, limit_1, ...args_1], void 0, function* (company, limit, options = {}) {
8745
+ const localVarPath = `/api/v2/notifications`;
8746
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8747
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
8748
+ let baseOptions;
8749
+ if (configuration) {
8750
+ baseOptions = configuration.baseOptions;
8751
+ }
8752
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
8753
+ const localVarHeaderParameter = {};
8754
+ const localVarQueryParameter = {};
8755
+ // authentication bearerAuth required
8756
+ // http bearer authentication required
8757
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
8758
+ if (company !== undefined) {
8759
+ localVarQueryParameter['company'] = company;
8760
+ }
8761
+ if (limit !== undefined) {
8762
+ localVarQueryParameter['limit'] = limit;
8763
+ }
8764
+ localVarHeaderParameter['Accept'] = 'application/json';
8765
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
8766
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8767
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
8768
+ return {
8769
+ url: (0, common_1.toPathString)(localVarUrlObj),
8770
+ options: localVarRequestOptions,
8771
+ };
8772
+ }),
8707
8773
  /**
8708
8774
  *
8709
8775
  * @summary Mark all notifications as read for the current company
@@ -8825,6 +8891,38 @@ const NotificationsApiFp = function (configuration) {
8825
8891
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8826
8892
  });
8827
8893
  },
8894
+ /**
8895
+ *
8896
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
8897
+ * @param {*} [options] Override http request option.
8898
+ * @throws {RequiredError}
8899
+ */
8900
+ firebaseToken(options) {
8901
+ return __awaiter(this, void 0, void 0, function* () {
8902
+ var _a, _b, _c;
8903
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.firebaseToken(options);
8904
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
8905
+ const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['NotificationsApi.firebaseToken']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
8906
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8907
+ });
8908
+ },
8909
+ /**
8910
+ *
8911
+ * @summary List in-app notifications for the logged-in user
8912
+ * @param {string} [company]
8913
+ * @param {number} [limit]
8914
+ * @param {*} [options] Override http request option.
8915
+ * @throws {RequiredError}
8916
+ */
8917
+ listNotifications(company, limit, options) {
8918
+ return __awaiter(this, void 0, void 0, function* () {
8919
+ var _a, _b, _c;
8920
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listNotifications(company, limit, options);
8921
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
8922
+ 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;
8923
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8924
+ });
8925
+ },
8828
8926
  /**
8829
8927
  *
8830
8928
  * @summary Mark all notifications as read for the current company
@@ -8891,6 +8989,26 @@ const NotificationsApiFactory = function (configuration, basePath, axios) {
8891
8989
  dismissNotification(notificationId, options) {
8892
8990
  return localVarFp.dismissNotification(notificationId, options).then((request) => request(axios, basePath));
8893
8991
  },
8992
+ /**
8993
+ *
8994
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
8995
+ * @param {*} [options] Override http request option.
8996
+ * @throws {RequiredError}
8997
+ */
8998
+ firebaseToken(options) {
8999
+ return localVarFp.firebaseToken(options).then((request) => request(axios, basePath));
9000
+ },
9001
+ /**
9002
+ *
9003
+ * @summary List in-app notifications for the logged-in user
9004
+ * @param {string} [company]
9005
+ * @param {number} [limit]
9006
+ * @param {*} [options] Override http request option.
9007
+ * @throws {RequiredError}
9008
+ */
9009
+ listNotifications(company, limit, options) {
9010
+ return localVarFp.listNotifications(company, limit, options).then((request) => request(axios, basePath));
9011
+ },
8894
9012
  /**
8895
9013
  *
8896
9014
  * @summary Mark all notifications as read for the current company
@@ -8937,6 +9055,26 @@ class NotificationsApi extends base_1.BaseAPI {
8937
9055
  dismissNotification(notificationId, options) {
8938
9056
  return (0, exports.NotificationsApiFp)(this.configuration).dismissNotification(notificationId, options).then((request) => request(this.axios, this.basePath));
8939
9057
  }
9058
+ /**
9059
+ *
9060
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
9061
+ * @param {*} [options] Override http request option.
9062
+ * @throws {RequiredError}
9063
+ */
9064
+ firebaseToken(options) {
9065
+ return (0, exports.NotificationsApiFp)(this.configuration).firebaseToken(options).then((request) => request(this.axios, this.basePath));
9066
+ }
9067
+ /**
9068
+ *
9069
+ * @summary List in-app notifications for the logged-in user
9070
+ * @param {string} [company]
9071
+ * @param {number} [limit]
9072
+ * @param {*} [options] Override http request option.
9073
+ * @throws {RequiredError}
9074
+ */
9075
+ listNotifications(company, limit, options) {
9076
+ return (0, exports.NotificationsApiFp)(this.configuration).listNotifications(company, limit, options).then((request) => request(this.axios, this.basePath));
9077
+ }
8940
9078
  /**
8941
9079
  *
8942
9080
  * @summary Mark all notifications as read for the current company
package/dist/esm/api.d.ts CHANGED
@@ -2193,8 +2193,8 @@ export declare const EventRsvpRequestScopeEnum: {
2193
2193
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2194
2194
  export interface ExistingWidgetSummary {
2195
2195
  'ymetric'?: string;
2196
- 'yproperty'?: string;
2197
2196
  'xproperty'?: string;
2197
+ 'yproperty'?: string;
2198
2198
  'title'?: string;
2199
2199
  'chartType'?: string;
2200
2200
  'xProperty'?: string;
@@ -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 {
@@ -5529,14 +5552,33 @@ export interface ShowResponseMapStringObject {
5529
5552
  };
5530
5553
  }
5531
5554
  /**
5532
- * Success response (ShowResponseMapStringString).
5555
+ * Represents the response for viewing or showing a specific resource.
5533
5556
  */
5534
5557
  export interface ShowResponseMapStringString {
5558
+ /**
5559
+ * A message detailing the result of the operation.
5560
+ */
5535
5561
  'message'?: string;
5562
+ /**
5563
+ * The data payload of the response, if any.
5564
+ */
5536
5565
  'data'?: {
5537
- [key: string]: any;
5566
+ [key: string]: string;
5538
5567
  };
5539
5568
  }
5569
+ /**
5570
+ * Represents the response for viewing or showing a specific resource.
5571
+ */
5572
+ export interface ShowResponseNotificationInboxDTO {
5573
+ /**
5574
+ * A message detailing the result of the operation.
5575
+ */
5576
+ 'message'?: string;
5577
+ /**
5578
+ * The data payload of the response, if any.
5579
+ */
5580
+ 'data'?: NotificationInboxDTO;
5581
+ }
5540
5582
  /**
5541
5583
  * Represents the response for viewing or showing a specific resource.
5542
5584
  */
@@ -11642,6 +11684,22 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
11642
11684
  * @throws {RequiredError}
11643
11685
  */
11644
11686
  dismissNotification: (notificationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11687
+ /**
11688
+ *
11689
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
11690
+ * @param {*} [options] Override http request option.
11691
+ * @throws {RequiredError}
11692
+ */
11693
+ firebaseToken: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11694
+ /**
11695
+ *
11696
+ * @summary List in-app notifications for the logged-in user
11697
+ * @param {string} [company]
11698
+ * @param {number} [limit]
11699
+ * @param {*} [options] Override http request option.
11700
+ * @throws {RequiredError}
11701
+ */
11702
+ listNotifications: (company?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11645
11703
  /**
11646
11704
  *
11647
11705
  * @summary Mark all notifications as read for the current company
@@ -11678,6 +11736,22 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
11678
11736
  * @throws {RequiredError}
11679
11737
  */
11680
11738
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseString>>;
11739
+ /**
11740
+ *
11741
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
11742
+ * @param {*} [options] Override http request option.
11743
+ * @throws {RequiredError}
11744
+ */
11745
+ firebaseToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>>;
11746
+ /**
11747
+ *
11748
+ * @summary List in-app notifications for the logged-in user
11749
+ * @param {string} [company]
11750
+ * @param {number} [limit]
11751
+ * @param {*} [options] Override http request option.
11752
+ * @throws {RequiredError}
11753
+ */
11754
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseNotificationInboxDTO>>;
11681
11755
  /**
11682
11756
  *
11683
11757
  * @summary Mark all notifications as read for the current company
@@ -11714,6 +11788,22 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
11714
11788
  * @throws {RequiredError}
11715
11789
  */
11716
11790
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponseString>;
11791
+ /**
11792
+ *
11793
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
11794
+ * @param {*} [options] Override http request option.
11795
+ * @throws {RequiredError}
11796
+ */
11797
+ firebaseToken(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString>;
11798
+ /**
11799
+ *
11800
+ * @summary List in-app notifications for the logged-in user
11801
+ * @param {string} [company]
11802
+ * @param {number} [limit]
11803
+ * @param {*} [options] Override http request option.
11804
+ * @throws {RequiredError}
11805
+ */
11806
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseNotificationInboxDTO>;
11717
11807
  /**
11718
11808
  *
11719
11809
  * @summary Mark all notifications as read for the current company
@@ -11750,6 +11840,22 @@ export declare class NotificationsApi extends BaseAPI {
11750
11840
  * @throws {RequiredError}
11751
11841
  */
11752
11842
  dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseString, any, {}>>;
11843
+ /**
11844
+ *
11845
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
11846
+ * @param {*} [options] Override http request option.
11847
+ * @throws {RequiredError}
11848
+ */
11849
+ firebaseToken(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringString, any, {}>>;
11850
+ /**
11851
+ *
11852
+ * @summary List in-app notifications for the logged-in user
11853
+ * @param {string} [company]
11854
+ * @param {number} [limit]
11855
+ * @param {*} [options] Override http request option.
11856
+ * @throws {RequiredError}
11857
+ */
11858
+ listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseNotificationInboxDTO, any, {}>>;
11753
11859
  /**
11754
11860
  *
11755
11861
  * @summary Mark all notifications as read for the current company
package/dist/esm/api.js CHANGED
@@ -8643,6 +8643,72 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
8643
8643
  options: localVarRequestOptions,
8644
8644
  };
8645
8645
  }),
8646
+ /**
8647
+ *
8648
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
8649
+ * @param {*} [options] Override http request option.
8650
+ * @throws {RequiredError}
8651
+ */
8652
+ firebaseToken: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
8653
+ const localVarPath = `/api/v2/notifications/firebase-token`;
8654
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8655
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8656
+ let baseOptions;
8657
+ if (configuration) {
8658
+ baseOptions = configuration.baseOptions;
8659
+ }
8660
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
8661
+ const localVarHeaderParameter = {};
8662
+ const localVarQueryParameter = {};
8663
+ // authentication bearerAuth required
8664
+ // http bearer authentication required
8665
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
8666
+ localVarHeaderParameter['Accept'] = 'application/json';
8667
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
8668
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8669
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
8670
+ return {
8671
+ url: toPathString(localVarUrlObj),
8672
+ options: localVarRequestOptions,
8673
+ };
8674
+ }),
8675
+ /**
8676
+ *
8677
+ * @summary List in-app notifications for the logged-in user
8678
+ * @param {string} [company]
8679
+ * @param {number} [limit]
8680
+ * @param {*} [options] Override http request option.
8681
+ * @throws {RequiredError}
8682
+ */
8683
+ listNotifications: (company_1, limit_1, ...args_1) => __awaiter(this, [company_1, limit_1, ...args_1], void 0, function* (company, limit, options = {}) {
8684
+ const localVarPath = `/api/v2/notifications`;
8685
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
8686
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
8687
+ let baseOptions;
8688
+ if (configuration) {
8689
+ baseOptions = configuration.baseOptions;
8690
+ }
8691
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
8692
+ const localVarHeaderParameter = {};
8693
+ const localVarQueryParameter = {};
8694
+ // authentication bearerAuth required
8695
+ // http bearer authentication required
8696
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
8697
+ if (company !== undefined) {
8698
+ localVarQueryParameter['company'] = company;
8699
+ }
8700
+ if (limit !== undefined) {
8701
+ localVarQueryParameter['limit'] = limit;
8702
+ }
8703
+ localVarHeaderParameter['Accept'] = 'application/json';
8704
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
8705
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
8706
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
8707
+ return {
8708
+ url: toPathString(localVarUrlObj),
8709
+ options: localVarRequestOptions,
8710
+ };
8711
+ }),
8646
8712
  /**
8647
8713
  *
8648
8714
  * @summary Mark all notifications as read for the current company
@@ -8763,6 +8829,38 @@ export const NotificationsApiFp = function (configuration) {
8763
8829
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8764
8830
  });
8765
8831
  },
8832
+ /**
8833
+ *
8834
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
8835
+ * @param {*} [options] Override http request option.
8836
+ * @throws {RequiredError}
8837
+ */
8838
+ firebaseToken(options) {
8839
+ return __awaiter(this, void 0, void 0, function* () {
8840
+ var _a, _b, _c;
8841
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.firebaseToken(options);
8842
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
8843
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NotificationsApi.firebaseToken']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
8844
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8845
+ });
8846
+ },
8847
+ /**
8848
+ *
8849
+ * @summary List in-app notifications for the logged-in user
8850
+ * @param {string} [company]
8851
+ * @param {number} [limit]
8852
+ * @param {*} [options] Override http request option.
8853
+ * @throws {RequiredError}
8854
+ */
8855
+ listNotifications(company, limit, options) {
8856
+ return __awaiter(this, void 0, void 0, function* () {
8857
+ var _a, _b, _c;
8858
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listNotifications(company, limit, options);
8859
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
8860
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NotificationsApi.listNotifications']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
8861
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
8862
+ });
8863
+ },
8766
8864
  /**
8767
8865
  *
8768
8866
  * @summary Mark all notifications as read for the current company
@@ -8828,6 +8926,26 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
8828
8926
  dismissNotification(notificationId, options) {
8829
8927
  return localVarFp.dismissNotification(notificationId, options).then((request) => request(axios, basePath));
8830
8928
  },
8929
+ /**
8930
+ *
8931
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
8932
+ * @param {*} [options] Override http request option.
8933
+ * @throws {RequiredError}
8934
+ */
8935
+ firebaseToken(options) {
8936
+ return localVarFp.firebaseToken(options).then((request) => request(axios, basePath));
8937
+ },
8938
+ /**
8939
+ *
8940
+ * @summary List in-app notifications for the logged-in user
8941
+ * @param {string} [company]
8942
+ * @param {number} [limit]
8943
+ * @param {*} [options] Override http request option.
8944
+ * @throws {RequiredError}
8945
+ */
8946
+ listNotifications(company, limit, options) {
8947
+ return localVarFp.listNotifications(company, limit, options).then((request) => request(axios, basePath));
8948
+ },
8831
8949
  /**
8832
8950
  *
8833
8951
  * @summary Mark all notifications as read for the current company
@@ -8873,6 +8991,26 @@ export class NotificationsApi extends BaseAPI {
8873
8991
  dismissNotification(notificationId, options) {
8874
8992
  return NotificationsApiFp(this.configuration).dismissNotification(notificationId, options).then((request) => request(this.axios, this.basePath));
8875
8993
  }
8994
+ /**
8995
+ *
8996
+ * @summary Mint a Firebase custom token so the app can listen to its inbox
8997
+ * @param {*} [options] Override http request option.
8998
+ * @throws {RequiredError}
8999
+ */
9000
+ firebaseToken(options) {
9001
+ return NotificationsApiFp(this.configuration).firebaseToken(options).then((request) => request(this.axios, this.basePath));
9002
+ }
9003
+ /**
9004
+ *
9005
+ * @summary List in-app notifications for the logged-in user
9006
+ * @param {string} [company]
9007
+ * @param {number} [limit]
9008
+ * @param {*} [options] Override http request option.
9009
+ * @throws {RequiredError}
9010
+ */
9011
+ listNotifications(company, limit, options) {
9012
+ return NotificationsApiFp(this.configuration).listNotifications(company, limit, options).then((request) => request(this.axios, this.basePath));
9013
+ }
8876
9014
  /**
8877
9015
  *
8878
9016
  * @summary Mark all notifications as read for the current company
@@ -6,8 +6,8 @@
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **ymetric** | **string** | | [optional] [default to undefined]
9
- **yproperty** | **string** | | [optional] [default to undefined]
10
9
  **xproperty** | **string** | | [optional] [default to undefined]
10
+ **yproperty** | **string** | | [optional] [default to undefined]
11
11
  **title** | **string** | | [optional] [default to undefined]
12
12
  **chartType** | **string** | | [optional] [default to undefined]
13
13
  **xProperty** | **string** | | [optional] [default to undefined]
@@ -21,8 +21,8 @@ import { ExistingWidgetSummary } from '@caraer/client';
21
21
 
22
22
  const instance: ExistingWidgetSummary = {
23
23
  ymetric,
24
- yproperty,
25
24
  xproperty,
25
+ yproperty,
26
26
  title,
27
27
  chartType,
28
28
  xProperty,
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,8 @@ 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
+ |[**firebaseToken**](#firebasetoken) | **GET** /api/v2/notifications/firebase-token | Mint a Firebase custom token so the app can listen to its inbox|
9
+ |[**listNotifications**](#listnotifications) | **GET** /api/v2/notifications | List in-app notifications for the logged-in user|
8
10
  |[**markAllAsRead**](#markallasread) | **PATCH** /api/v2/notifications/read-all | Mark all notifications as read for the current company|
9
11
  |[**markAsRead**](#markasread) | **PATCH** /api/v2/notifications/{notificationId}/read | Mark a notification as read|
10
12
  |[**sendNotification**](#sendnotification) | **POST** /api/v2/notifications | Send a notification (app token)|
@@ -63,6 +65,110 @@ const { status, data } = await apiInstance.dismissNotification(
63
65
 
64
66
  [[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
67
 
68
+ # **firebaseToken**
69
+ > ShowResponseMapStringString firebaseToken()
70
+
71
+
72
+ ### Example
73
+
74
+ ```typescript
75
+ import {
76
+ NotificationsApi,
77
+ Configuration
78
+ } from '@caraer/client';
79
+
80
+ const configuration = new Configuration();
81
+ const apiInstance = new NotificationsApi(configuration);
82
+
83
+ const { status, data } = await apiInstance.firebaseToken();
84
+ ```
85
+
86
+ ### Parameters
87
+ This endpoint does not have any parameters.
88
+
89
+
90
+ ### Return type
91
+
92
+ **ShowResponseMapStringString**
93
+
94
+ ### Authorization
95
+
96
+ [bearerAuth](../README.md#bearerAuth)
97
+
98
+ ### HTTP request headers
99
+
100
+ - **Content-Type**: Not defined
101
+ - **Accept**: application/json
102
+
103
+
104
+ ### HTTP response details
105
+ | Status code | Description | Response headers |
106
+ |-------------|-------------|------------------|
107
+ |**200** | OK | - |
108
+ |**401** | Authentication is required or the token is invalid. | - |
109
+ |**403** | The caller is missing a required role or scope. | - |
110
+ |**404** | The requested resource was not found. | - |
111
+ |**500** | An internal server error occurred. | - |
112
+
113
+ [[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)
114
+
115
+ # **listNotifications**
116
+ > ShowResponseNotificationInboxDTO listNotifications()
117
+
118
+
119
+ ### Example
120
+
121
+ ```typescript
122
+ import {
123
+ NotificationsApi,
124
+ Configuration
125
+ } from '@caraer/client';
126
+
127
+ const configuration = new Configuration();
128
+ const apiInstance = new NotificationsApi(configuration);
129
+
130
+ let company: string; // (optional) (default to undefined)
131
+ let limit: number; // (optional) (default to undefined)
132
+
133
+ const { status, data } = await apiInstance.listNotifications(
134
+ company,
135
+ limit
136
+ );
137
+ ```
138
+
139
+ ### Parameters
140
+
141
+ |Name | Type | Description | Notes|
142
+ |------------- | ------------- | ------------- | -------------|
143
+ | **company** | [**string**] | | (optional) defaults to undefined|
144
+ | **limit** | [**number**] | | (optional) defaults to undefined|
145
+
146
+
147
+ ### Return type
148
+
149
+ **ShowResponseNotificationInboxDTO**
150
+
151
+ ### Authorization
152
+
153
+ [bearerAuth](../README.md#bearerAuth)
154
+
155
+ ### HTTP request headers
156
+
157
+ - **Content-Type**: Not defined
158
+ - **Accept**: application/json
159
+
160
+
161
+ ### HTTP response details
162
+ | Status code | Description | Response headers |
163
+ |-------------|-------------|------------------|
164
+ |**200** | OK | - |
165
+ |**401** | Authentication is required or the token is invalid. | - |
166
+ |**403** | The caller is missing a required role or scope. | - |
167
+ |**404** | The requested resource was not found. | - |
168
+ |**500** | An internal server error occurred. | - |
169
+
170
+ [[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)
171
+
66
172
  # **markAllAsRead**
67
173
  > SuccessResponseString markAllAsRead()
68
174
 
@@ -1,13 +1,13 @@
1
1
  # ShowResponseMapStringString
2
2
 
3
- Success response (ShowResponseMapStringString).
3
+ Represents the response for viewing or showing a specific resource.
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **message** | **string** | | [optional] [default to undefined]
10
- **data** | **{ [key: string]: any; }** | | [optional] [default to undefined]
9
+ **message** | **string** | A message detailing the result of the operation. | [optional] [default to undefined]
10
+ **data** | **{ [key: string]: string; }** | The data payload of the response, if any. | [optional] [default to undefined]
11
11
 
12
12
  ## Example
13
13
 
@@ -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.457",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {