@polar-sh/sdk 0.17.3 → 0.18.0

package/src/funcs/articlesUpdate.ts

@@ -1,145 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { PolarCore } from "../core.js";
-import { encodeJSON, encodeSimple } from "../lib/encodings.js";
-import * as M from "../lib/matchers.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 * as components from "../models/components/index.js";
-import {
-  ConnectionError,
-  InvalidRequestError,
-  RequestAbortedError,
-  RequestTimeoutError,
-  UnexpectedClientError,
-} from "../models/errors/httpclienterrors.js";
-import * as errors from "../models/errors/index.js";
-import { SDKError } from "../models/errors/sdkerror.js";
-import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
-import * as operations from "../models/operations/index.js";
-import { Result } from "../types/fp.js";
-
-/**
- * Update Article
- *
- * @remarks
- * Update an article.
- */
-export async function articlesUpdate(
-  client: PolarCore,
-  request: operations.ArticlesUpdateRequest,
-  options?: RequestOptions,
-): Promise<
-  Result<
-    components.Article,
-    | errors.NotPermitted
-    | errors.ResourceNotFound
-    | errors.HTTPValidationError
-    | SDKError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >
-> {
-  const parsed = safeParse(
-    request,
-    (value) => operations.ArticlesUpdateRequest$outboundSchema.parse(value),
-    "Input validation failed",
-  );
-  if (!parsed.ok) {
-    return parsed;
-  }
-  const payload = parsed.value;
-  const body = encodeJSON("body", payload.ArticleUpdate, { explode: true });
-
-  const pathParams = {
-    id: encodeSimple("id", payload.id, {
-      explode: false,
-      charEncoding: "percent",
-    }),
-  };
-
-  const path = pathToFunc("/v1/articles/{id}")(pathParams);
-
-  const headers = new Headers({
-    "Content-Type": "application/json",
-    Accept: "application/json",
-  });
-
-  const secConfig = await extractSecurity(client._options.accessToken);
-  const securityInput = secConfig == null ? {} : { accessToken: secConfig };
-  const requestSecurity = resolveGlobalSecurity(securityInput);
-
-  const context = {
-    operationID: "articles:update",
-    oAuth2Scopes: [],
-
-    resolvedSecurity: requestSecurity,
-
-    securitySource: client._options.accessToken,
-    retryConfig: options?.retries
-      || client._options.retryConfig
-      || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
-  };
-
-  const requestRes = client._createRequest(context, {
-    security: requestSecurity,
-    method: "PATCH",
-    path: path,
-    headers: headers,
-    body: body,
-    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
-  }, options);
-  if (!requestRes.ok) {
-    return requestRes;
-  }
-  const req = requestRes.value;
-
-  const doResult = await client._do(req, {
-    context,
-    errorCodes: ["403", "404", "422", "4XX", "5XX"],
-    retryConfig: context.retryConfig,
-    retryCodes: context.retryCodes,
-  });
-  if (!doResult.ok) {
-    return doResult;
-  }
-  const response = doResult.value;
-
-  const responseFields = {
-    HttpMeta: { Response: response, Request: req },
-  };
-
-  const [result] = await M.match<
-    components.Article,
-    | errors.NotPermitted
-    | errors.ResourceNotFound
-    | errors.HTTPValidationError
-    | SDKError
-    | SDKValidationError
-    | UnexpectedClientError
-    | InvalidRequestError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | ConnectionError
-  >(
-    M.json(200, components.Article$inboundSchema),
-    M.jsonErr(403, errors.NotPermitted$inboundSchema),
-    M.jsonErr(404, errors.ResourceNotFound$inboundSchema),
-    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
-    M.fail(["4XX", "5XX"]),
-  )(response, { extraFields: responseFields });
-  if (!result.ok) {
-    return result;
-  }
-
-  return result;
-}

package/src/models/components/article.ts

