@caraer/client 2.0.459 → 2.0.460

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.
package/api.ts CHANGED
@@ -2214,8 +2214,8 @@ export const EventRsvpRequestScopeEnum = {
2214
2214
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2215
2215
 
2216
2216
  export interface ExistingWidgetSummary {
2217
- 'yproperty'?: string;
2218
2217
  'xproperty'?: string;
2218
+ 'yproperty'?: string;
2219
2219
  'ymetric'?: string;
2220
2220
  'title'?: string;
2221
2221
  'chartType'?: string;
@@ -2811,6 +2811,7 @@ export interface Item {
2811
2811
  'data'?: { [key: string]: any | null; };
2812
2812
  'sender'?: string;
2813
2813
  'company'?: string;
2814
+ 'targetUserUuid'?: string;
2814
2815
  'createdAt'?: string;
2815
2816
  'updatedAt'?: string;
2816
2817
  'readAt'?: string;
@@ -5075,13 +5076,13 @@ export interface SearchRequest {
5075
5076
  'preview'?: string;
5076
5077
  }
5077
5078
  /**
5078
- * Request body for sending an in-app notification to a user
5079
+ * Request body for sending an in-app notification in a company
5079
5080
  */
5080
5081
  export interface SendNotificationRequest {
5081
5082
  /**
5082
- * UUID of the user who should receive the notification
5083
+ * Optional. Aim this notification at one user in the company. Omit to notify every user who has access to the company.
5083
5084
  */
5084
- 'targetUserUuid': string;
5085
+ 'targetUserUuid'?: string;
5085
5086
  /**
5086
5087
  * Notification title
5087
5088
  */
@@ -16437,7 +16438,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
16437
16438
  };
16438
16439
  },
16439
16440
  /**
16440
- *
16441
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
16441
16442
  * @summary List in-app notifications for the logged-in user
16442
16443
  * @param {string} [company]
16443
16444
  * @param {number} [limit]
@@ -16553,7 +16554,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
16553
16554
  };
16554
16555
  },
16555
16556
  /**
16556
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
16557
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
16557
16558
  * @summary Send a notification (app token)
16558
16559
  * @param {SendNotificationRequest} sendNotificationRequest
16559
16560
  * @param {*} [options] Override http request option.
@@ -16626,7 +16627,7 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
16626
16627
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16627
16628
  },
16628
16629
  /**
16629
- *
16630
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
16630
16631
  * @summary List in-app notifications for the logged-in user
16631
16632
  * @param {string} [company]
16632
16633
  * @param {number} [limit]
@@ -16665,7 +16666,7 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
16665
16666
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
16666
16667
  },
16667
16668
  /**
16668
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
16669
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
16669
16670
  * @summary Send a notification (app token)
16670
16671
  * @param {SendNotificationRequest} sendNotificationRequest
16671
16672
  * @param {*} [options] Override http request option.
@@ -16706,7 +16707,7 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
16706
16707
  return localVarFp.firebaseToken(options).then((request) => request(axios, basePath));
16707
16708
  },
16708
16709
  /**
16709
- *
16710
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
16710
16711
  * @summary List in-app notifications for the logged-in user
16711
16712
  * @param {string} [company]
16712
16713
  * @param {number} [limit]
@@ -16736,7 +16737,7 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
16736
16737
  return localVarFp.markAsRead(notificationId, options).then((request) => request(axios, basePath));
16737
16738
  },
16738
16739
  /**
16739
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
16740
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
16740
16741
  * @summary Send a notification (app token)
16741
16742
  * @param {SendNotificationRequest} sendNotificationRequest
16742
16743
  * @param {*} [options] Override http request option.
@@ -16774,7 +16775,7 @@ export class NotificationsApi extends BaseAPI {
16774
16775
  }
16775
16776
 
16776
16777
  /**
16777
- *
16778
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
16778
16779
  * @summary List in-app notifications for the logged-in user
16779
16780
  * @param {string} [company]
16780
16781
  * @param {number} [limit]
@@ -16807,7 +16808,7 @@ export class NotificationsApi extends BaseAPI {
16807
16808
  }
16808
16809
 
16809
16810
  /**
16810
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
16811
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
16811
16812
  * @summary Send a notification (app token)
16812
16813
  * @param {SendNotificationRequest} sendNotificationRequest
16813
16814
  * @param {*} [options] Override http request option.
package/dist/api.d.ts CHANGED
@@ -2192,8 +2192,8 @@ export declare const EventRsvpRequestScopeEnum: {
2192
2192
  };
2193
2193
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2194
2194
  export interface ExistingWidgetSummary {
2195
- 'yproperty'?: string;
2196
2195
  'xproperty'?: string;
2196
+ 'yproperty'?: string;
2197
2197
  'ymetric'?: string;
2198
2198
  'title'?: string;
2199
2199
  'chartType'?: string;
@@ -2805,6 +2805,7 @@ export interface Item {
2805
2805
  };
2806
2806
  'sender'?: string;
2807
2807
  'company'?: string;
2808
+ 'targetUserUuid'?: string;
2808
2809
  'createdAt'?: string;
2809
2810
  'updatedAt'?: string;
2810
2811
  'readAt'?: string;
@@ -5103,13 +5104,13 @@ export interface SearchRequest {
5103
5104
  'preview'?: string;
5104
5105
  }
5105
5106
  /**
5106
- * Request body for sending an in-app notification to a user
5107
+ * Request body for sending an in-app notification in a company
5107
5108
  */
5108
5109
  export interface SendNotificationRequest {
5109
5110
  /**
5110
- * UUID of the user who should receive the notification
5111
+ * Optional. Aim this notification at one user in the company. Omit to notify every user who has access to the company.
5111
5112
  */
5112
- 'targetUserUuid': string;
5113
+ 'targetUserUuid'?: string;
5113
5114
  /**
5114
5115
  * Notification title
5115
5116
  */
@@ -11692,7 +11693,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
11692
11693
  */
11693
11694
  firebaseToken: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11694
11695
  /**
11695
- *
11696
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
11696
11697
  * @summary List in-app notifications for the logged-in user
11697
11698
  * @param {string} [company]
11698
11699
  * @param {number} [limit]
@@ -11716,7 +11717,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
11716
11717
  */
11717
11718
  markAsRead: (notificationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11718
11719
  /**
11719
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
11720
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
11720
11721
  * @summary Send a notification (app token)
11721
11722
  * @param {SendNotificationRequest} sendNotificationRequest
11722
11723
  * @param {*} [options] Override http request option.
@@ -11744,7 +11745,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
11744
11745
  */
11745
11746
  firebaseToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>>;
11746
11747
  /**
11747
- *
11748
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
11748
11749
  * @summary List in-app notifications for the logged-in user
11749
11750
  * @param {string} [company]
11750
11751
  * @param {number} [limit]
@@ -11768,7 +11769,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
11768
11769
  */
11769
11770
  markAsRead(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
11770
11771
  /**
11771
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
11772
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
11772
11773
  * @summary Send a notification (app token)
11773
11774
  * @param {SendNotificationRequest} sendNotificationRequest
11774
11775
  * @param {*} [options] Override http request option.
@@ -11796,7 +11797,7 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
11796
11797
  */
11797
11798
  firebaseToken(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString>;
11798
11799
  /**
11799
- *
11800
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
11800
11801
  * @summary List in-app notifications for the logged-in user
11801
11802
  * @param {string} [company]
11802
11803
  * @param {number} [limit]
@@ -11820,7 +11821,7 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
11820
11821
  */
11821
11822
  markAsRead(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
11822
11823
  /**
11823
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
11824
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
11824
11825
  * @summary Send a notification (app token)
11825
11826
  * @param {SendNotificationRequest} sendNotificationRequest
11826
11827
  * @param {*} [options] Override http request option.
@@ -11848,7 +11849,7 @@ export declare class NotificationsApi extends BaseAPI {
11848
11849
  */
11849
11850
  firebaseToken(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringString, any, {}>>;
11850
11851
  /**
11851
- *
11852
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
11852
11853
  * @summary List in-app notifications for the logged-in user
11853
11854
  * @param {string} [company]
11854
11855
  * @param {number} [limit]
@@ -11872,7 +11873,7 @@ export declare class NotificationsApi extends BaseAPI {
11872
11873
  */
11873
11874
  markAsRead(notificationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseString, any, {}>>;
11874
11875
  /**
11875
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
11876
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
11876
11877
  * @summary Send a notification (app token)
11877
11878
  * @param {SendNotificationRequest} sendNotificationRequest
11878
11879
  * @param {*} [options] Override http request option.
package/dist/api.js CHANGED
@@ -8734,7 +8734,7 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
8734
8734
  };
8735
8735
  }),
8736
8736
  /**
8737
- *
8737
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
8738
8738
  * @summary List in-app notifications for the logged-in user
8739
8739
  * @param {string} [company]
8740
8740
  * @param {number} [limit]
@@ -8833,7 +8833,7 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
8833
8833
  };
8834
8834
  }),
8835
8835
  /**
8836
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
8836
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
8837
8837
  * @summary Send a notification (app token)
8838
8838
  * @param {SendNotificationRequest} sendNotificationRequest
8839
8839
  * @param {*} [options] Override http request option.
@@ -8907,7 +8907,7 @@ const NotificationsApiFp = function (configuration) {
8907
8907
  });
8908
8908
  },
8909
8909
  /**
8910
- *
8910
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
8911
8911
  * @summary List in-app notifications for the logged-in user
8912
8912
  * @param {string} [company]
8913
8913
  * @param {number} [limit]
@@ -8955,7 +8955,7 @@ const NotificationsApiFp = function (configuration) {
8955
8955
  });
8956
8956
  },
8957
8957
  /**
8958
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
8958
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
8959
8959
  * @summary Send a notification (app token)
8960
8960
  * @param {SendNotificationRequest} sendNotificationRequest
8961
8961
  * @param {*} [options] Override http request option.
@@ -8999,7 +8999,7 @@ const NotificationsApiFactory = function (configuration, basePath, axios) {
8999
8999
  return localVarFp.firebaseToken(options).then((request) => request(axios, basePath));
9000
9000
  },
9001
9001
  /**
9002
- *
9002
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
9003
9003
  * @summary List in-app notifications for the logged-in user
9004
9004
  * @param {string} [company]
9005
9005
  * @param {number} [limit]
@@ -9029,7 +9029,7 @@ const NotificationsApiFactory = function (configuration, basePath, axios) {
9029
9029
  return localVarFp.markAsRead(notificationId, options).then((request) => request(axios, basePath));
9030
9030
  },
9031
9031
  /**
9032
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
9032
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
9033
9033
  * @summary Send a notification (app token)
9034
9034
  * @param {SendNotificationRequest} sendNotificationRequest
9035
9035
  * @param {*} [options] Override http request option.
@@ -9065,7 +9065,7 @@ class NotificationsApi extends base_1.BaseAPI {
9065
9065
  return (0, exports.NotificationsApiFp)(this.configuration).firebaseToken(options).then((request) => request(this.axios, this.basePath));
9066
9066
  }
9067
9067
  /**
9068
- *
9068
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
9069
9069
  * @summary List in-app notifications for the logged-in user
9070
9070
  * @param {string} [company]
9071
9071
  * @param {number} [limit]
@@ -9095,7 +9095,7 @@ class NotificationsApi extends base_1.BaseAPI {
9095
9095
  return (0, exports.NotificationsApiFp)(this.configuration).markAsRead(notificationId, options).then((request) => request(this.axios, this.basePath));
9096
9096
  }
9097
9097
  /**
9098
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
9098
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
9099
9099
  * @summary Send a notification (app token)
9100
9100
  * @param {SendNotificationRequest} sendNotificationRequest
9101
9101
  * @param {*} [options] Override http request option.
package/dist/esm/api.d.ts CHANGED
@@ -2192,8 +2192,8 @@ export declare const EventRsvpRequestScopeEnum: {
2192
2192
  };
2193
2193
  export type EventRsvpRequestScopeEnum = typeof EventRsvpRequestScopeEnum[keyof typeof EventRsvpRequestScopeEnum];
2194
2194
  export interface ExistingWidgetSummary {
2195
- 'yproperty'?: string;
2196
2195
  'xproperty'?: string;
2196
+ 'yproperty'?: string;
2197
2197
  'ymetric'?: string;
2198
2198
  'title'?: string;
2199
2199
  'chartType'?: string;
@@ -2805,6 +2805,7 @@ export interface Item {
2805
2805
  };
2806
2806
  'sender'?: string;
2807
2807
  'company'?: string;
2808
+ 'targetUserUuid'?: string;
2808
2809
  'createdAt'?: string;
2809
2810
  'updatedAt'?: string;
2810
2811
  'readAt'?: string;
@@ -5103,13 +5104,13 @@ export interface SearchRequest {
5103
5104
  'preview'?: string;
5104
5105
  }
5105
5106
  /**
5106
- * Request body for sending an in-app notification to a user
5107
+ * Request body for sending an in-app notification in a company
5107
5108
  */
5108
5109
  export interface SendNotificationRequest {
5109
5110
  /**
5110
- * UUID of the user who should receive the notification
5111
+ * Optional. Aim this notification at one user in the company. Omit to notify every user who has access to the company.
5111
5112
  */
5112
- 'targetUserUuid': string;
5113
+ 'targetUserUuid'?: string;
5113
5114
  /**
5114
5115
  * Notification title
5115
5116
  */
@@ -11692,7 +11693,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
11692
11693
  */
11693
11694
  firebaseToken: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11694
11695
  /**
11695
- *
11696
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
11696
11697
  * @summary List in-app notifications for the logged-in user
11697
11698
  * @param {string} [company]
11698
11699
  * @param {number} [limit]
@@ -11716,7 +11717,7 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
11716
11717
  */
11717
11718
  markAsRead: (notificationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
11718
11719
  /**
11719
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
11720
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
11720
11721
  * @summary Send a notification (app token)
11721
11722
  * @param {SendNotificationRequest} sendNotificationRequest
11722
11723
  * @param {*} [options] Override http request option.
@@ -11744,7 +11745,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
11744
11745
  */
11745
11746
  firebaseToken(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringString>>;
11746
11747
  /**
11747
- *
11748
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
11748
11749
  * @summary List in-app notifications for the logged-in user
11749
11750
  * @param {string} [company]
11750
11751
  * @param {number} [limit]
@@ -11768,7 +11769,7 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
11768
11769
  */
11769
11770
  markAsRead(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessResponseString>>;
11770
11771
  /**
11771
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
11772
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
11772
11773
  * @summary Send a notification (app token)
11773
11774
  * @param {SendNotificationRequest} sendNotificationRequest
11774
11775
  * @param {*} [options] Override http request option.
@@ -11796,7 +11797,7 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
11796
11797
  */
11797
11798
  firebaseToken(options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringString>;
11798
11799
  /**
11799
- *
11800
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
11800
11801
  * @summary List in-app notifications for the logged-in user
11801
11802
  * @param {string} [company]
11802
11803
  * @param {number} [limit]
@@ -11820,7 +11821,7 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
11820
11821
  */
11821
11822
  markAsRead(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<SuccessResponseString>;
11822
11823
  /**
11823
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
11824
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
11824
11825
  * @summary Send a notification (app token)
11825
11826
  * @param {SendNotificationRequest} sendNotificationRequest
11826
11827
  * @param {*} [options] Override http request option.
@@ -11848,7 +11849,7 @@ export declare class NotificationsApi extends BaseAPI {
11848
11849
  */
11849
11850
  firebaseToken(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringString, any, {}>>;
11850
11851
  /**
11851
- *
11852
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
11852
11853
  * @summary List in-app notifications for the logged-in user
11853
11854
  * @param {string} [company]
11854
11855
  * @param {number} [limit]
@@ -11872,7 +11873,7 @@ export declare class NotificationsApi extends BaseAPI {
11872
11873
  */
11873
11874
  markAsRead(notificationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessResponseString, any, {}>>;
11874
11875
  /**
11875
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
11876
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
11876
11877
  * @summary Send a notification (app token)
11877
11878
  * @param {SendNotificationRequest} sendNotificationRequest
11878
11879
  * @param {*} [options] Override http request option.
package/dist/esm/api.js CHANGED
@@ -8673,7 +8673,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
8673
8673
  };
8674
8674
  }),
8675
8675
  /**
8676
- *
8676
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
8677
8677
  * @summary List in-app notifications for the logged-in user
8678
8678
  * @param {string} [company]
8679
8679
  * @param {number} [limit]
@@ -8772,7 +8772,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration) {
8772
8772
  };
8773
8773
  }),
8774
8774
  /**
8775
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
8775
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
8776
8776
  * @summary Send a notification (app token)
8777
8777
  * @param {SendNotificationRequest} sendNotificationRequest
8778
8778
  * @param {*} [options] Override http request option.
@@ -8845,7 +8845,7 @@ export const NotificationsApiFp = function (configuration) {
8845
8845
  });
8846
8846
  },
8847
8847
  /**
8848
- *
8848
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
8849
8849
  * @summary List in-app notifications for the logged-in user
8850
8850
  * @param {string} [company]
8851
8851
  * @param {number} [limit]
@@ -8893,7 +8893,7 @@ export const NotificationsApiFp = function (configuration) {
8893
8893
  });
8894
8894
  },
8895
8895
  /**
8896
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
8896
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
8897
8897
  * @summary Send a notification (app token)
8898
8898
  * @param {SendNotificationRequest} sendNotificationRequest
8899
8899
  * @param {*} [options] Override http request option.
@@ -8936,7 +8936,7 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
8936
8936
  return localVarFp.firebaseToken(options).then((request) => request(axios, basePath));
8937
8937
  },
8938
8938
  /**
8939
- *
8939
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
8940
8940
  * @summary List in-app notifications for the logged-in user
8941
8941
  * @param {string} [company]
8942
8942
  * @param {number} [limit]
@@ -8966,7 +8966,7 @@ export const NotificationsApiFactory = function (configuration, basePath, axios)
8966
8966
  return localVarFp.markAsRead(notificationId, options).then((request) => request(axios, basePath));
8967
8967
  },
8968
8968
  /**
8969
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
8969
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
8970
8970
  * @summary Send a notification (app token)
8971
8971
  * @param {SendNotificationRequest} sendNotificationRequest
8972
8972
  * @param {*} [options] Override http request option.
@@ -9001,7 +9001,7 @@ export class NotificationsApi extends BaseAPI {
9001
9001
  return NotificationsApiFp(this.configuration).firebaseToken(options).then((request) => request(this.axios, this.basePath));
9002
9002
  }
9003
9003
  /**
9004
- *
9004
+ * Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
9005
9005
  * @summary List in-app notifications for the logged-in user
9006
9006
  * @param {string} [company]
9007
9007
  * @param {number} [limit]
@@ -9031,7 +9031,7 @@ export class NotificationsApi extends BaseAPI {
9031
9031
  return NotificationsApiFp(this.configuration).markAsRead(notificationId, options).then((request) => request(this.axios, this.basePath));
9032
9032
  }
9033
9033
  /**
9034
- * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
9034
+ * Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
9035
9035
  * @summary Send a notification (app token)
9036
9036
  * @param {SendNotificationRequest} sendNotificationRequest
9037
9037
  * @param {*} [options] Override http request option.
@@ -5,8 +5,8 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **yproperty** | **string** | | [optional] [default to undefined]
9
8
  **xproperty** | **string** | | [optional] [default to undefined]
9
+ **yproperty** | **string** | | [optional] [default to undefined]
10
10
  **ymetric** | **string** | | [optional] [default to undefined]
11
11
  **title** | **string** | | [optional] [default to undefined]
12
12
  **chartType** | **string** | | [optional] [default to undefined]
@@ -20,8 +20,8 @@ Name | Type | Description | Notes
20
20
  import { ExistingWidgetSummary } from '@caraer/client';
21
21
 
22
22
  const instance: ExistingWidgetSummary = {
23
- yproperty,
24
23
  xproperty,
24
+ yproperty,
25
25
  ymetric,
26
26
  title,
27
27
  chartType,
package/docs/Item.md CHANGED
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
15
15
  **data** | **{ [key: string]: any | null; }** | | [optional] [default to undefined]
16
16
  **sender** | **string** | | [optional] [default to undefined]
17
17
  **company** | **string** | | [optional] [default to undefined]
18
+ **targetUserUuid** | **string** | | [optional] [default to undefined]
18
19
  **createdAt** | **string** | | [optional] [default to undefined]
19
20
  **updatedAt** | **string** | | [optional] [default to undefined]
20
21
  **readAt** | **string** | | [optional] [default to undefined]
@@ -37,6 +38,7 @@ const instance: Item = {
37
38
  data,
38
39
  sender,
39
40
  company,
41
+ targetUserUuid,
40
42
  createdAt,
41
43
  updatedAt,
42
44
  readAt,
@@ -115,6 +115,7 @@ This endpoint does not have any parameters.
115
115
  # **listNotifications**
116
116
  > ShowResponseNotificationInboxDTO listNotifications()
117
117
 
118
+ Returns notifications for the selected company plus user-general notifications that have no company. Other companies are never included.
118
119
 
119
120
  ### Example
120
121
 
@@ -273,7 +274,7 @@ const { status, data } = await apiInstance.markAsRead(
273
274
  # **sendNotification**
274
275
  > CreateResponseMapStringString sendNotification(sendNotificationRequest)
275
276
 
276
- Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). The target user must belong to the app\'s company.
277
+ Installed apps call this endpoint after async work completes. Authenticate with the installation token (Authorization: Bearer or X-CARAER-TOKEN). Every notification is scoped to the app\'s company. Omit targetUserUuid to notify every user in that company, or set it to aim the notification at one member.
277
278
 
278
279
  ### Example
279
280
 
@@ -1,12 +1,12 @@
1
1
  # SendNotificationRequest
2
2
 
3
- Request body for sending an in-app notification to a user
3
+ Request body for sending an in-app notification in a company
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **targetUserUuid** | **string** | UUID of the user who should receive the notification | [default to undefined]
9
+ **targetUserUuid** | **string** | Optional. Aim this notification at one user in the company. Omit to notify every user who has access to the company. | [optional] [default to undefined]
10
10
  **title** | **string** | Notification title | [default to undefined]
11
11
  **body** | **string** | Notification body (supports Markdown for links) | [default to undefined]
12
12
  **type** | **string** | Notification type identifier | [optional] [default to undefined]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caraer/client",
3
- "version": "2.0.459",
3
+ "version": "2.0.460",
4
4
  "description": "Generated TypeScript client for the Caraer API",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {