@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/agency.d.ts

@@ -0,0 +1,556 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.agency` (Agency): 24 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"get_account_health_agency_reports_health_get">;
+ *
+ * Reference with examples: agency.md
+ */
+/* eslint-disable */
+
+/** `g8.api.agency.<member>` -> the operationId it calls. */
+export interface AgencyMembers {
+  getAccountHealth: "get_account_health_agency_reports_health_get";
+  getAgencyDialerDashboard: "get_agency_dialer_dashboard_agency_reports_dialer_dashboard_get";
+  getAgencyDialerLeaderboard: "get_agency_dialer_leaderboard_agency_reports_dialer_leaderboard_get";
+  getAgencyDialerQualityLeaderboard: "get_agency_dialer_quality_leaderboard_agency_reports_dialer_quality_leaderboard_get";
+  getAgencyLeaderboard: "get_agency_leaderboard_agency_reports_leaderboard_get";
+  getAgencyMe: "get_agency_me_agency_me_get";
+  getAgencySdrLeaderboard: "get_agency_sdr_leaderboard_agency_reports_sdr_leaderboard_get";
+  getAgencySequenceLeaderboard: "get_agency_sequence_leaderboard_agency_reports_sequence_leaderboard_get";
+  getAgencyTrends: "get_agency_trends_agency_reports_trends_get";
+  getClientComparison: "get_client_comparison_agency_reports_comparison_get";
+  getClientDeliverability: "get_client_deliverability_agency_reports_clients__org_id__deliverability_get";
+  getClientDetail: "get_client_detail_agency_reports_clients__org_id__get";
+  getClientSequences: "get_client_sequences_agency_reports_clients__org_id__sequences_get";
+  getConsolidatedSummary: "get_consolidated_summary_agency_reports_summary_get";
+  getCrossOrgDeliverability: "get_cross_org_deliverability_agency_reports_deliverability_get";
+  getMeetingsByChannel: "get_meetings_by_channel_agency_reports_meetings_by_channel_get";
+  getMeetingsCountForChannel: "get_meetings_count_for_channel_agency_reports_meetings_count_get";
+  getMeetingsLeaderboard: "get_meetings_leaderboard_agency_reports_meetings_get";
+  getVoiceAiAgentLeaderboard: "get_voice_ai_agent_leaderboard_agency_reports_voice_ai_agent_leaderboard_get";
+  getVoiceAiDashboard: "get_voice_ai_dashboard_agency_reports_voice_ai_dashboard_get";
+  getVoiceAiQualityLeaderboard: "get_voice_ai_quality_leaderboard_agency_reports_voice_ai_quality_leaderboard_get";
+  listAgencyClients: "list_agency_clients_agency_clients_get";
+  searchAgencyGradedCalls: "search_agency_graded_calls_agency_reports_dialer_grading_search_post";
+  searchVoiceAiGradedCalls: "search_voice_ai_graded_calls_agency_reports_voice_ai_grading_search_post";
+}
+
+/** Input and output of every `g8.api.agency` operation, keyed by operationId. */
+export interface AgencyOperations {
+  /**
+   * GET /agency/reports/health
+   * Get Account Health
+   * tier: read · scope: analytics:read
+   */
+  get_account_health_agency_reports_health_get: {
+    input: {
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/dialer/dashboard
+   * Get Agency Dialer Dashboard
+   * tier: read · scope: analytics:read
+   */
+  get_agency_dialer_dashboard_agency_reports_dialer_dashboard_get: {
+    input: {
+    query: {
+      /** Start date, `YYYY-MM-DD`. */
+      start_date: string;
+      /** End date, `YYYY-MM-DD`. */
+      end_date: string;
+      /** Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. */
+      org_filter?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/dialer/leaderboard
+   * Get Agency Dialer Leaderboard
+   * tier: read · scope: analytics:read
+   */
+  get_agency_dialer_leaderboard_agency_reports_dialer_leaderboard_get: {
+    input: {
+    query: {
+      /** Start date, `YYYY-MM-DD`. */
+      start_date: string;
+      /** End date, `YYYY-MM-DD`. */
+      end_date: string;
+      /** Metric to rank on. */
+      sort_by?: "dials" | "meetings_booked" | "connect_rate" | "talk_time_minutes" | "avg_quality_score";
+      /** Rows to return. */
+      limit?: number;
+      /** Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. */
+      org_filter?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/dialer/quality-leaderboard
+   * Get Agency Dialer Quality Leaderboard
+   * tier: read · scope: analytics:read
+   */
+  get_agency_dialer_quality_leaderboard_agency_reports_dialer_quality_leaderboard_get: {
+    input: {
+    query: {
+      /** Start date, `YYYY-MM-DD`. */
+      start_date: string;
+      /** End date, `YYYY-MM-DD`. */
+      end_date: string;
+      /** Rows to return. */
+      limit?: number;
+      /** Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. */
+      org_filter?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/leaderboard
+   * Get Agency Leaderboard
+   * tier: read · scope: analytics:read
+   */
+  get_agency_leaderboard_agency_reports_leaderboard_get: {
+    input: {
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+      /** Metric to rank on. */
+      sort_by?: "reply_rate" | "emails_sent" | "meetings_booked" | "connect_rate";
+      /** Rows to return. */
+      limit?: number;
+      /** Count `meetings_booked` from ONE source channel instead of all of them. Changes what the ranking means, so set it deliberately. */
+      meetings_channel?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/me
+   * Get Agency Me
+   * tier: read · scope: account:read
+   */
+  get_agency_me_agency_me_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * GET /agency/reports/sdr-leaderboard
+   * Get Agency Sdr Leaderboard
+   * tier: read · scope: analytics:read
+   */
+  get_agency_sdr_leaderboard_agency_reports_sdr_leaderboard_get: {
+    input: {
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+      /** Metric to rank on. */
+      sort_by?: "reply_rate" | "emails_sent" | "meetings_booked" | "activity_score" | "dials" | "connected" | "talk_time_minutes" | "grade_overall";
+      /** Rows to return. */
+      limit?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/sequence-leaderboard
+   * Get Agency Sequence Leaderboard
+   * tier: read · scope: analytics:read
+   */
+  get_agency_sequence_leaderboard_agency_reports_sequence_leaderboard_get: {
+    input: {
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+      /** Metric to rank on. */
+      sort_by?: "reply_rate" | "contacted" | "meetings_booked" | "voice_ai_dials";
+      /** Rows to return. */
+      limit?: number;
+      /** Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. */
+      org_filter?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/trends
+   * Get Agency Trends
+   * tier: read · scope: analytics:read
+   */
+  get_agency_trends_agency_reports_trends_get: {
+    input: {
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+      /** Bucket size. */
+      granularity?: "day" | "week";
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/comparison
+   * Get Client Comparison
+   * tier: read · scope: analytics:read
+   */
+  get_client_comparison_agency_reports_comparison_get: {
+    input: {
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/clients/{org_id}/deliverability
+   * Get Client Deliverability
+   * tier: read · scope: analytics:read
+   */
+  get_client_deliverability_agency_reports_clients__org_id__deliverability_get: {
+    input: {
+    path: {
+      /** Client org id. */
+      org_id: string;
+    };
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/clients/{org_id}
+   * Get Client Detail
+   * tier: read · scope: analytics:read
+   */
+  get_client_detail_agency_reports_clients__org_id__get: {
+    input: {
+    path: {
+      /** Client org id, from GET /agency/clients. */
+      org_id: string;
+    };
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/clients/{org_id}/sequences
+   * Get Client Sequences
+   * tier: read · scope: analytics:read
+   */
+  get_client_sequences_agency_reports_clients__org_id__sequences_get: {
+    input: {
+    path: {
+      /** Client org id. */
+      org_id: string;
+    };
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/summary
+   * Get Consolidated Summary
+   * tier: read · scope: analytics:read
+   */
+  get_consolidated_summary_agency_reports_summary_get: {
+    input: {
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/deliverability
+   * Get Cross Org Deliverability
+   * tier: read · scope: analytics:read
+   */
+  get_cross_org_deliverability_agency_reports_deliverability_get: {
+    input: {
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/meetings/by-channel
+   * Get Meetings By Channel
+   * tier: read · scope: analytics:read
+   */
+  get_meetings_by_channel_agency_reports_meetings_by_channel_get: {
+    input: {
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+      /** Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. */
+      org_filter?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/meetings/count
+   * Get Meetings Count For Channel
+   * tier: read · scope: analytics:read
+   */
+  get_meetings_count_for_channel_agency_reports_meetings_count_get: {
+    input: {
+    query: {
+      /** The single channel to count. */
+      channel: string;
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+      /** Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. */
+      org_filter?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/meetings
+   * Get Meetings Leaderboard
+   * tier: read · scope: analytics:read
+   */
+  get_meetings_leaderboard_agency_reports_meetings_get: {
+    input: {
+    query?: {
+      /** Trailing window, in days, ending today (UTC). */
+      days?: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/voice-ai/agent-leaderboard
+   * Get Voice Ai Agent Leaderboard
+   * tier: read · scope: analytics:read
+   */
+  get_voice_ai_agent_leaderboard_agency_reports_voice_ai_agent_leaderboard_get: {
+    input: {
+    query: {
+      /** Start date, `YYYY-MM-DD`. */
+      start_date: string;
+      /** End date, `YYYY-MM-DD`. */
+      end_date: string;
+      /** Metric to rank on. */
+      sort_by?: "calls_initiated" | "calls_completed" | "completion_rate" | "voicemails_left";
+      /** Rows to return. */
+      limit?: number;
+      /** Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. */
+      org_filter?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/voice-ai/dashboard
+   * Get Voice Ai Dashboard
+   * tier: read · scope: analytics:read
+   */
+  get_voice_ai_dashboard_agency_reports_voice_ai_dashboard_get: {
+    input: {
+    query: {
+      /** Start date, `YYYY-MM-DD`. */
+      start_date: string;
+      /** End date, `YYYY-MM-DD`. */
+      end_date: string;
+      /** Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. */
+      org_filter?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/reports/voice-ai/quality-leaderboard
+   * Get Voice Ai Quality Leaderboard
+   * tier: read · scope: analytics:read
+   */
+  get_voice_ai_quality_leaderboard_agency_reports_voice_ai_quality_leaderboard_get: {
+    input: {
+    query: {
+      /** Start date, `YYYY-MM-DD`. */
+      start_date: string;
+      /** End date, `YYYY-MM-DD`. */
+      end_date: string;
+      /** Rows to return. */
+      limit?: number;
+      /** Narrow to ONE client org. Silently ignored when it names an org outside this agency's authorized set - it can select within the set, never widen it. */
+      org_filter?: string | null;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * GET /agency/clients
+   * List Agency Clients
+   * tier: read · scope: account:read
+   */
+  list_agency_clients_agency_clients_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_dict__;
+  };
+  /**
+   * POST /agency/reports/dialer/grading/search
+   * Search Agency Graded Calls
+   * tier: read · scope: analytics:read
+   */
+  search_agency_graded_calls_agency_reports_dialer_grading_search_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: Record<string, unknown>;
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+  /**
+   * POST /agency/reports/voice-ai/grading/search
+   * Search Voice Ai Graded Calls
+   * tier: read · scope: analytics:read
+   */
+  search_voice_ai_graded_calls_agency_reports_voice_ai_grading_search_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: Record<string, unknown>;
+  };
+    output: ApiResponse_ReportPayload_;
+  };
+}
+
+// 5 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_ReportPayload_ {
+  data: ReportPayload;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_dict_ {
+  data: Record<string, unknown>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_dict__ {
+  data: Array<Record<string, unknown>>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface PaginationMeta {
+  /** Whether there are more pages */
+  has_next: boolean;
+  /** Items per page */
+  limit: number;
+  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
+  next_cursor?: string | null;
+  /** Current page number (1-indexed) */
+  page: number;
+  /** Total number of items */
+  total: number;
+}
+
+/**
+ * An OPEN envelope around one report's answer.
+ *
+ * The app wraps every one of these reports in `{success, data, meta}`, where
+ * `meta` carries the cache state, the window and - on the agency reports -
+ * `failed_org_ids`, the orgs that contributed NOTHING to the totals above.
+ * That field is the difference between "this client sent no email" and "we
+ * could not query this client", so it is forwarded rather than flattened
+ * away.
+ *
+ * Open on purpose: `data` is `dict | list` in the app and its contents grow
+ * with the product. A closed model would turn every new metric into a
+ * silently dropped one.
+ */
+export type ReportPayload = Record<string, unknown>;