@@ -1,187 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  ArticleVisibility,
-  ArticleVisibility$inboundSchema,
-  ArticleVisibility$outboundSchema,
-} from "./articlevisibility.js";
-import {
-  BylineProfile,
-  BylineProfile$inboundSchema,
-  BylineProfile$Outbound,
-  BylineProfile$outboundSchema,
-} from "./bylineprofile.js";
-import {
-  Organization,
-  Organization$inboundSchema,
-  Organization$Outbound,
-  Organization$outboundSchema,
-} from "./organization.js";
-
-export type Article = {
-  id: string;
-  slug: string;
-  title: string;
-  body: string;
-  byline: BylineProfile;
-  visibility: ArticleVisibility;
-  userId: string | null;
-  organizationId: string;
-  organization: Organization;
-  publishedAt: Date | null;
-  paidSubscribersOnly: boolean | null;
-  paidSubscribersOnlyEndsAt: Date | null;
-  isPreview: boolean;
-  isPinned: boolean;
-  notifySubscribers: boolean | null;
-  notificationsSentAt: Date | null;
-  emailSentToCount: number | null;
-  ogImageUrl: string | null;
-  ogDescription: string | null;
-};
-
-/** @internal */
-export const Article$inboundSchema: z.ZodType<Article, z.ZodTypeDef, unknown> =
-  z.object({
-    id: z.string(),
-    slug: z.string(),
-    title: z.string(),
-    body: z.string(),
-    byline: BylineProfile$inboundSchema,
-    visibility: ArticleVisibility$inboundSchema,
-    user_id: z.nullable(z.string()),
-    organization_id: z.string(),
-    organization: Organization$inboundSchema,
-    published_at: z.nullable(
-      z.string().datetime({ offset: true }).transform(v => new Date(v)),
-    ),
-    paid_subscribers_only: z.nullable(z.boolean()),
-    paid_subscribers_only_ends_at: z.nullable(
-      z.string().datetime({ offset: true }).transform(v => new Date(v)),
-    ),
-    is_preview: z.boolean(),
-    is_pinned: z.boolean(),
-    notify_subscribers: z.nullable(z.boolean()),
-    notifications_sent_at: z.nullable(
-      z.string().datetime({ offset: true }).transform(v => new Date(v)),
-    ),
-    email_sent_to_count: z.nullable(z.number().int()),
-    og_image_url: z.nullable(z.string()),
-    og_description: z.nullable(z.string()),
-  }).transform((v) => {
-    return remap$(v, {
-      "user_id": "userId",
-      "organization_id": "organizationId",
-      "published_at": "publishedAt",
-      "paid_subscribers_only": "paidSubscribersOnly",
-      "paid_subscribers_only_ends_at": "paidSubscribersOnlyEndsAt",
-      "is_preview": "isPreview",
-      "is_pinned": "isPinned",
-      "notify_subscribers": "notifySubscribers",
-      "notifications_sent_at": "notificationsSentAt",
-      "email_sent_to_count": "emailSentToCount",
-      "og_image_url": "ogImageUrl",
-      "og_description": "ogDescription",
-    });
-  });
-
-/** @internal */
-export type Article$Outbound = {
-  id: string;
-  slug: string;
-  title: string;
-  body: string;
-  byline: BylineProfile$Outbound;
-  visibility: string;
-  user_id: string | null;
-  organization_id: string;
-  organization: Organization$Outbound;
-  published_at: string | null;
-  paid_subscribers_only: boolean | null;
-  paid_subscribers_only_ends_at: string | null;
-  is_preview: boolean;
-  is_pinned: boolean;
-  notify_subscribers: boolean | null;
-  notifications_sent_at: string | null;
-  email_sent_to_count: number | null;
-  og_image_url: string | null;
-  og_description: string | null;
-};
-
-/** @internal */
-export const Article$outboundSchema: z.ZodType<
-  Article$Outbound,
-  z.ZodTypeDef,
-  Article
-> = z.object({
-  id: z.string(),
-  slug: z.string(),
-  title: z.string(),
-  body: z.string(),
-  byline: BylineProfile$outboundSchema,
-  visibility: ArticleVisibility$outboundSchema,
-  userId: z.nullable(z.string()),
-  organizationId: z.string(),
-  organization: Organization$outboundSchema,
-  publishedAt: z.nullable(z.date().transform(v => v.toISOString())),
-  paidSubscribersOnly: z.nullable(z.boolean()),
-  paidSubscribersOnlyEndsAt: z.nullable(
-    z.date().transform(v => v.toISOString()),
-  ),
-  isPreview: z.boolean(),
-  isPinned: z.boolean(),
-  notifySubscribers: z.nullable(z.boolean()),
-  notificationsSentAt: z.nullable(z.date().transform(v => v.toISOString())),
-  emailSentToCount: z.nullable(z.number().int()),
-  ogImageUrl: z.nullable(z.string()),
-  ogDescription: z.nullable(z.string()),
-}).transform((v) => {
-  return remap$(v, {
-    userId: "user_id",
-    organizationId: "organization_id",
-    publishedAt: "published_at",
-    paidSubscribersOnly: "paid_subscribers_only",
-    paidSubscribersOnlyEndsAt: "paid_subscribers_only_ends_at",
-    isPreview: "is_preview",
-    isPinned: "is_pinned",
-    notifySubscribers: "notify_subscribers",
-    notificationsSentAt: "notifications_sent_at",
-    emailSentToCount: "email_sent_to_count",
-    ogImageUrl: "og_image_url",
-    ogDescription: "og_description",
-  });
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Article$ {
-  /** @deprecated use `Article$inboundSchema` instead. */
-  export const inboundSchema = Article$inboundSchema;
-  /** @deprecated use `Article$outboundSchema` instead. */
-  export const outboundSchema = Article$outboundSchema;
-  /** @deprecated use `Article$Outbound` instead. */
-  export type Outbound = Article$Outbound;
-}
-
-export function articleToJSON(article: Article): string {
-  return JSON.stringify(Article$outboundSchema.parse(article));
-}
-
-export function articleFromJSON(
-  jsonString: string,
-): SafeParseResult<Article, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Article$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Article' from JSON`,
-  );
-}

