@elmohq/sdk 0.0.0-stage → 0.1.0

package/src/calls/competitors-update.ts

@@ -0,0 +1,24 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { mergeParams, placeParams } from '../internal/core/params';
+import { updateCompetitorDescriptor, updateCompetitorFields } from '../resources/competitors';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type {
+  UpdateCompetitorErrors,
+  UpdateCompetitorParams,
+  UpdateCompetitorResponses,
+} from '../types/competitors';
+
+/** Update a competitor */
+export function competitorsUpdate(
+  client: Client,
+  competitorId: string,
+  params: UpdateCompetitorParams,
+  options?: RequestOptions,
+): RestCallPromise<UpdateCompetitorResponses, UpdateCompetitorErrors> {
+  return callPromise(
+    options?.client ?? client,
+    updateCompetitorDescriptor,
+    mergeParams(placeParams({ ...params, competitorId }, updateCompetitorFields, 'body'), options),
+  );
+}

package/src/calls/index.ts

@@ -0,0 +1,33 @@
+export { brandsAnalyticsGet } from './brands-analytics-get';
+export { brandsCitationsDomainsList } from './brands-citations-domains-list';
+export { brandsCitationsURLsList } from './brands-citations-urls-list';
+export { brandsCreate } from './brands-create';
+export { brandsGet } from './brands-get';
+export { brandsList } from './brands-list';
+export { brandsOpportunitiesGet } from './brands-opportunities-get';
+export { brandsPromptPerformanceList } from './brands-prompt-performance-list';
+export { brandsQueryFanoutGet } from './brands-query-fanout-get';
+export { brandsTagsList } from './brands-tags-list';
+export { brandsUpdate } from './brands-update';
+export { competitorsCreate } from './competitors-create';
+export { competitorsDelete } from './competitors-delete';
+export { competitorsGet } from './competitors-get';
+export { competitorsList } from './competitors-list';
+export { competitorsUpdate } from './competitors-update';
+export { meGet } from './me-get';
+export { modelsList } from './models-list';
+export { organizationsBillingGet } from './organizations-billing-get';
+export { organizationsGet } from './organizations-get';
+export { organizationsList } from './organizations-list';
+export { promptsCreate } from './prompts-create';
+export { promptsDelete } from './prompts-delete';
+export { promptsGet } from './prompts-get';
+export { promptsList } from './prompts-list';
+export { promptsRunsGet } from './prompts-runs-get';
+export { promptsRunsList } from './prompts-runs-list';
+export { promptsSnapshotGet } from './prompts-snapshot-get';
+export { promptsUpdate } from './prompts-update';
+export { reportsCreate } from './reports-create';
+export { reportsGet } from './reports-get';
+export { reportsList } from './reports-list';
+export { toolsAnalyze } from './tools-analyze';

package/src/calls/me-get.ts

@@ -0,0 +1,18 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { getMeDescriptor } from '../resources/identity';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type { GetMeErrors, GetMeResponses } from '../types/identity';
+
+/**
+ * Describe the calling key
+ *
+ * What this key is, which organization and brands it reaches, and which scopes it holds. Requires
+ * no scope, so it is always safe to call first when wiring up an integration.
+ */
+export function meGet(
+  client: Client,
+  options?: RequestOptions,
+): RestCallPromise<GetMeResponses, GetMeErrors> {
+  return callPromise(options?.client ?? client, getMeDescriptor, options);
+}

package/src/calls/models-list.ts

@@ -0,0 +1,20 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { listModelsDescriptor } from '../resources/models';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type { ListModelsErrors, ListModelsResponses } from '../types/models';
+
+/**
+ * List trackable models
+ *
+ * The answer engines this deployment can track, so a client can build a model filter without
+ * hardcoding ids that differ between deployments.
+ *
+ * Requires no scope.
+ */
+export function modelsList(
+  client: Client,
+  options?: RequestOptions,
+): RestCallPromise<ListModelsResponses, ListModelsErrors> {
+  return callPromise(options?.client ?? client, listModelsDescriptor, options);
+}

