@caraer/client 2.0.454 → 2.0.456

package/.openapi-generator/FILES

@@ -40,6 +40,7 @@ docs/AppOAuthStartResponseDTO.md
 docs/AppPublishDTO.md
 docs/AppRequest.md
 docs/AppScheduleDTO.md
+docs/AppSettingActionSource.md
 docs/AppSettingCondition.md
 docs/AppSettingFieldMappingStructure.md
 docs/AppSettingFieldMappingStructureItem.md
@@ -129,6 +130,7 @@ docs/GridItemDTO.md
 docs/GridItemSettingsDTO.md
 docs/HasAppDTO.md
 docs/InstallAppRequest.md
+docs/Item.md
 docs/Leadscore.md
 docs/LinkedProperty.md
 docs/LoadAppSettingOptionsRequest.md
@@ -143,6 +145,7 @@ docs/MultiValueMapStringString.md
 docs/NotFoundError.md
 docs/NotFoundErrorCause.md
 docs/NotFoundErrorCauseStackTraceInner.md
+docs/NotificationInboxDTO.md
 docs/NotificationsApi.md
 docs/Number.md
 docs/NumberRange.md
@@ -254,6 +257,7 @@ docs/ShowResponseMapStringAnalyticsDashboardConfig.md
 docs/ShowResponseMapStringBoolean.md
 docs/ShowResponseMapStringObject.md
 docs/ShowResponseMapStringString.md
+docs/ShowResponseNotificationInboxDTO.md
 docs/ShowResponseObject.md
 docs/ShowResponseObjectAccessGrantCandidatesDTO.md
 docs/ShowResponsePageContentDTO.md

package/api.ts

@@ -938,6 +938,12 @@ export interface AppScheduleDTO {
     'payloadTemplate'?: string;
     'serverlessFunction'?: ServerlessFunctionRefDTO;
 }
