@crevio/sdk 0.4.11 → 0.4.12

package/src/funcs/legalPagesGet.ts

@@ -0,0 +1,176 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CrevioCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.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 { CrevioError } from "../models/errors/crevioerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get legal page
+ *
+ * @remarks
+ * Returns a specific legal page by ID or slug
+ */
+export function legalPagesGet(
+  client: CrevioCore,
+  request: operations.GetLegalPageRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.LegalPage,
+    | errors.ErrorT
+    | CrevioError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CrevioCore,
+  request: operations.GetLegalPageRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.LegalPage,
+      | errors.ErrorT
+      | CrevioError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetLegalPageRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id_or_slug: encodeSimple("id_or_slug", payload.id_or_slug, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/legal_pages/{id_or_slug}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getLegalPage",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    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,
+    errorCodes: ["400", "401", "403", "404", "4XX", "500", "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<
+    models.LegalPage,
+    | errors.ErrorT
+    | CrevioError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.LegalPage$inboundSchema),
+    M.jsonErr([400, 401, 403, 404], errors.ErrorT$inboundSchema),
+    M.jsonErr(500, errors.ErrorT$inboundSchema),
+    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/legalPagesList.ts

@@ -0,0 +1,179 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CrevioCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.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 { CrevioError } from "../models/errors/crevioerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List legal pages
+ *
+ * @remarks
+ * Returns a list of legal pages (Terms of Service, Privacy Policy, Refund Policy)
+ */
+export function legalPagesList(
+  client: CrevioCore,
+  request?: operations.ListLegalPagesRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.ListResponseLegalPage,
+    | errors.ErrorT
+    | CrevioError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CrevioCore,
+  request?: operations.ListLegalPagesRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.ListResponseLegalPage,
+      | errors.ErrorT
+      | CrevioError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.ListLegalPagesRequest$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/legal_pages")();
+
+  const query = encodeFormQuery({
+    "limit": payload?.limit,
+    "policy_type": payload?.policy_type,
+    "query": payload?.query,
+    "starting_after": payload?.starting_after,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listLegalPages",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    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,
+    query: query,
+    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,
+    errorCodes: ["400", "401", "403", "4XX", "500", "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<
+    models.ListResponseLegalPage,
+    | errors.ErrorT
+    | CrevioError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.ListResponseLegalPage$inboundSchema),
+    M.jsonErr([400, 401, 403], errors.ErrorT$inboundSchema),
+    M.jsonErr(500, errors.ErrorT$inboundSchema),
+    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/lib/config.ts

@@ -61,7 +61,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "0.4.11",
+  sdkVersion: "0.4.12",
   genVersion: "2.869.23",
-  userAgent: "speakeasy-sdk/typescript 0.4.11 2.869.23 1.0.0 @crevio/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.4.12 2.869.23 1.0.0 @crevio/sdk",
 } as const;

package/src/models/index.ts

@@ -25,6 +25,7 @@ export * from "./file.js";
 export * from "./filecreateresponse.js";
 export * from "./invoice.js";
 export * from "./invoicerequest.js";
+export * from "./legalpage.js";
 export * from "./listresponseblogpost.js";
 export * from "./listresponsecheckoutlink.js";
 export * from "./listresponsecustomer.js";
@@ -32,6 +33,7 @@ export * from "./listresponsediscount.js";
 export * from "./listresponseexperience.js";
 export * from "./listresponsefile.js";
 export * from "./listresponseinvoice.js";
+export * from "./listresponselegalpage.js";
 export * from "./listresponseorder.js";
 export * from "./listresponsepricevariant.js";
 export * from "./listresponseproduct.js";

package/src/models/legalpage.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+
+export const PolicyType = {
+  TermsOfService: "terms_of_service",
+  PrivacyPolicy: "privacy_policy",
+  RefundPolicy: "refund_policy",
+} as const;
+export type PolicyType = ClosedEnum<typeof PolicyType>;
+
+export type LegalPage = {
+  object: string;
+  id: string;
+  title: string;
+  slug: string;
+  body: string;
+  policyType: PolicyType;
+  createdAt: Date;
+  updatedAt: Date;
+};
+
+/** @internal */
+export const PolicyType$inboundSchema: z.ZodNativeEnum<typeof PolicyType> = z
+  .nativeEnum(PolicyType);
+
+/** @internal */
+export const LegalPage$inboundSchema: z.ZodType<
+  LegalPage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: z.string(),
+  id: z.string(),
+  title: z.string(),
+  slug: z.string(),
+  body: z.string(),
+  policy_type: PolicyType$inboundSchema,
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+}).transform((v) => {
+  return remap$(v, {
+    "policy_type": "policyType",
+    "created_at": "createdAt",
+    "updated_at": "updatedAt",
+  });
+});
+
+export function legalPageFromJSON(
+  jsonString: string,
+): SafeParseResult<LegalPage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LegalPage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LegalPage' from JSON`,
+  );
+}