package/src/calls/organizations-billing-get.ts

@@ -0,0 +1,37 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { mergeParams, placeParams } from '../internal/core/params';
+import {
+  getOrganizationBillingDescriptor,
+  getOrganizationBillingFields,
+} from '../resources/organizations';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type {
+  GetOrganizationBillingErrors,
+  GetOrganizationBillingResponses,
+} from '../types/organizations';
+
+/**
+ * Get billing state
+ *
+ * The organization's plan, its limits, and how much of each limit is already spent — enough for an
+ * integration to know a write will be rejected before attempting it.
+ *
+ * This endpoint is read-only by construction. No API key of any kind can change a subscription, an
+ * add-on quantity, or a payment method; there is no billing write endpoint and no billing write
+ * scope. Stripe identifiers, invoices, and payment methods are never returned.
+ *
+ * Deployments without billing answer `200` with `billingEnabled: false`, a null plan, and null
+ * limits, so callers need no special case.
+ */
+export function organizationsBillingGet(
+  client: Client,
+  organizationId: string,
+  options?: RequestOptions,
+): RestCallPromise<GetOrganizationBillingResponses, GetOrganizationBillingErrors> {
+  return callPromise(
+    options?.client ?? client,
+    getOrganizationBillingDescriptor,
+    mergeParams(placeParams({ organizationId }, getOrganizationBillingFields, 'query'), options),
+  );
+}

package/src/calls/organizations-get.ts

@@ -0,0 +1,24 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { mergeParams, placeParams } from '../internal/core/params';
+import { getOrganizationDescriptor, getOrganizationFields } from '../resources/organizations';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type { GetOrganizationErrors, GetOrganizationResponses } from '../types/organizations';
+
+/**
+ * Get an organization
+ *
+ * No scope required. An organization outside the key's reach answers `404`, identically to one that
+ * does not exist.
+ */
+export function organizationsGet(
+  client: Client,
+  organizationId: string,
+  options?: RequestOptions,
+): RestCallPromise<GetOrganizationResponses, GetOrganizationErrors> {
+  return callPromise(
+    options?.client ?? client,
+    getOrganizationDescriptor,
+    mergeParams(placeParams({ organizationId }, getOrganizationFields, 'query'), options),
+  );
+}

package/src/calls/organizations-list.ts

@@ -0,0 +1,27 @@
+import type { Client } from '../internal/core/client';
+import { groupParams, mergeParams } from '../internal/core/params';
+import { PagePromise, pages } from '../internal/page/page';
+import { listOrganizationsDescriptor } from '../resources/organizations';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type {
+  ListOrganizationsErrors,
+  ListOrganizationsParams,
+  Organization,
+  OrganizationList,
+} from '../types/organizations';
+
+/**
+ * One entry for an organization key — the one it acts inside. Every organization for an instance
+ * admin key. No scope required: a key can only ever see the organization it is already bound to.
+ */
+export function organizationsList(
+  client: Client,
+  params?: ListOrganizationsParams,
+  options?: RequestOptions,
+): PagePromise<Organization, OrganizationList, ListOrganizationsErrors> {
+  return pages(
+    options?.client ?? client,
+    listOrganizationsDescriptor,
+    mergeParams(groupParams(params, 'query'), options),
+  );
+}

package/src/calls/prompts-create.ts

@@ -0,0 +1,27 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { groupParams, mergeParams } from '../internal/core/params';
+import { createPromptDescriptor } from '../resources/prompts';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type {
+  CreatePromptErrors,
+  CreatePromptParams,
+  CreatePromptResponses,
+} from '../types/prompts';
+
+/**
+ * Create a new prompt
+ *
+ * Create a new prompt for a brand. This will automatically schedule the prompt for execution.
+ */
+export function promptsCreate(
+  client: Client,
+  params: CreatePromptParams,
+  options?: RequestOptions,
+): RestCallPromise<CreatePromptResponses, CreatePromptErrors> {
+  return callPromise(
+    options?.client ?? client,
+    createPromptDescriptor,
+    mergeParams(groupParams(params, 'body'), options),
+  );
+}

