@caraer/client 2.0.381 → 2.0.382

package/dist/esm/apps.d.ts

@@ -0,0 +1,111 @@
+/**
+ * Hand-written serverless / installation payload helpers for Caraer apps.
+ *
+ * Preserved across OpenAPI regeneration (see `.openapi-generator-ignore` and
+ * `scripts/client-overlays/` in the Caraer backend). Prefer these over
+ * per-app `caraer apps typegen` output.
+ */
+/** Installation settings field as delivered in lifecycle / webhook bodies. */
+export interface SettingFieldValue {
+    name: string;
+    label?: string;
+    type?: string;
+    value?: unknown;
+    defaultValue?: unknown;
+    hasValue?: boolean;
+}
+/** Approximate lifecycle hook body (install / update / uninstall / rotate). */
+export interface LifecyclePayload {
+    event?: "Installed" | "Updated" | "Uninstalled" | "Rotated" | string;
+    timestamp?: number;
+    appUuid?: string;
+    appName?: string;
+    appLabel?: string;
+    privateApp?: boolean;
+    authMethod?: "OAUTH2" | "API_KEY" | string;
+    userUuid?: string;
+    companyUuid?: string;
+    installationToken?: string;
+    caraerApiBase?: string;
+    oauthConnected?: boolean;
+    settingsSchema?: SettingFieldValue[];
+    scopes?: string[];
+    settingsChanged?: boolean;
+    scopesChanged?: boolean;
+    filtersChanged?: boolean;
+    [key: string]: unknown;
+}
+/** Record / domain webhook body (USER_FRIENDLY shape varies by topic). */
+export interface WebhookPayload {
+    topic?: string;
+    event?: string;
+    timestamp?: number;
+    appUuid?: string;
+    companyUuid?: string;
+    installationToken?: string;
+    caraerApiBase?: string;
+    record?: Record<string, unknown>;
+    objectName?: string;
+    settingsSchema?: SettingFieldValue[];
+    [key: string]: unknown;
+}
+/** Cron / schedule invocation body. */
+export interface SchedulePayload {
+    scheduleName?: string;
+    name?: string;
+    appUuid?: string;
+    companyUuid?: string;
+    installationToken?: string;
+    caraerApiBase?: string;
+    scheduledAt?: string | number;
+    settingsSchema?: SettingFieldValue[];
+    [key: string]: unknown;
+}
+/** Inbound HTTP route body (provider-specific; wrapped by the platform). */
+export interface InboundPayload {
+    appUuid?: string;
+    companyUuid?: string;
+    installationToken?: string;
+    caraerApiBase?: string;
+    routeName?: string;
+    body?: unknown;
+    headers?: Record<string, string>;
+    [key: string]: unknown;
+}
+/** Async installation job payload (function receives this as req.body). */
+export interface JobPayload {
+    jobId?: string;
+    functionName?: string;
+    appUuid?: string;
+    companyUuid?: string;
+    installationToken?: string;
+    caraerApiBase?: string;
+    [key: string]: unknown;
+}
+/** Installation state document (arbitrary JSON map). */
+export type InstallationState = Record<string, unknown>;
+/** Installation secrets map (values are strings when readable). */
+export type InstallationSecrets = Record<string, string>;
+/** POST /installation/jobs request body. */
+export interface EnqueueJobRequest {
+    functionName: string;
+    payload?: Record<string, unknown>;
+    delaySeconds?: number;
+}
+/** Installation job status document. */
+export interface InstallationJob {
+    jobId: string;
+    status: "QUEUED" | "RUNNING" | "SUCCEEDED" | "FAILED" | string;
+    functionName?: string;
+    payload?: Record<string, unknown>;
+    result?: unknown;
+    error?: string;
+    createdAt?: string | number;
+    updatedAt?: string | number;
+    [key: string]: unknown;
+}
+/** Wrapper returned by many Caraer API endpoints. */
+export interface ApiSuccess<T = unknown> {
+    message?: string;
+    data?: T;
+}

package/dist/esm/apps.js

@@ -0,0 +1,8 @@
+/**
+ * Hand-written serverless / installation payload helpers for Caraer apps.
+ *
+ * Preserved across OpenAPI regeneration (see `.openapi-generator-ignore` and
+ * `scripts/client-overlays/` in the Caraer backend). Prefer these over
+ * per-app `caraer apps typegen` output.
+ */
+export {};

package/dist/esm/index.d.ts

@@ -11,3 +11,4 @@
  */
 export * from "./api";
 export * from "./configuration";
+export * from "./apps";

package/dist/esm/index.js

@@ -13,3 +13,4 @@
  */
 export * from "./api";
 export * from "./configuration";
+export * from "./apps";

package/dist/index.d.ts

@@ -11,3 +11,4 @@
  */
 export * from "./api";
 export * from "./configuration";
