@versedbcom/sdk 0.1.1

package/src/funcs/story-arcs-get-story-arc-detail.ts

@@ -0,0 +1,194 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { VerseDBCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import { VerseDbError } from "../models/errors/verse-db-error.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get story arc detail.
+ *
+ * @remarks
+ * Returns full story arc detail with the primary and secondary universes,
+ * a denormalized characters count, the start/end issue summaries (each
+ * with its parent series), and the last user who edited the arc.
+ *
+ * Paginated relationship data lives on dedicated nested endpoints:
+ * - GET /story-arcs/{id}/issues - Issues in the arc, in reading order
+ * - GET /story-arcs/{id}/series - Series spanned by the arc
+ * - GET /story-arcs/{id}/characters - Characters appearing in the arc
+ */
+export function storyArcsGetStoryArcDetail(
+  client: VerseDBCore,
+  request: operations.GetStoryArcDetailRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetStoryArcDetailResponse,
+    | errors.GetStoryArcDetailUnauthorizedError
+    | errors.GetStoryArcDetailTooManyRequestsError
+    | VerseDbError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: VerseDBCore,
+  request: operations.GetStoryArcDetailRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetStoryArcDetailResponse,
+      | errors.GetStoryArcDetailUnauthorizedError
+      | errors.GetStoryArcDetailTooManyRequestsError
+      | VerseDbError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(operations.GetStoryArcDetailRequest$outboundSchema, value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    storyArc_id: encodeSimple("storyArc_id", payload.storyArc_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/api/v1/story-arcs/{storyArc_id}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.default);
+  const securityInput = secConfig == null ? {} : { default: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getStoryArcDetail",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.default,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.GetStoryArcDetailResponse,
+    | errors.GetStoryArcDetailUnauthorizedError
+    | errors.GetStoryArcDetailTooManyRequestsError
+    | VerseDbError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetStoryArcDetailResponse$inboundSchema, {
+      hdrs: true,
+      key: "Result",
+    }),
+    M.jsonErr(401, errors.GetStoryArcDetailUnauthorizedError$inboundSchema),
+    M.jsonErr(429, errors.GetStoryArcDetailTooManyRequestsError$inboundSchema, {
+      hdrs: true,
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/story-arcs-get-story-arcs-for-a-specific-character.ts

@@ -0,0 +1,208 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { VerseDBCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import { VerseDbError } from "../models/errors/verse-db-error.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get story arcs for a specific character
+ *
+ * @remarks
+ * Requires PRO subscription on the User API (`/api/...`). Returns 402 Payment Required for non-PRO users on that prefix.
+ * The Mobile API (`/mobile/api/...`) is unrestricted — its route group does not apply the `pro.api` middleware.
+ */
+export function storyArcsGetStoryArcsForASpecificCharacter(
+  client: VerseDBCore,
+  request: operations.GetStoryArcsForASpecificCharacterRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetStoryArcsForASpecificCharacterResponse,
+    | errors.GetStoryArcsForASpecificCharacterUnauthorizedError
+    | errors.GetStoryArcsForASpecificCharacterPaymentRequiredError
+    | errors.GetStoryArcsForASpecificCharacterTooManyRequestsError
+    | VerseDbError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: VerseDBCore,
+  request: operations.GetStoryArcsForASpecificCharacterRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetStoryArcsForASpecificCharacterResponse,
+      | errors.GetStoryArcsForASpecificCharacterUnauthorizedError
+      | errors.GetStoryArcsForASpecificCharacterPaymentRequiredError
+      | errors.GetStoryArcsForASpecificCharacterTooManyRequestsError
+      | VerseDbError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(
+        operations.GetStoryArcsForASpecificCharacterRequest$outboundSchema,
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    character_id: encodeSimple("character_id", payload.character_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/api/v1/characters/{character_id}/story-arcs")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.default);
+  const securityInput = secConfig == null ? {} : { default: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getStoryArcsForASpecificCharacter",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.default,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.GetStoryArcsForASpecificCharacterResponse,
+    | errors.GetStoryArcsForASpecificCharacterUnauthorizedError
+    | errors.GetStoryArcsForASpecificCharacterPaymentRequiredError
+    | errors.GetStoryArcsForASpecificCharacterTooManyRequestsError
+    | VerseDbError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.GetStoryArcsForASpecificCharacterResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
+    M.jsonErr(
+      401,
+      errors.GetStoryArcsForASpecificCharacterUnauthorizedError$inboundSchema,
+    ),
+    M.jsonErr(
+      402,
+      errors
+        .GetStoryArcsForASpecificCharacterPaymentRequiredError$inboundSchema,
+    ),
+    M.jsonErr(
+      429,
+      errors
+        .GetStoryArcsForASpecificCharacterTooManyRequestsError$inboundSchema,
+      { hdrs: true },
+    ),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/story-arcs-get-story-arcs-for-a-specific-issue.ts

@@ -0,0 +1,204 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { VerseDBCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import { VerseDbError } from "../models/errors/verse-db-error.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get story arcs for a specific issue
+ *
+ * @remarks
+ * Requires PRO subscription on the User API (`/api/...`). Returns 402 Payment Required for non-PRO users on that prefix.
+ * The Mobile API (`/mobile/api/...`) is unrestricted — its route group does not apply the `pro.api` middleware.
+ */
+export function storyArcsGetStoryArcsForASpecificIssue(
+  client: VerseDBCore,
+  request: operations.GetStoryArcsForASpecificIssueRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetStoryArcsForASpecificIssueResponse,
+    | errors.GetStoryArcsForASpecificIssueUnauthorizedError
+    | errors.GetStoryArcsForASpecificIssuePaymentRequiredError
+    | errors.GetStoryArcsForASpecificIssueTooManyRequestsError
+    | VerseDbError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: VerseDBCore,
+  request: operations.GetStoryArcsForASpecificIssueRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetStoryArcsForASpecificIssueResponse,
+      | errors.GetStoryArcsForASpecificIssueUnauthorizedError
+      | errors.GetStoryArcsForASpecificIssuePaymentRequiredError
+      | errors.GetStoryArcsForASpecificIssueTooManyRequestsError
+      | VerseDbError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(
+        operations.GetStoryArcsForASpecificIssueRequest$outboundSchema,
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    issue_id: encodeSimple("issue_id", payload.issue_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/api/v1/issues/{issue_id}/story-arcs")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.default);
+  const securityInput = secConfig == null ? {} : { default: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getStoryArcsForASpecificIssue",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.default,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.GetStoryArcsForASpecificIssueResponse,
+    | errors.GetStoryArcsForASpecificIssueUnauthorizedError
+    | errors.GetStoryArcsForASpecificIssuePaymentRequiredError
+    | errors.GetStoryArcsForASpecificIssueTooManyRequestsError
+    | VerseDbError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.GetStoryArcsForASpecificIssueResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
+    M.jsonErr(
+      401,
+      errors.GetStoryArcsForASpecificIssueUnauthorizedError$inboundSchema,
+    ),
+    M.jsonErr(
+      402,
+      errors.GetStoryArcsForASpecificIssuePaymentRequiredError$inboundSchema,
+    ),
+    M.jsonErr(
+      429,
+      errors.GetStoryArcsForASpecificIssueTooManyRequestsError$inboundSchema,
+      { hdrs: true },
+    ),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}