package/src/calls/prompts-delete.ts

@@ -0,0 +1,28 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { mergeParams, placeParams } from '../internal/core/params';
+import { deletePromptDescriptor, deletePromptFields } from '../resources/prompts';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type { DeletePromptErrors, DeletePromptResponses } from '../types/prompts';
+
+/**
+ * Delete a prompt
+ *
+ * Permanently delete a prompt and cancel all related scheduled jobs. This will also cascade delete
+ * all associated prompt runs.
+ *
+ * Requires an instance admin key; organization keys receive `403`. The dashboard has no delete
+ * either — stop tracking a prompt with `promptsUpdate()` and `enabled: false`, which keeps its
+ * history and frees the plan slot.
+ */
+export function promptsDelete(
+  client: Client,
+  promptId: string,
+  options?: RequestOptions,
+): RestCallPromise<DeletePromptResponses, DeletePromptErrors> {
+  return callPromise(
+    options?.client ?? client,
+    deletePromptDescriptor,
+    mergeParams(placeParams({ promptId }, deletePromptFields, 'query'), options),
+  );
+}

package/src/calls/prompts-get.ts

@@ -0,0 +1,23 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { mergeParams, placeParams } from '../internal/core/params';
+import { getPromptDescriptor, getPromptFields } from '../resources/prompts';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type { GetPromptErrors, GetPromptResponses } from '../types/prompts';
+
+/**
+ * Get a prompt
+ *
+ * Retrieve a specific prompt by ID
+ */
+export function promptsGet(
+  client: Client,
+  promptId: string,
+  options?: RequestOptions,
+): RestCallPromise<GetPromptResponses, GetPromptErrors> {
+  return callPromise(
+    options?.client ?? client,
+    getPromptDescriptor,
+    mergeParams(placeParams({ promptId }, getPromptFields, 'query'), options),
+  );
+}

package/src/calls/prompts-list.ts

@@ -0,0 +1,28 @@
+import type { Client } from '../internal/core/client';
+import { groupParams, mergeParams } from '../internal/core/params';
+import { PagePromise, pages } from '../internal/page/page';
+import { listPromptsDescriptor } from '../resources/prompts';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type {
+  ListPromptsErrors,
+  ListPromptsParams,
+  ListPromptsResponse,
+  Prompt,
+} from '../types/prompts';
+
+/**
+ * List all prompts
+ *
+ * Retrieve a paginated list of all prompts across all brands
+ */
+export function promptsList(
+  client: Client,
+  params?: ListPromptsParams,
+  options?: RequestOptions,
+): PagePromise<Prompt, ListPromptsResponse, ListPromptsErrors> {
+  return pages(
+    options?.client ?? client,
+    listPromptsDescriptor,
+    mergeParams(groupParams(params, 'query'), options),
+  );
+}

package/src/calls/prompts-runs-get.ts

@@ -0,0 +1,27 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { mergeParams, placeParams } from '../internal/core/params';
+import { getRunDescriptor, getRunFields } from '../resources/runs';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type { GetRunErrors, GetRunResponses } from '../types/runs';
+
+/**
+ * Get a run
+ *
+ * One model answer, with its text normalized out of the provider’s response and its citations in
+ * the order the engine listed them. A run belonging to some other prompt answers `404`. The
+ * provider’s raw payload is deliberately not exposed — its shape belongs to the provider, not to
+ * this API.
+ */
+export function promptsRunsGet(
+  client: Client,
+  promptId: string,
+  runId: string,
+  options?: RequestOptions,
+): RestCallPromise<GetRunResponses, GetRunErrors> {
+  return callPromise(
+    options?.client ?? client,
+    getRunDescriptor,
+    mergeParams(placeParams({ promptId, runId }, getRunFields, 'query'), options),
+  );
+}