+export * from "./apps";

package/dist/index.js

@@ -29,3 +29,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./api"), exports);
 __exportStar(require("./configuration"), exports);
+__exportStar(require("./apps"), exports);

package/docs/AdvancedRecordQueryPlan.md

@@ -0,0 +1,50 @@
+# AdvancedRecordQueryPlan
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**version** | **number** |  | [optional] [default to undefined]
+**mainObject** | **string** |  | [optional] [default to undefined]
+**mainObjects** | **Array<string>** |  | [optional] [default to undefined]
+**query** | **string** |  | [optional] [default to undefined]
+**filter** | [**Filter**](Filter.md) |  | [optional] [default to undefined]
+**sort** | [**Set<SortItem>**](SortItem.md) |  | [optional] [default to undefined]
+**show** | [**Set<ShowItem>**](ShowItem.md) |  | [optional] [default to undefined]
+**strategy** | **string** |  | [optional] [default to undefined]
+**anchorRecordUuid** | **string** |  | [optional] [default to undefined]
+**criteria** | **Array<string>** |  | [optional] [default to undefined]
+**graphTraversals** | [**Array<GraphTraversalSpec>**](GraphTraversalSpec.md) |  | [optional] [default to undefined]
+**scoreWeights** | **{ [key: string]: number; }** |  | [optional] [default to undefined]
+**includeEvidence** | **boolean** |  | [optional] [default to undefined]
+**maxTraversalDepth** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**limit** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdvancedRecordQueryPlan } from '@caraer/client';
+
+const instance: AdvancedRecordQueryPlan = {
+    version,
+    mainObject,
+    mainObjects,
+    query,
+    filter,
+    sort,
+    show,
+    strategy,
+    anchorRecordUuid,
+    criteria,
+    graphTraversals,
+    scoreWeights,
+    includeEvidence,
+    maxTraversalDepth,
+    page,
+    limit,
+};
+```
+
+[[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/docs/AdvancedRecordQueryRequest.md

@@ -0,0 +1,43 @@
+# AdvancedRecordQueryRequest
+
+Advanced record query. Provide either question or plan, not both.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**question** | **string** | Natural-language question to plan and execute. | [optional] [default to undefined]
+**plan** | [**AdvancedRecordQueryPlan**](AdvancedRecordQueryPlan.md) | Validated declarative query plan. | [optional] [default to undefined]
+**mainObject** | **string** | Optional main object hint. Use mainObjects for multi-type queries. | [optional] [default to undefined]
+**mainObjects** | **Array<string>** | Optional object list for multi-type queries (e.g. candidate and vacancy together). | [optional] [default to undefined]
+**strategy** | **string** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**limit** | **number** |  | [optional] [default to undefined]
+**preview** | **string** |  | [optional] [default to undefined]
+**parse** | **any** |  | [optional] [default to undefined]
+**archived** | **boolean** |  | [optional] [default to undefined]
+**explain** | **boolean** | When true, include normalized plan, scores, and evidence. | [optional] [default to undefined]
+**recordReturnFormat** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdvancedRecordQueryRequest } from '@caraer/client';
+
+const instance: AdvancedRecordQueryRequest = {
+    question,
+    plan,
+    mainObject,
+    mainObjects,
+    strategy,
+    page,
+    limit,
+    preview,
+    parse,
+    archived,
+    explain,
+    recordReturnFormat,
+};
+```
+
+[[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/docs/AdvancedRecordQueryResponse.md

@@ -0,0 +1,39 @@
+# AdvancedRecordQueryResponse
+
+Advanced record query response with scores and evidence.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **Array<any>** |  | [optional] [default to undefined]
+**results** | [**Array<AdvancedRecordQueryResultItem>**](AdvancedRecordQueryResultItem.md) |  | [optional] [default to undefined]
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**perPage** | **number** |  | [optional] [default to undefined]
+**lastPage** | **number** |  | [optional] [default to undefined]
+**plan** | [**AdvancedRecordQueryPlan**](AdvancedRecordQueryPlan.md) |  | [optional] [default to undefined]
+**confidence** | **number** |  | [optional] [default to undefined]
+**warnings** | **Array<string>** |  | [optional] [default to undefined]
+**diagnostics** | **{ [key: string]: any | null; }** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdvancedRecordQueryResponse } from '@caraer/client';
+
+const instance: AdvancedRecordQueryResponse = {
+    data,
+    results,
+    total,
+    page,
+    perPage,
+    lastPage,
+    plan,
+    confidence,
+    warnings,
+    diagnostics,
+};
+```
+
+[[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/docs/AdvancedRecordQueryResultItem.md

@@ -0,0 +1,32 @@
+# AdvancedRecordQueryResultItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**record** | **any** |  | [optional] [default to undefined]
+**recordUuid** | **string** |  | [optional] [default to undefined]
+**objectName** | **string** |  | [optional] [default to undefined]
+**scores** | [**ScoreBreakdown**](ScoreBreakdown.md) |  | [optional] [default to undefined]
+**criteria** | [**Array<CriterionScore>**](CriterionScore.md) |  | [optional] [default to undefined]
+**supportingEvidence** | [**Array<QueryEvidence>**](QueryEvidence.md) |  | [optional] [default to undefined]
+**contradictingEvidence** | [**Array<QueryEvidence>**](QueryEvidence.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AdvancedRecordQueryResultItem } from '@caraer/client';
+
+const instance: AdvancedRecordQueryResultItem = {
+    record,
+    recordUuid,
+    objectName,
+    scores,
+    criteria,
+    supportingEvidence,
+    contradictingEvidence,
+};
+```
+
+[[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/docs/AggregateBatchRequest.md

@@ -0,0 +1,21 @@
+# AggregateBatchRequest
+
+Batch aggregation request for loading a dashboard.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requests** | [**Array<AggregateRequest>**](AggregateRequest.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AggregateBatchRequest } from '@caraer/client';
+
+const instance: AggregateBatchRequest = {
+    requests,
+};
+```
+
+[[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/docs/AggregateRequest.md

@@ -0,0 +1,43 @@
+# AggregateRequest
+
+Aggregation request for analytics charts over Neo4j records.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**xaxis** | [**AnalyticsAxisConfig**](AnalyticsAxisConfig.md) |  | [optional] [default to undefined]
+**yaxis** | [**AnalyticsAxisConfig**](AnalyticsAxisConfig.md) |  | [optional] [default to undefined]
+**id** | **string** | Optional client widget id, echoed in batch responses. | [optional] [default to undefined]
+**mainObject** | **string** |  | [optional] [default to undefined]
+**filter** | [**Filter**](Filter.md) |  | [optional] [default to undefined]
+**query** | **string** |  | [optional] [default to undefined]
+**xAxis** | [**AnalyticsAxisConfig**](AnalyticsAxisConfig.md) |  | [optional] [default to undefined]
+**yAxis** | [**AnalyticsAxisConfig**](AnalyticsAxisConfig.md) |  | [optional] [default to undefined]
+**series** | [**AnalyticsSeriesConfig**](AnalyticsSeriesConfig.md) |  | [optional] [default to undefined]
+**limit** | **number** | Optional top-N series limit. For additive metrics (count, countDistinct, sum), keeps the N series with the highest total Y. Null or <= 0 means no truncation. | [optional] [default to undefined]
+**sort** | **string** |  | [optional] [default to undefined]
+**excludeEmptyValues** | **boolean** | When true, omit null/blank/(empty) category buckets from the response. Useful for bar and pie charts grouped by optional properties. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AggregateRequest } from '@caraer/client';
+
+const instance: AggregateRequest = {
+    xaxis,
+    yaxis,
+    id,
+    mainObject,
+    filter,
+    query,
+    xAxis,
+    yAxis,
+    series,
+    limit,
+    sort,
+    excludeEmptyValues,
+};
+```
+
+[[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/docs/AnalyticsAxisConfig.md

@@ -0,0 +1,32 @@
+# AnalyticsAxisConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | [**AnalyticsPropertyRef**](AnalyticsPropertyRef.md) |  | [optional] [default to undefined]
+**timeBucket** | **string** |  | [optional] [default to undefined]
+**timeZone** | **string** |  | [optional] [default to undefined]
+**windowDays** | **number** |  | [optional] [default to undefined]
+**binCount** | **number** |  | [optional] [default to undefined]
+**metric** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnalyticsAxisConfig } from '@caraer/client';
+
+const instance: AnalyticsAxisConfig = {
+    property,
+    timeBucket,
+    timeZone,
+    windowDays,
+    binCount,
+    metric,
+    label,
+};
+```
+
+[[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/docs/AnalyticsComparisonMetric.md

@@ -0,0 +1,28 @@
+# AnalyticsComparisonMetric
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**mainObject** | **string** |  | [optional] [default to undefined]
+**filter** | [**Filter**](Filter.md) |  | [optional] [default to undefined]
+**yAxis** | [**AnalyticsAxisConfig**](AnalyticsAxisConfig.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnalyticsComparisonMetric } from '@caraer/client';
+
+const instance: AnalyticsComparisonMetric = {
+    key,
+    label,
+    mainObject,
+    filter,
+    yAxis,
+};
+```
+
+[[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/docs/AnalyticsDashboardConfig.md

@@ -0,0 +1,24 @@
+# AnalyticsDashboardConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**version** | **number** |  | [optional] [default to undefined]
+**columns** | **number** |  | [optional] [default to undefined]
+**widgets** | [**Array<AnalyticsWidgetConfig>**](AnalyticsWidgetConfig.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnalyticsDashboardConfig } from '@caraer/client';
+
+const instance: AnalyticsDashboardConfig = {
+    version,
+    columns,
+    widgets,
+};
+```
+
+[[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/docs/AnalyticsPropertyRef.md

@@ -0,0 +1,24 @@
+# AnalyticsPropertyRef
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **string** |  | [optional] [default to undefined]
+**relation** | **string** |  | [optional] [default to undefined]
+**propertyName** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnalyticsPropertyRef } from '@caraer/client';
+
+const instance: AnalyticsPropertyRef = {
+    object,
+    relation,
+    propertyName,
+};
+```
+
+[[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/docs/AnalyticsReferenceLine.md

@@ -0,0 +1,24 @@
+# AnalyticsReferenceLine
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **number** |  | [optional] [default to undefined]
+**label** | **string** |  | [optional] [default to undefined]
+**color** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnalyticsReferenceLine } from '@caraer/client';
+
+const instance: AnalyticsReferenceLine = {
+    value,
+    label,
+    color,
+};
+```
+
+[[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/docs/AnalyticsSeriesConfig.md

@@ -0,0 +1,20 @@
+# AnalyticsSeriesConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**groupBy** | [**AnalyticsPropertyRef**](AnalyticsPropertyRef.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnalyticsSeriesConfig } from '@caraer/client';
+
+const instance: AnalyticsSeriesConfig = {
+    groupBy,
+};
+```
+
+[[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/docs/AnalyticsTrendConfig.md

@@ -0,0 +1,22 @@
+# AnalyticsTrendConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property** | [**AnalyticsPropertyRef**](AnalyticsPropertyRef.md) |  | [optional] [default to undefined]
+**windowDays** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnalyticsTrendConfig } from '@caraer/client';
+
+const instance: AnalyticsTrendConfig = {
+    property,
+    windowDays,
+};
+```
+
+[[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/docs/AnalyticsWidgetConfig.md

@@ -0,0 +1,54 @@
+# AnalyticsWidgetConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**chartType** | **string** |  | [optional] [default to undefined]
+**mainObject** | **string** |  | [optional] [default to undefined]
+**x** | **number** |  | [optional] [default to undefined]
+**y** | **number** |  | [optional] [default to undefined]
+**w** | **number** |  | [optional] [default to undefined]
+**h** | **number** |  | [optional] [default to undefined]
+**filter** | [**Filter**](Filter.md) |  | [optional] [default to undefined]
+**xAxis** | [**AnalyticsAxisConfig**](AnalyticsAxisConfig.md) |  | [optional] [default to undefined]
+**yAxis** | [**AnalyticsAxisConfig**](AnalyticsAxisConfig.md) |  | [optional] [default to undefined]
+**series** | [**AnalyticsSeriesConfig**](AnalyticsSeriesConfig.md) |  | [optional] [default to undefined]
+**comparisonMetrics** | [**Array<AnalyticsComparisonMetric>**](AnalyticsComparisonMetric.md) |  | [optional] [default to undefined]
+**trend** | [**AnalyticsTrendConfig**](AnalyticsTrendConfig.md) |  | [optional] [default to undefined]
+**limit** | **number** |  | [optional] [default to undefined]
+**sort** | **string** |  | [optional] [default to undefined]
+**excludeEmptyValues** | **boolean** |  | [optional] [default to undefined]
+**style** | [**AnalyticsWidgetStyle**](AnalyticsWidgetStyle.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnalyticsWidgetConfig } from '@caraer/client';
+
+const instance: AnalyticsWidgetConfig = {
+    id,
+    title,
+    chartType,
+    mainObject,
+    x,
+    y,
+    w,
+    h,
+    filter,
+    xAxis,
+    yAxis,
+    series,
+    comparisonMetrics,
+    trend,
+    limit,
+    sort,
+    excludeEmptyValues,
+    style,
+};
+```
+
+[[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/docs/AnalyticsWidgetStyle.md

@@ -0,0 +1,32 @@
+# AnalyticsWidgetStyle
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**showLegend** | **boolean** |  | [optional] [default to undefined]
+**showGrid** | **boolean** |  | [optional] [default to undefined]
+**showValueLabels** | **boolean** |  | [optional] [default to undefined]
+**barOrientation** | **string** |  | [optional] [default to undefined]
+**barGrouping** | **string** |  | [optional] [default to undefined]
+**colors** | **{ [key: string]: string; }** |  | [optional] [default to undefined]
+**referenceLines** | [**Array<AnalyticsReferenceLine>**](AnalyticsReferenceLine.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AnalyticsWidgetStyle } from '@caraer/client';
+
+const instance: AnalyticsWidgetStyle = {
+    showLegend,
+    showGrid,
+    showValueLabels,
+    barOrientation,
+    barGrouping,
+    colors,
+    referenceLines,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)