@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/dialerAnalytics.d.ts

@@ -0,0 +1,187 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.dialerAnalytics` (Dialer Analytics): 6 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"get_dialer_leaderboard_analytics_dialer_leaderboard_get">;
+ *
+ * Reference with examples: dialerAnalytics.md
+ */
+/* eslint-disable */
+
+/** `g8.api.dialerAnalytics.<member>` -> the operationId it calls. */
+export interface DialerAnalyticsMembers {
+  getDialerLeaderboard: "get_dialer_leaderboard_analytics_dialer_leaderboard_get";
+  getDialerPerformance: "get_dialer_performance_analytics_dialer_performance_get";
+  getDialerQuality: "get_dialer_quality_analytics_dialer_quality_get";
+  getQualityLeaderboard: "get_quality_leaderboard_analytics_dialer_quality_leaderboard_get";
+  getSdrDialerDetail: "get_sdr_dialer_detail_analytics_dialer_leaderboard_sdr__sdr_email__get";
+  searchGradedCalls: "search_graded_calls_analytics_dialer_grading_search_post";
+}
+
+/** Input and output of every `g8.api.dialerAnalytics` operation, keyed by operationId. */
+export interface DialerAnalyticsOperations {
+  /**
+   * GET /analytics/dialer/leaderboard
+   * Get Dialer Leaderboard
+   * tier: read · scope: analytics:read
+   */
+  get_dialer_leaderboard_analytics_dialer_leaderboard_get: {
+    input: {
+    query?: {
+      /** Time period preset (fallback if no dates) */
+      period?: ("today" | "week" | "month") | null;
+      /** Start date (YYYY-MM-DD) */
+      start_date?: string | null;
+      /** End date (YYYY-MM-DD) */
+      end_date?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: DialerAnalyticsResponse;
+  };
+  /**
+   * GET /analytics/dialer/performance
+   * Get Dialer Performance
+   * tier: read · scope: analytics:read
+   */
+  get_dialer_performance_analytics_dialer_performance_get: {
+    input: {
+    query?: {
+      /** SDR email to view. Defaults to current user. */
+      sdr_email?: string | null;
+      /** Start date (YYYY-MM-DD). Defaults to today. */
+      start_date?: string | null;
+      /** End date (YYYY-MM-DD). Defaults to today. */
+      end_date?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: DialerAnalyticsResponse;
+  };
+  /**
+   * GET /analytics/dialer/quality
+   * Get Dialer Quality
+   * tier: read · scope: analytics:read
+   */
+  get_dialer_quality_analytics_dialer_quality_get: {
+    input: {
+    query?: {
+      /** SDR email. Defaults to current user. */
+      sdr_email?: string | null;
+      /** Rolling window in days */
+      days?: number;
+      /** Start date (YYYY-MM-DD) */
+      start_date?: string | null;
+      /** End date (YYYY-MM-DD) */
+      end_date?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: DialerAnalyticsResponse;
+  };
+  /**
+   * GET /analytics/dialer/quality/leaderboard
+   * Get Quality Leaderboard
+   * tier: read · scope: analytics:read
+   */
+  get_quality_leaderboard_analytics_dialer_quality_leaderboard_get: {
+    input: {
+    query?: {
+      /** Rolling window in days */
+      days?: number;
+      /** Start date (YYYY-MM-DD) */
+      start_date?: string | null;
+      /** End date (YYYY-MM-DD) */
+      end_date?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: DialerAnalyticsResponse;
+  };
+  /**
+   * GET /analytics/dialer/leaderboard/sdr/{sdr_email}
+   * Get Sdr Dialer Detail
+   * tier: read · scope: analytics:read
+   */
+  get_sdr_dialer_detail_analytics_dialer_leaderboard_sdr__sdr_email__get: {
+    input: {
+    path: {
+      /** SDR email address */
+      sdr_email: string;
+    };
+    query?: {
+      /** Number of days to analyze */
+      days?: number;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: DialerAnalyticsResponse;
+  };
+  /**
+   * POST /analytics/dialer/grading/search
+   * Search Graded Calls
+   * tier: read · scope: analytics:read
+   */
+  search_graded_calls_analytics_dialer_grading_search_post: {
+    input: {
+    query?: {
+      /** Page number */
+      page?: number;
+      /** Results per page */
+      page_size?: number;
+      /** Filter by SDR email */
+      sdr_email?: string | null;
+      /** Filter by campaign ID */
+      campaign_id?: string | null;
+      /** Minimum overall score */
+      min_score?: number | null;
+      /** Maximum overall score */
+      max_score?: number | null;
+      /** Start date (YYYY-MM-DD) */
+      start_date?: string | null;
+      /** End date (YYYY-MM-DD) */
+      end_date?: string | null;
+      /** Sort by: date or score */
+      sort_by?: string | null;
+      /** Sort order: asc or desc */
+      sort_order?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: unknown;
+  };
+}
+
+// 2 schemas referenced above (the same as G8Contract.<Name>).
+
+/** Metadata for dialer analytics responses. */
+export interface DialerAnalyticsMeta {
+  cached: boolean;
+  degraded?: boolean;
+  org_id: string;
+  query_time_ms?: number | null;
+  reason?: string | null;
+  timestamp: string;
+}
+
+/** Standard dialer analytics response wrapper. */
+export interface DialerAnalyticsResponse {
+  data: Record<string, unknown> | Array<unknown>;
+  meta: DialerAnalyticsMeta;
+  success?: boolean;
+}

package/docs/api/dialerAnalytics.md

@@ -0,0 +1,257 @@
+<!-- Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. -->
+
+# `g8.api.dialerAnalytics`: Dialer Analytics
+
+6 operations (6 read).
+
+No hand-written client covers this area. Call it through `g8.api.dialerAnalytics.*` as shown below, or by operationId with `g8.api.call(operationId, input)`.
+
+Every example below assumes this setup (server-side, API key):
+
+```ts
+import { g8 } from "@graph8/sdk";
+
+g8.init({ apiKey: process.env.G8_API_KEY! });
+```
+
+Example values are placeholders that match each field's type. Only required fields are shown. Every example is type-checked against the SDK in CI.
+
+Exact TypeScript types for every operation on this page, and every schema they use: [dialerAnalytics.d.ts](dialerAnalytics.d.ts).
+
+## Operations
+
+| Call | HTTP | Tier | Scope | Summary |
+|---|---|---|---|---|
+| [`getDialerLeaderboard`](#op-getdialerleaderboard) | `GET /api/v1/analytics/dialer/leaderboard` | read | `analytics:read` | Get Dialer Leaderboard |
+| [`getDialerPerformance`](#op-getdialerperformance) | `GET /api/v1/analytics/dialer/performance` | read | `analytics:read` | Get Dialer Performance |
+| [`getDialerQuality`](#op-getdialerquality) | `GET /api/v1/analytics/dialer/quality` | read | `analytics:read` | Get Dialer Quality |
+| [`getQualityLeaderboard`](#op-getqualityleaderboard) | `GET /api/v1/analytics/dialer/quality/leaderboard` | read | `analytics:read` | Get Quality Leaderboard |
+| [`getSdrDialerDetail`](#op-getsdrdialerdetail) | `GET /api/v1/analytics/dialer/leaderboard/sdr/{sdr_email}` | read | `analytics:read` | Get Sdr Dialer Detail |
+| [`searchGradedCalls`](#op-searchgradedcalls) | `POST /api/v1/analytics/dialer/grading/search` | read | `analytics:read` | Search Graded Calls |
+
+---
+
+<a id="op-getdialerleaderboard"></a>
+
+### `g8.api.dialerAnalytics.getDialerLeaderboard(input?)`
+
+**Get Dialer Leaderboard**
+
+- HTTP: `GET /api/v1/analytics/dialer/leaderboard`
+- operationId: `get_dialer_leaderboard_analytics_dialer_leaderboard_get` (also callable as `g8.api.call("get_dialer_leaderboard_analytics_dialer_leaderboard_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Org-wide SDR leaderboard ranked by meetings booked.
+
+Accepts either explicit `start_date`/`end_date` or a `period` preset.
+If neither is provided, defaults to today.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.period` | `"today" \| "week" \| "month" \| null` | no | Time period preset (fallback if no dates) |
+| `query.start_date` | `string \| null` | no | Start date (YYYY-MM-DD) |
+| `query.end_date` | `string \| null` | no | End date (YYYY-MM-DD) |
+| `headers.X-Org-Id` | `string \| null` | no |  |
+
+**Returns** `DialerAnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `meta` (DialerAnalyticsMeta), `success` (boolean).
+
+**Example**
+
+```ts
+const result = await g8.api.dialerAnalytics.getDialerLeaderboard();
+```
+
+---
+
+<a id="op-getdialerperformance"></a>
+
+### `g8.api.dialerAnalytics.getDialerPerformance(input?)`
+
+**Get Dialer Performance**
+
+- HTTP: `GET /api/v1/analytics/dialer/performance`
+- operationId: `get_dialer_performance_analytics_dialer_performance_get` (also callable as `g8.api.call("get_dialer_performance_analytics_dialer_performance_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Combined SDR dashboard data.
+
+Returns metrics for the given date range (defaults to today),
+yesterday (for trends), daily breakdown, disposition distribution,
+personal bests, and current streak.
+
+Pass `sdr_email` to view another SDR's performance (e.g. as a manager).
+Pass `start_date`/`end_date` for a custom date range.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.sdr_email` | `string \| null` | no | SDR email to view. Defaults to current user. |
+| `query.start_date` | `string \| null` | no | Start date (YYYY-MM-DD). Defaults to today. |
+| `query.end_date` | `string \| null` | no | End date (YYYY-MM-DD). Defaults to today. |
+| `headers.X-Org-Id` | `string \| null` | no |  |
+
+**Returns** `DialerAnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `meta` (DialerAnalyticsMeta), `success` (boolean).
+
+**Example**
+
+```ts
+const result = await g8.api.dialerAnalytics.getDialerPerformance();
+```
+
+---
+
+<a id="op-getdialerquality"></a>
+
+### `g8.api.dialerAnalytics.getDialerQuality(input?)`
+
+**Get Dialer Quality**
+
+- HTTP: `GET /api/v1/analytics/dialer/quality`
+- operationId: `get_dialer_quality_analytics_dialer_quality_get` (also callable as `g8.api.call("get_dialer_quality_analytics_dialer_quality_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+SDR quality scores from AI call grading.
+
+Returns average scores across 4 criteria (script adherence, objection
+handling, value delivery, closing technique) and a daily quality trend.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.sdr_email` | `string \| null` | no | SDR email. Defaults to current user. |
+| `query.days` | `integer` | no | Rolling window in days default `30` |
+| `query.start_date` | `string \| null` | no | Start date (YYYY-MM-DD) |
+| `query.end_date` | `string \| null` | no | End date (YYYY-MM-DD) |
+| `headers.X-Org-Id` | `string \| null` | no |  |
+
+**Returns** `DialerAnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `meta` (DialerAnalyticsMeta), `success` (boolean).
+
+**Example**
+
+```ts
+const result = await g8.api.dialerAnalytics.getDialerQuality();
+```
+
+---
+
+<a id="op-getqualityleaderboard"></a>
+
+### `g8.api.dialerAnalytics.getQualityLeaderboard(input?)`
+
+**Get Quality Leaderboard**
+
+- HTTP: `GET /api/v1/analytics/dialer/quality/leaderboard`
+- operationId: `get_quality_leaderboard_analytics_dialer_quality_leaderboard_get` (also callable as `g8.api.call("get_quality_leaderboard_analytics_dialer_quality_leaderboard_get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Org-wide quality ranking from AI call grading.
+
+Returns average quality scores per SDR, ordered by overall score descending.
+Used for the leaderboard quality column.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.days` | `integer` | no | Rolling window in days default `30` |
+| `query.start_date` | `string \| null` | no | Start date (YYYY-MM-DD) |
+| `query.end_date` | `string \| null` | no | End date (YYYY-MM-DD) |
+| `headers.X-Org-Id` | `string \| null` | no |  |
+
+**Returns** `DialerAnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `meta` (DialerAnalyticsMeta), `success` (boolean).
+
+**Example**
+
+```ts
+const result = await g8.api.dialerAnalytics.getQualityLeaderboard();
+```
+
+---
+
+<a id="op-getsdrdialerdetail"></a>
+
+### `g8.api.dialerAnalytics.getSdrDialerDetail(input)`
+
+**Get Sdr Dialer Detail**
+
+- HTTP: `GET /api/v1/analytics/dialer/leaderboard/sdr/{sdr_email}`
+- operationId: `get_sdr_dialer_detail_analytics_dialer_leaderboard_sdr__sdr_email__get` (also callable as `g8.api.call("get_sdr_dialer_detail_analytics_dialer_leaderboard_sdr__sdr_email__get", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Detailed daily breakdown for a specific SDR's dialer activity.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `path.sdr_email` | `string` | yes | SDR email address |
+| `query.days` | `integer` | no | Number of days to analyze default `30` |
+| `headers.X-Org-Id` | `string \| null` | no |  |
+
+**Returns** `DialerAnalyticsResponse`: the envelope `{ data: Record<string, unknown> | Array<unknown>, ... }`. `g8.api` returns the envelope as-is, so read `result.data`.
+
+Other envelope fields: `meta` (DialerAnalyticsMeta), `success` (boolean).
+
+**Example**
+
+```ts
+const result = await g8.api.dialerAnalytics.getSdrDialerDetail({ path: { sdr_email: "jane@acme.com" } });
+```
+
+---
+
+<a id="op-searchgradedcalls"></a>
+
+### `g8.api.dialerAnalytics.searchGradedCalls(input?)`
+
+**Search Graded Calls**
+
+- HTTP: `POST /api/v1/analytics/dialer/grading/search`
+- operationId: `search_graded_calls_analytics_dialer_grading_search_post` (also callable as `g8.api.call("search_graded_calls_analytics_dialer_grading_search_post", input)`)
+- Tier: `read`: reads data; safe to call and to retry
+- API-key scope: `analytics:read`
+
+Search and filter graded calls with full transcripts and AI evaluations.
+
+Queries the voice database directly for call results that have grading data.
+
+**Input**
+
+| Field | Type | Required | Description |
+|---|---|---|---|
+| `query.page` | `integer` | no | Page number default `1` |
+| `query.page_size` | `integer` | no | Results per page default `20` |
+| `query.sdr_email` | `string \| null` | no | Filter by SDR email |
+| `query.campaign_id` | `string \| null` | no | Filter by campaign ID |
+| `query.min_score` | `integer \| null` | no | Minimum overall score |
+| `query.max_score` | `integer \| null` | no | Maximum overall score |
+| `query.start_date` | `string \| null` | no | Start date (YYYY-MM-DD) |
+| `query.end_date` | `string \| null` | no | End date (YYYY-MM-DD) |
+| `query.sort_by` | `string \| null` | no | Sort by: date or score default `"date"` |
+| `query.sort_order` | `string \| null` | no | Sort order: asc or desc default `"desc"` |
+| `headers.X-Org-Id` | `string \| null` | no |  |
+
+**Returns** `unknown`.
+
+**Example**
+
+```ts
+const result = await g8.api.dialerAnalytics.searchGradedCalls();
+```