+export interface AppSettingActionSource {
+    'type'?: string;
+    'serverlessFunctionUuid'?: string;
+    'serverlessFunctionName'?: string;
+    'enqueue'?: boolean;
+}
 export interface AppSettingCondition {
     'field'?: string;
     'operator'?: string;
@@ -964,6 +970,7 @@ export interface AppSettingFieldSchema {
     'helpText'?: string;
     'options'?: Array<SettingOption>;
     'optionsSource'?: AppSettingOptionsSource;
+    'actionSource'?: AppSettingActionSource;
     'defaultValue'?: any;
     'hidden'?: boolean;
     'visibleWhen'?: Array<AppSettingCondition>;
@@ -971,6 +978,7 @@ export interface AppSettingFieldSchema {
     'hasValue'?: boolean;
     'mappingValue'?: AppSettingFieldMappingStructure;
     'valueScope'?: string;
+    'action'?: boolean;
 }
 export interface AppSettingOptionsSource {
     'type'?: string;
@@ -2792,6 +2800,23 @@ export interface InstallAppRequest {
      */
     'appBarVisibility'?: { [key: string]: AppBarVisibilityEntry; };
 }
+export interface Item {
+    'id'?: string;
+    'title'?: string;
+    'body'?: string;
+    'type'?: string;
+    'icon'?: string;
+    'actionTitle'?: string;
+    'action'?: string;
+    'data'?: { [key: string]: any | null; };
+    'sender'?: string;
+    'company'?: string;
+    'createdAt'?: string;
+    'updatedAt'?: string;
+    'readAt'?: string;
+    'sourceAppUuid'?: string;
+    'appLogo'?: string;
+}
 /**
  * DTO representing a lead score rule
  */
@@ -3052,6 +3077,10 @@ export interface NotFoundErrorCauseStackTraceInner {
     'className'?: string;
     'nativeMethod'?: boolean;
 }
+export interface NotificationInboxDTO {
+    'notifications'?: Array<Item>;
+    'unreadCount'?: number;
+}
 export interface Number extends PropertyFormat {
 }
 export interface NumberRange extends PropertyFormat {
@@ -5161,8 +5190,8 @@ export interface SettingField {
     'hidden'?: boolean;
     'disabled'?: boolean;
     'options'?: Array<SettingOption>;
-    'defaultValue'?: any;
     'value'?: any;
+    'defaultValue'?: any;
 }
 
 export const SettingFieldTypeEnum = {
@@ -5472,6 +5501,19 @@ export interface ShowResponseMapStringString {
     'message'?: string;
     'data'?: { [key: string]: any; };
 }
+/**
+ * Represents the response for viewing or showing a specific resource.
+ */
+export interface ShowResponseNotificationInboxDTO {
+    /**
+     * A message detailing the result of the operation.
+     */
+    'message'?: string;
+    /**
+     * The data payload of the response, if any.
+     */
+    'data'?: NotificationInboxDTO;
+}
 /**
  * Represents the response for viewing or showing a specific resource.
  */
@@ -8451,6 +8493,48 @@ export const AppInstallationRuntimeApiAxiosParamCreator = function (configuratio
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
 
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Trigger an ACTION setting without saving settings
+         * @param {string} appUuid 
+         * @param {string} fieldName 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        triggerSettingAction: async (appUuid: string, fieldName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'appUuid' is not null or undefined
+            assertParamExists('triggerSettingAction', 'appUuid', appUuid)
+            // verify required parameter 'fieldName' is not null or undefined
+            assertParamExists('triggerSettingAction', 'fieldName', fieldName)
+            const localVarPath = `/api/v2/apps/{appUuid}/installation/settings/{fieldName}/trigger`
+                .replace('{appUuid}', encodeURIComponent(String(appUuid)))
+                .replace('{fieldName}', encodeURIComponent(String(fieldName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
             return {
                 url: toPathString(localVarUrlObj),
                 options: localVarRequestOptions,
@@ -8675,6 +8759,20 @@ export const AppInstallationRuntimeApiFp = function(configuration?: Configuratio
             const localVarOperationServerBasePath = operationServerMap['AppInstallationRuntimeApi.startOAuth']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 
+         * @summary Trigger an ACTION setting without saving settings
+         * @param {string} appUuid 
+         * @param {string} fieldName 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.triggerSettingAction(appUuid, fieldName, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AppInstallationRuntimeApi.triggerSettingAction']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -8849,6 +8947,17 @@ export const AppInstallationRuntimeApiFactory = function (configuration?: Config
         startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseAppOAuthStartResponseDTO> {
             return localVarFp.startOAuth(appUuid, provider, redirectUri, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 
+         * @summary Trigger an ACTION setting without saving settings
+         * @param {string} appUuid 
+         * @param {string} fieldName 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject> {
+            return localVarFp.triggerSettingAction(appUuid, fieldName, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -9035,6 +9144,18 @@ export class AppInstallationRuntimeApi extends BaseAPI {
     public startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig) {
         return AppInstallationRuntimeApiFp(this.configuration).startOAuth(appUuid, provider, redirectUri, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * 
+     * @summary Trigger an ACTION setting without saving settings
+     * @param {string} appUuid 
+     * @param {string} fieldName 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig) {
+        return AppInstallationRuntimeApiFp(this.configuration).triggerSettingAction(appUuid, fieldName, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 
 
@@ -16275,6 +16396,50 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 
+         * @summary List in-app notifications for the logged-in user
+         * @param {string} [company] 
+         * @param {number} [limit] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listNotifications: async (company?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v2/notifications`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (company !== undefined) {
+                localVarQueryParameter['company'] = company;
+            }
+
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary Mark all notifications as read for the current company
@@ -16408,6 +16573,20 @@ export const NotificationsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['NotificationsApi.dismissNotification']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 
+         * @summary List in-app notifications for the logged-in user
+         * @param {string} [company] 
+         * @param {number} [limit] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseNotificationInboxDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listNotifications(company, limit, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['NotificationsApi.listNotifications']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary Mark all notifications as read for the current company
@@ -16465,6 +16644,17 @@ export const NotificationsApiFactory = function (configuration?: Configuration,
         dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponseString> {
             return localVarFp.dismissNotification(notificationId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 
+         * @summary List in-app notifications for the logged-in user
+         * @param {string} [company] 
+         * @param {number} [limit] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseNotificationInboxDTO> {
+            return localVarFp.listNotifications(company, limit, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary Mark all notifications as read for the current company
@@ -16512,6 +16702,18 @@ export class NotificationsApi extends BaseAPI {
         return NotificationsApiFp(this.configuration).dismissNotification(notificationId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 
+     * @summary List in-app notifications for the logged-in user
+     * @param {string} [company] 
+     * @param {number} [limit] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig) {
+        return NotificationsApiFp(this.configuration).listNotifications(company, limit, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary Mark all notifications as read for the current company

package/dist/api.d.ts

@@ -928,6 +928,12 @@ export interface AppScheduleDTO {
     'payloadTemplate'?: string;
     'serverlessFunction'?: ServerlessFunctionRefDTO;
 }
+export interface AppSettingActionSource {
+    'type'?: string;
+    'serverlessFunctionUuid'?: string;
+    'serverlessFunctionName'?: string;
+    'enqueue'?: boolean;
+}
 export interface AppSettingCondition {
     'field'?: string;
     'operator'?: string;
@@ -954,6 +960,7 @@ export interface AppSettingFieldSchema {
     'helpText'?: string;
     'options'?: Array<SettingOption>;
     'optionsSource'?: AppSettingOptionsSource;
+    'actionSource'?: AppSettingActionSource;
     'defaultValue'?: any;
     'hidden'?: boolean;
     'visibleWhen'?: Array<AppSettingCondition>;
@@ -961,6 +968,7 @@ export interface AppSettingFieldSchema {
     'hasValue'?: boolean;
     'mappingValue'?: AppSettingFieldMappingStructure;
     'valueScope'?: string;
+    'action'?: boolean;
 }
 export interface AppSettingOptionsSource {
     'type'?: string;
@@ -2784,6 +2792,25 @@ export interface InstallAppRequest {
         [key: string]: AppBarVisibilityEntry;
     };
 }
+export interface Item {
+    'id'?: string;
+    'title'?: string;
+    'body'?: string;
+    'type'?: string;
+    'icon'?: string;
+    'actionTitle'?: string;
+    'action'?: string;
+    'data'?: {
+        [key: string]: any | null;
+    };
+    'sender'?: string;
+    'company'?: string;
+    'createdAt'?: string;
+    'updatedAt'?: string;
+    'readAt'?: string;
+    'sourceAppUuid'?: string;
+    'appLogo'?: string;
+}
 /**
  * DTO representing a lead score rule
  */
@@ -3047,6 +3074,10 @@ export interface NotFoundErrorCauseStackTraceInner {
     'className'?: string;
     'nativeMethod'?: boolean;
 }
+export interface NotificationInboxDTO {
+    'notifications'?: Array<Item>;
+    'unreadCount'?: number;
+}
 export interface Number extends PropertyFormat {
 }
 export interface NumberRange extends PropertyFormat {
@@ -5191,8 +5222,8 @@ export interface SettingField {
     'hidden'?: boolean;
     'disabled'?: boolean;
     'options'?: Array<SettingOption>;
-    'defaultValue'?: any;
     'value'?: any;
+    'defaultValue'?: any;
 }
 export declare const SettingFieldTypeEnum: {
     readonly String: "STRING";
@@ -5529,6 +5560,19 @@ export interface ShowResponseMapStringString {
         [key: string]: any;
     };
 }
+/**
+ * Represents the response for viewing or showing a specific resource.
+ */
+export interface ShowResponseNotificationInboxDTO {
+    /**
+     * A message detailing the result of the operation.
+     */
+    'message'?: string;
+    /**
+     * The data payload of the response, if any.
+     */
+    'data'?: NotificationInboxDTO;
+}
 /**
  * Represents the response for viewing or showing a specific resource.
  */
@@ -7859,6 +7903,15 @@ export declare const AppInstallationRuntimeApiAxiosParamCreator: (configuration?
      * @throws {RequiredError}
      */
     startOAuth: (appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Trigger an ACTION setting without saving settings
+     * @param {string} appUuid
+     * @param {string} fieldName
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    triggerSettingAction: (appUuid: string, fieldName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * AppInstallationRuntimeApi - functional programming interface
@@ -8005,6 +8058,15 @@ export declare const AppInstallationRuntimeApiFp: (configuration?: Configuration
      * @throws {RequiredError}
      */
     startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseAppOAuthStartResponseDTO>>;
+    /**
+     *
+     * @summary Trigger an ACTION setting without saving settings
+     * @param {string} appUuid
+     * @param {string} fieldName
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseMapStringObject>>;
 };
 /**
  * AppInstallationRuntimeApi - factory interface
@@ -8151,6 +8213,15 @@ export declare const AppInstallationRuntimeApiFactory: (configuration?: Configur
      * @throws {RequiredError}
      */
     startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseAppOAuthStartResponseDTO>;
+    /**
+     *
+     * @summary Trigger an ACTION setting without saving settings
+     * @param {string} appUuid
+     * @param {string} fieldName
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseMapStringObject>;
 };
 /**
  * AppInstallationRuntimeApi - object-oriented interface
@@ -8297,6 +8368,15 @@ export declare class AppInstallationRuntimeApi extends BaseAPI {
      * @throws {RequiredError}
      */
     startOAuth(appUuid: string, provider: string, redirectUri?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseAppOAuthStartResponseDTO, any, {}>>;
+    /**
+     *
+     * @summary Trigger an ACTION setting without saving settings
+     * @param {string} appUuid
+     * @param {string} fieldName
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    triggerSettingAction(appUuid: string, fieldName: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseMapStringObject, any, {}>>;
 }
 /**
  * ApplicationsApi - axios parameter creator
@@ -11598,6 +11678,15 @@ export declare const NotificationsApiAxiosParamCreator: (configuration?: Configu
      * @throws {RequiredError}
      */
     dismissNotification: (notificationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary List in-app notifications for the logged-in user
+     * @param {string} [company]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications: (company?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Mark all notifications as read for the current company
@@ -11634,6 +11723,15 @@ export declare const NotificationsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseString>>;
+    /**
+     *
+     * @summary List in-app notifications for the logged-in user
+     * @param {string} [company]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShowResponseNotificationInboxDTO>>;
     /**
      *
      * @summary Mark all notifications as read for the current company
@@ -11670,6 +11768,15 @@ export declare const NotificationsApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): AxiosPromise<DeleteResponseString>;
+    /**
+     *
+     * @summary List in-app notifications for the logged-in user
+     * @param {string} [company]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<ShowResponseNotificationInboxDTO>;
     /**
      *
      * @summary Mark all notifications as read for the current company
@@ -11706,6 +11813,15 @@ export declare class NotificationsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     dismissNotification(notificationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseString, any, {}>>;
+    /**
+     *
+     * @summary List in-app notifications for the logged-in user
+     * @param {string} [company]
+     * @param {number} [limit]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications(company?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ShowResponseNotificationInboxDTO, any, {}>>;
     /**
      *
      * @summary Mark all notifications as read for the current company