package/src/models/listresponselegalpage.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import { LegalPage, LegalPage$inboundSchema } from "./legalpage.js";
+
+export const ListResponseLegalPageObject = {
+  List: "list",
+} as const;
+export type ListResponseLegalPageObject = ClosedEnum<
+  typeof ListResponseLegalPageObject
+>;
+
+export type ListResponseLegalPage = {
+  object: ListResponseLegalPageObject;
+  data: Array<LegalPage>;
+  hasMore: boolean;
+  url: string;
+};
+
+/** @internal */
+export const ListResponseLegalPageObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListResponseLegalPageObject
+> = z.nativeEnum(ListResponseLegalPageObject);
+
+/** @internal */
+export const ListResponseLegalPage$inboundSchema: z.ZodType<
+  ListResponseLegalPage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  object: ListResponseLegalPageObject$inboundSchema,
+  data: z.array(LegalPage$inboundSchema),
+  has_more: z.boolean(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+  });
+});
+
+export function listResponseLegalPageFromJSON(
+  jsonString: string,
+): SafeParseResult<ListResponseLegalPage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListResponseLegalPage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListResponseLegalPage' from JSON`,
+  );
+}

package/src/models/operations/getlegalpage.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type GetLegalPageRequest = {
+  /**
+   * The resource prefix ID (e.g., "prod_abc123") or slug (e.g., "my-product")
+   */
+  idOrSlug: string;
+};
+
+/** @internal */
+export type GetLegalPageRequest$Outbound = {
+  id_or_slug: string;
+};
+
+/** @internal */
+export const GetLegalPageRequest$outboundSchema: z.ZodType<
+  GetLegalPageRequest$Outbound,
+  z.ZodTypeDef,
+  GetLegalPageRequest
+> = z.object({
+  idOrSlug: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    idOrSlug: "id_or_slug",
+  });
+});
+
+export function getLegalPageRequestToJSON(
+  getLegalPageRequest: GetLegalPageRequest,
+): string {
+  return JSON.stringify(
+    GetLegalPageRequest$outboundSchema.parse(getLegalPageRequest),
+  );
+}

package/src/models/operations/index.ts

@@ -19,6 +19,7 @@ export * from "./getdiscount.js";
 export * from "./getexperience.js";
 export * from "./getfile.js";
 export * from "./getinvoice.js";
+export * from "./getlegalpage.js";
 export * from "./getorder.js";
 export * from "./getorderitem.js";
 export * from "./getpricevariant.js";
@@ -33,6 +34,7 @@ export * from "./listdiscounts.js";
 export * from "./listexperiences.js";
 export * from "./listfiles.js";
 export * from "./listinvoices.js";
+export * from "./listlegalpages.js";
 export * from "./listorders.js";
 export * from "./listpricevariants.js";
 export * from "./listproducts.js";