package/src/calls/prompts-runs-list.ts

@@ -0,0 +1,30 @@
+import type { Client } from '../internal/core/client';
+import { mergeParams, placeParams } from '../internal/core/params';
+import { PagePromise, pages } from '../internal/page/page';
+import { listPromptRunsDescriptor, listPromptRunsFields } from '../resources/runs';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type {
+  ListPromptRunsErrors,
+  ListPromptRunsParams,
+  RunList,
+  RunSummary,
+} from '../types/runs';
+
+/**
+ * List runs for a prompt
+ *
+ * Individual model answers behind the aggregates, newest first, without their text — the list stays
+ * small enough to page through. Fetch `promptsRunsGet()` for the answer itself.
+ */
+export function promptsRunsList(
+  client: Client,
+  promptId: string,
+  params: ListPromptRunsParams,
+  options?: RequestOptions,
+): PagePromise<RunSummary, RunList, ListPromptRunsErrors> {
+  return pages(
+    options?.client ?? client,
+    listPromptRunsDescriptor,
+    mergeParams(placeParams({ ...params, promptId }, listPromptRunsFields, 'query'), options),
+  );
+}

package/src/calls/prompts-snapshot-get.ts

@@ -0,0 +1,28 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { mergeParams, placeParams } from '../internal/core/params';
+import type { RequestOptions } from '../resources/shared/request-options';
+import { getPromptSnapshotDescriptor, getPromptSnapshotFields } from '../resources/snapshots';
+import type {
+  GetPromptSnapshotErrors,
+  GetPromptSnapshotParams,
+  GetPromptSnapshotResponses,
+} from '../types/snapshots';
+
+/**
+ * Get an aggregated snapshot of mention and citation analytics for a specific prompt over a date
+ * range. Use this to identify competitive gaps, track brand visibility trends, and discover top
+ * cited URLs.
+ */
+export function promptsSnapshotGet(
+  client: Client,
+  promptId: string,
+  params: GetPromptSnapshotParams,
+  options?: RequestOptions,
+): RestCallPromise<GetPromptSnapshotResponses, GetPromptSnapshotErrors> {
+  return callPromise(
+    options?.client ?? client,
+    getPromptSnapshotDescriptor,
+    mergeParams(placeParams({ ...params, promptId }, getPromptSnapshotFields, 'query'), options),
+  );
+}

package/src/calls/prompts-update.ts

@@ -0,0 +1,29 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { mergeParams, placeParams } from '../internal/core/params';
+import { updatePromptDescriptor, updatePromptFields } from '../resources/prompts';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type {
+  UpdatePromptErrors,
+  UpdatePromptParams,
+  UpdatePromptResponses,
+} from '../types/prompts';
+
+/**
+ * Update a prompt
+ *
+ * Update a prompt's properties. Only provided fields will be updated. Toggling `enabled` schedules
+ * or unschedules the recurring run job.
+ */
+export function promptsUpdate(
+  client: Client,
+  promptId: string,
+  params: UpdatePromptParams,
+  options?: RequestOptions,
+): RestCallPromise<UpdatePromptResponses, UpdatePromptErrors> {
+  return callPromise(
+    options?.client ?? client,
+    updatePromptDescriptor,
+    mergeParams(placeParams({ ...params, promptId }, updatePromptFields, 'body'), options),
+  );
+}

package/src/calls/reports-create.ts