package/src/models/components/articlebyline.ts

@@ -1,33 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { ClosedEnum } from "../../types/enums.js";
-
-export const ArticleByline = {
-  User: "user",
-  Organization: "organization",
-} as const;
-export type ArticleByline = ClosedEnum<typeof ArticleByline>;
-
-/** @internal */
-export const ArticleByline$inboundSchema: z.ZodNativeEnum<
-  typeof ArticleByline
-> = z.nativeEnum(ArticleByline);
-
-/** @internal */
-export const ArticleByline$outboundSchema: z.ZodNativeEnum<
-  typeof ArticleByline
-> = ArticleByline$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace ArticleByline$ {
-  /** @deprecated use `ArticleByline$inboundSchema` instead. */
-  export const inboundSchema = ArticleByline$inboundSchema;
-  /** @deprecated use `ArticleByline$outboundSchema` instead. */
-  export const outboundSchema = ArticleByline$outboundSchema;
-}

package/src/models/components/articlecreate.ts

@@ -1,191 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { remap as remap$ } from "../../lib/primitives.js";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-import {
-  ArticleByline,
-  ArticleByline$inboundSchema,
-  ArticleByline$outboundSchema,
-} from "./articlebyline.js";
-import {
-  ArticleVisibility,
-  ArticleVisibility$inboundSchema,
-  ArticleVisibility$outboundSchema,
-} from "./articlevisibility.js";
-
-export type ArticleCreate = {
-  /**
-   * Title of the article.
-   */
-  title: string;
-  /**
-   * Slug of the article to be used in URLs. If no slug is provided one will be generated from the title.
-   */
-  slug?: string | null | undefined;
-  /**
-   * Body in string format. Either one of body or body_base64 is required.
-   */
-  body?: string | null | undefined;
-  /**
-   * Body in base64-encoded format. Can be helpful to bypass Web Application Firewalls (WAF). Either one of body or body_base64 is required.
-   */
-  bodyBase64?: string | null | undefined;
-  /**
-   * The ID of the organization owning the article. **Required unless you use an organization token.**
-   */
-  organizationId?: string | null | undefined;
-  byline?: ArticleByline | undefined;
-  visibility?: ArticleVisibility | undefined;
-  /**
-   * Set to true to only make this article available for subscribers to a paid subscription tier in the organization.
-   */
-  paidSubscribersOnly?: boolean | undefined;
-  /**
-   * If specified, time at which the article should no longer be restricted to paid subscribers. Only relevant if `paid_subscribers_only` is true.
-   */
-  paidSubscribersOnlyEndsAt?: Date | null | undefined;
-  /**
-   * Time of publishing. If this date is in the future, the post will be scheduled to publish at this time. If visibility is 'public', published_at will default to the current time.
-   */
-  publishedAt?: Date | null | undefined;
-  /**
-   * Set to true to deliver this article via email and/or notifications to subscribers.
-   */
-  notifySubscribers?: boolean | null | undefined;
-  /**
-   * If the article should be pinned
-   */
-  isPinned?: boolean | null | undefined;
-  /**
-   * Custom og:image URL value
-   */
-  ogImageUrl?: string | null | undefined;
-  /**
-   * Custom og:description value
-   */
-  ogDescription?: string | null | undefined;
-};
-
-/** @internal */
-export const ArticleCreate$inboundSchema: z.ZodType<
-  ArticleCreate,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  title: z.string(),
-  slug: z.nullable(z.string()).optional(),
-  body: z.nullable(z.string()).optional(),
-  body_base64: z.nullable(z.string()).optional(),
-  organization_id: z.nullable(z.string()).optional(),
-  byline: ArticleByline$inboundSchema.optional(),
-  visibility: ArticleVisibility$inboundSchema.optional(),
-  paid_subscribers_only: z.boolean().default(false),
-  paid_subscribers_only_ends_at: z.nullable(
-    z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  ).optional(),
-  published_at: z.nullable(
-    z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  ).optional(),
-  notify_subscribers: z.nullable(z.boolean()).optional(),
-  is_pinned: z.nullable(z.boolean()).optional(),
-  og_image_url: z.nullable(z.string()).optional(),
-  og_description: z.nullable(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "body_base64": "bodyBase64",
-    "organization_id": "organizationId",
-    "paid_subscribers_only": "paidSubscribersOnly",
-    "paid_subscribers_only_ends_at": "paidSubscribersOnlyEndsAt",
-    "published_at": "publishedAt",
-    "notify_subscribers": "notifySubscribers",
-    "is_pinned": "isPinned",
-    "og_image_url": "ogImageUrl",
-    "og_description": "ogDescription",
-  });
-});
-
-/** @internal */
-export type ArticleCreate$Outbound = {
-  title: string;
-  slug?: string | null | undefined;
-  body?: string | null | undefined;
-  body_base64?: string | null | undefined;
-  organization_id?: string | null | undefined;
-  byline?: string | undefined;
-  visibility?: string | undefined;
-  paid_subscribers_only: boolean;
-  paid_subscribers_only_ends_at?: string | null | undefined;
-  published_at?: string | null | undefined;
-  notify_subscribers?: boolean | null | undefined;
-  is_pinned?: boolean | null | undefined;
-  og_image_url?: string | null | undefined;
-  og_description?: string | null | undefined;
-};
-
-/** @internal */
-export const ArticleCreate$outboundSchema: z.ZodType<
-  ArticleCreate$Outbound,
-  z.ZodTypeDef,
-  ArticleCreate
-> = z.object({
-  title: z.string(),
-  slug: z.nullable(z.string()).optional(),
-  body: z.nullable(z.string()).optional(),
-  bodyBase64: z.nullable(z.string()).optional(),
-  organizationId: z.nullable(z.string()).optional(),
-  byline: ArticleByline$outboundSchema.optional(),
-  visibility: ArticleVisibility$outboundSchema.optional(),
-  paidSubscribersOnly: z.boolean().default(false),
-  paidSubscribersOnlyEndsAt: z.nullable(
-    z.date().transform(v => v.toISOString()),
-  ).optional(),
-  publishedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
-  notifySubscribers: z.nullable(z.boolean()).optional(),
-  isPinned: z.nullable(z.boolean()).optional(),
-  ogImageUrl: z.nullable(z.string()).optional(),
-  ogDescription: z.nullable(z.string()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    bodyBase64: "body_base64",
-    organizationId: "organization_id",
-    paidSubscribersOnly: "paid_subscribers_only",
-    paidSubscribersOnlyEndsAt: "paid_subscribers_only_ends_at",
-    publishedAt: "published_at",
-    notifySubscribers: "notify_subscribers",
-    isPinned: "is_pinned",
-    ogImageUrl: "og_image_url",
-    ogDescription: "og_description",
-  });
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace ArticleCreate$ {
-  /** @deprecated use `ArticleCreate$inboundSchema` instead. */
-  export const inboundSchema = ArticleCreate$inboundSchema;
-  /** @deprecated use `ArticleCreate$outboundSchema` instead. */
-  export const outboundSchema = ArticleCreate$outboundSchema;
-  /** @deprecated use `ArticleCreate$Outbound` instead. */
-  export type Outbound = ArticleCreate$Outbound;
-}
-
-export function articleCreateToJSON(articleCreate: ArticleCreate): string {
-  return JSON.stringify(ArticleCreate$outboundSchema.parse(articleCreate));
-}
-
-export function articleCreateFromJSON(
-  jsonString: string,
-): SafeParseResult<ArticleCreate, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ArticleCreate$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ArticleCreate' from JSON`,
-  );
-}