package/src/models/operations/listlegalpages.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Filter by policy type: terms_of_service, privacy_policy, refund_policy
+ */
+export const PolicyType = {
+  TermsOfService: "terms_of_service",
+  PrivacyPolicy: "privacy_policy",
+  RefundPolicy: "refund_policy",
+} as const;
+/**
+ * Filter by policy type: terms_of_service, privacy_policy, refund_policy
+ */
+export type PolicyType = ClosedEnum<typeof PolicyType>;
+
+export type ListLegalPagesRequest = {
+  /**
+   * Filter by policy type: terms_of_service, privacy_policy, refund_policy
+   */
+  policyType?: PolicyType | undefined;
+  /**
+   * Search by title
+   */
+  query?: string | undefined;
+  /**
+   * Cursor for pagination — the ID of the last item in the previous page
+   */
+  startingAfter?: string | undefined;
+  /**
+   * Items per page
+   */
+  limit?: number | undefined;
+};
+
+/** @internal */
+export const PolicyType$outboundSchema: z.ZodNativeEnum<typeof PolicyType> = z
+  .nativeEnum(PolicyType);
+
+/** @internal */
+export type ListLegalPagesRequest$Outbound = {
+  policy_type?: string | undefined;
+  query?: string | undefined;
+  starting_after?: string | undefined;
+  limit: number;
+};
+
+/** @internal */
+export const ListLegalPagesRequest$outboundSchema: z.ZodType<
+  ListLegalPagesRequest$Outbound,
+  z.ZodTypeDef,
+  ListLegalPagesRequest
+> = z.object({
+  policyType: PolicyType$outboundSchema.optional(),
+  query: z.string().optional(),
+  startingAfter: z.string().optional(),
+  limit: z.number().int().default(20),
+}).transform((v) => {
+  return remap$(v, {
+    policyType: "policy_type",
+    startingAfter: "starting_after",
+  });
+});
+
+export function listLegalPagesRequestToJSON(
+  listLegalPagesRequest: ListLegalPagesRequest,
+): string {
+  return JSON.stringify(
+    ListLegalPagesRequest$outboundSchema.parse(listLegalPagesRequest),
+  );
+}

package/src/sdk/legalpages.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { legalPagesGet } from "../funcs/legalPagesGet.js";
+import { legalPagesList } from "../funcs/legalPagesList.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class LegalPages extends ClientSDK {
+  /**
+   * List legal pages
+   *
+   * @remarks
+   * Returns a list of legal pages (Terms of Service, Privacy Policy, Refund Policy)
+   */
+  async list(
+    request?: operations.ListLegalPagesRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.ListResponseLegalPage> {
+    return unwrapAsync(legalPagesList(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get legal page
+   *
+   * @remarks
+   * Returns a specific legal page by ID or slug
+   */
+  async get(
+    request: operations.GetLegalPageRequest,
+    options?: RequestOptions,
+  ): Promise<models.LegalPage> {
+    return unwrapAsync(legalPagesGet(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -13,6 +13,7 @@ import { Discounts } from "./discounts.js";
 import { Experiences } from "./experiences.js";
 import { Files } from "./files.js";
 import { Invoices } from "./invoices.js";
+import { LegalPages } from "./legalpages.js";
 import { Me } from "./me.js";
 import { OrderItems } from "./orderitems.js";
 import { Orders } from "./orders.js";
@@ -89,6 +90,11 @@ export class Crevio extends ClientSDK {
     return (this._blogPosts ??= new BlogPosts(this._options));
   }
 
+  private _legalPages?: LegalPages;
+  get legalPages(): LegalPages {
+    return (this._legalPages ??= new LegalPages(this._options));
+  }
+
   private _webhookEndpoints?: WebhookEndpoints;
   get webhookEndpoints(): WebhookEndpoints {
     return (this._webhookEndpoints ??= new WebhookEndpoints(this._options));