@@ -0,0 +1,31 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { groupParams, mergeParams } from '../internal/core/params';
+import { createReportDescriptor } from '../resources/reports';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type {
+  CreateReportErrors,
+  CreateReportParams,
+  CreateReportResponses,
+} from '../types/reports';
+
+/**
+ * Create a report
+ *
+ * Create a new AI Share of Voice report and queue it for generation. The report will evaluate the
+ * brand across multiple AI engines (ChatGPT, Claude, Google AI) using generated and optional custom
+ * prompts.
+ *
+ * Requires an instance admin key; organization keys receive `403`.
+ */
+export function reportsCreate(
+  client: Client,
+  params: CreateReportParams,
+  options?: RequestOptions,
+): RestCallPromise<CreateReportResponses, CreateReportErrors> {
+  return callPromise(
+    options?.client ?? client,
+    createReportDescriptor,
+    mergeParams(groupParams(params, 'body'), options),
+  );
+}

package/src/calls/reports-get.ts

@@ -0,0 +1,27 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { mergeParams, placeParams } from '../internal/core/params';
+import { getReportDescriptor, getReportFields } from '../resources/reports';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type { GetReportErrors, GetReportParams, GetReportResponses } from '../types/reports';
+
+/**
+ * Get report status and data
+ *
+ * Poll a report's status. When completed, returns per-prompt snapshot data with raw mention counts.
+ * Consumers are responsible for computing SoV and other derived metrics from the raw data.
+ *
+ * Requires an instance admin key; organization keys receive `403`.
+ */
+export function reportsGet(
+  client: Client,
+  reportId: string,
+  params?: GetReportParams,
+  options?: RequestOptions,
+): RestCallPromise<GetReportResponses, GetReportErrors> {
+  return callPromise(
+    options?.client ?? client,
+    getReportDescriptor,
+    mergeParams(placeParams({ ...params, reportId }, getReportFields, 'query'), options),
+  );
+}

package/src/calls/reports-list.ts

@@ -0,0 +1,28 @@
+import type { Client } from '../internal/core/client';
+import { groupParams, mergeParams } from '../internal/core/params';
+import { PagePromise, pages } from '../internal/page/page';
+import { listReportsDescriptor } from '../resources/reports';
+import type { RequestOptions } from '../resources/shared/request-options';
+import type {
+  ListReportsErrors,
+  ListReportsParams,
+  ListReportsResponse,
+  ReportSummary,
+} from '../types/reports';
+
+/**
+ * Retrieve a paginated list of all reports, ordered by creation date (newest first).
+ *
+ * Requires an instance admin key; organization keys receive `403`.
+ */
+export function reportsList(
+  client: Client,
+  params?: ListReportsParams,
+  options?: RequestOptions,
+): PagePromise<ReportSummary, ListReportsResponse, ListReportsErrors> {
+  return pages(
+    options?.client ?? client,
+    listReportsDescriptor,
+    mergeParams(groupParams(params, 'query'), options),
+  );
+}

package/src/calls/tools-analyze.ts

@@ -0,0 +1,26 @@
+import { callPromise, RestCallPromise } from '../internal/core/call-promise';
+import type { Client } from '../internal/core/client';
+import { groupParams, mergeParams } from '../internal/core/params';
+import type { RequestOptions } from '../resources/shared/request-options';
+import { analyzeBrandDescriptor } from '../resources/tools';
+import type { AnalyzeBrandErrors, AnalyzeBrandParams, AnalyzeBrandResponses } from '../types/tools';
+
+/**
+ * Analyze a website
+ *
+ * Run brand analysis without persisting anything. Returns suggested additional domains, aliases,
+ * competitors, and prompts.
+ *
+ * Requires an instance admin key; organization keys receive `403`.
+ */
+export function toolsAnalyze(
+  client: Client,
+  params: AnalyzeBrandParams,
+  options?: RequestOptions,
+): RestCallPromise<AnalyzeBrandResponses, AnalyzeBrandErrors> {
+  return callPromise(
+    options?.client ?? client,
+    analyzeBrandDescriptor,
+    mergeParams(groupParams(params, 'body'), options),
+  );
+}