package/src/models/components/articlepreview.ts

@@ -1,65 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import { safeParse } from "../../lib/schemas.js";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-
-export type ArticlePreview = {
-  /**
-   * Email address to send the preview to. The user must be registered on Polar.
-   */
-  email: string;
-};
-
-/** @internal */
-export const ArticlePreview$inboundSchema: z.ZodType<
-  ArticlePreview,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  email: z.string(),
-});
-
-/** @internal */
-export type ArticlePreview$Outbound = {
-  email: string;
-};
-
-/** @internal */
-export const ArticlePreview$outboundSchema: z.ZodType<
-  ArticlePreview$Outbound,
-  z.ZodTypeDef,
-  ArticlePreview
-> = z.object({
-  email: z.string(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace ArticlePreview$ {
-  /** @deprecated use `ArticlePreview$inboundSchema` instead. */
-  export const inboundSchema = ArticlePreview$inboundSchema;
-  /** @deprecated use `ArticlePreview$outboundSchema` instead. */
-  export const outboundSchema = ArticlePreview$outboundSchema;
-  /** @deprecated use `ArticlePreview$Outbound` instead. */
-  export type Outbound = ArticlePreview$Outbound;
-}
-
-export function articlePreviewToJSON(articlePreview: ArticlePreview): string {
-  return JSON.stringify(ArticlePreview$outboundSchema.parse(articlePreview));
-}
-
-export function articlePreviewFromJSON(
-  jsonString: string,
-): SafeParseResult<ArticlePreview, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => ArticlePreview$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'ArticlePreview' from JSON`,
-  );
-}