@polar-sh/sdk 0.29.0 → 0.29.2

package/src/funcs/customersGetState.ts

@@ -0,0 +1,195 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PolarCore } 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 {
+  CustomerState,
+  CustomerState$inboundSchema,
+} from "../models/components/customerstate.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import {
+  HTTPValidationError,
+  HTTPValidationError$inboundSchema,
+} from "../models/errors/httpvalidationerror.js";
+import {
+  ResourceNotFound,
+  ResourceNotFound$inboundSchema,
+} from "../models/errors/resourcenotfound.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  CustomersGetStateRequest,
+  CustomersGetStateRequest$outboundSchema,
+} from "../models/operations/customersgetstate.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get Customer State
+ *
+ * @remarks
+ * Get a customer state by ID.
+ *
+ * The customer state includes information about
+ * the customer's active subscriptions and benefits.
+ *
+ * It's the ideal endpoint to use when you need to get a full overview
+ * of a customer's status.
+ *
+ * **Scopes**: `customers:read` `customers:write`
+ */
+export function customersGetState(
+  client: PolarCore,
+  request: CustomersGetStateRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    CustomerState,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PolarCore,
+  request: CustomersGetStateRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      CustomerState,
+      | ResourceNotFound
+      | HTTPValidationError
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => CustomersGetStateRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    id: encodeSimple("id", payload.id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/customers/{id}/state")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.accessToken);
+  const securityInput = secConfig == null ? {} : { accessToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "customers:get_state",
+    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: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    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: ["404", "422", "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<
+    CustomerState,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, CustomerState$inboundSchema),
+    M.jsonErr(404, ResourceNotFound$inboundSchema),
+    M.jsonErr(422, HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/customersGetStateExternal.ts

@@ -0,0 +1,197 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PolarCore } 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 {
+  CustomerState,
+  CustomerState$inboundSchema,
+} from "../models/components/customerstate.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import {
+  HTTPValidationError,
+  HTTPValidationError$inboundSchema,
+} from "../models/errors/httpvalidationerror.js";
+import {
+  ResourceNotFound,
+  ResourceNotFound$inboundSchema,
+} from "../models/errors/resourcenotfound.js";
+import { SDKError } from "../models/errors/sdkerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  CustomersGetStateExternalRequest,
+  CustomersGetStateExternalRequest$outboundSchema,
+} from "../models/operations/customersgetstateexternal.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get Customer State by External ID
+ *
+ * @remarks
+ * Get a customer state by external ID.
+ *
+ * The customer state includes information about
+ * the customer's active subscriptions and benefits.
+ *
+ * It's the ideal endpoint to use when you need to get a full overview
+ * of a customer's status.
+ *
+ * **Scopes**: `customers:read` `customers:write`
+ */
+export function customersGetStateExternal(
+  client: PolarCore,
+  request: CustomersGetStateExternalRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    CustomerState,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PolarCore,
+  request: CustomersGetStateExternalRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      CustomerState,
+      | ResourceNotFound
+      | HTTPValidationError
+      | SDKError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => CustomersGetStateExternalRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    external_id: encodeSimple("external_id", payload.external_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/customers/external/{external_id}/state")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.accessToken);
+  const securityInput = secConfig == null ? {} : { accessToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "customers:get_state_external",
+    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: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    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: ["404", "422", "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<
+    CustomerState,
+    | ResourceNotFound
+    | HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, CustomerState$inboundSchema),
+    M.jsonErr(404, ResourceNotFound$inboundSchema),
+    M.jsonErr(422, HTTPValidationError$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -60,7 +60,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.1.0",
-  sdkVersion: "0.29.0",
+  sdkVersion: "0.29.2",
   genVersion: "2.539.1",
-  userAgent: "speakeasy-sdk/typescript 0.29.0 2.539.1 0.1.0 @polar-sh/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.29.2 2.539.1 0.1.0 @polar-sh/sdk",
 } as const;

package/src/mcp-server/mcp-server.ts

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "0.29.0",
+    currentVersion: "0.29.2",
   },
 });
 

package/src/mcp-server/server.ts

@@ -13,6 +13,8 @@ import { tool$customersDelete } from "./tools/customersDelete.js";
 import { tool$customersDeleteExternal } from "./tools/customersDeleteExternal.js";
 import { tool$customersGet } from "./tools/customersGet.js";
 import { tool$customersGetExternal } from "./tools/customersGetExternal.js";
+import { tool$customersGetState } from "./tools/customersGetState.js";
+import { tool$customersGetStateExternal } from "./tools/customersGetStateExternal.js";
 import { tool$customersList } from "./tools/customersList.js";
 import { tool$customersUpdate } from "./tools/customersUpdate.js";
 import { tool$customersUpdateExternal } from "./tools/customersUpdateExternal.js";
@@ -42,7 +44,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Polar",
-    version: "0.29.0",
+    version: "0.29.2",
   });
 
   const client = new PolarCore({
@@ -83,6 +85,8 @@ export function createMCPServer(deps: {
   tool(tool$customersGetExternal);
   tool(tool$customersUpdateExternal);
   tool(tool$customersDeleteExternal);
+  tool(tool$customersGetState);
+  tool(tool$customersGetStateExternal);
 
   return server;
 }

package/src/mcp-server/tools/customersGetState.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { customersGetState } from "../../funcs/customersGetState.js";
+import { CustomersGetStateRequest$inboundSchema } from "../../models/operations/customersgetstate.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: CustomersGetStateRequest$inboundSchema,
+};
+
+export const tool$customersGetState: ToolDefinition<typeof args> = {
+  name: "customers_get-state",
+  description: `Get Customer State
+
+Get a customer state by ID.
+
+The customer state includes information about
+the customer's active subscriptions and benefits.
+
+It's the ideal endpoint to use when you need to get a full overview
+of a customer's status.
+
+**Scopes**: \`customers:read\` \`customers:write\``,
+  scopes: ["read", "customers"],
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await customersGetState(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/customersGetStateExternal.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { customersGetStateExternal } from "../../funcs/customersGetStateExternal.js";
+import { CustomersGetStateExternalRequest$inboundSchema } from "../../models/operations/customersgetstateexternal.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: CustomersGetStateExternalRequest$inboundSchema,
+};
+
+export const tool$customersGetStateExternal: ToolDefinition<typeof args> = {
+  name: "customers_get-state-external",
+  description: `Get Customer State by External ID
+
+Get a customer state by external ID.
+
+The customer state includes information about
+the customer's active subscriptions and benefits.
+
+It's the ideal endpoint to use when you need to get a full overview
+of a customer's status.
+
+**Scopes**: \`customers:read\` \`customers:write\``,
+  scopes: ["read", "customers"],
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await customersGetStateExternal(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/models/components/customer.ts

@@ -27,6 +27,10 @@ export type CustomerTaxId = string | TaxIDFormat;
  * A customer in an organization.
  */
 export type Customer = {
+  /**
+   * The ID of the customer.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -35,10 +39,6 @@ export type Customer = {
    * Last modification timestamp of the object.
    */
   modifiedAt: Date | null;
-  /**
-   * The ID of the object.
-   */
-  id: string;
   metadata: { [k: string]: string | number | boolean };
   /**
    * The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.
@@ -52,9 +52,15 @@ export type Customer = {
    * Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.
    */
   emailVerified: boolean;
+  /**
+   * The name of the customer.
+   */
   name: string | null;
   billingAddress: Address | null;
   taxId: Array<string | TaxIDFormat | null> | null;
+  /**
+   * The ID of the organization owning the customer.
+   */
   organizationId: string;
   avatarUrl: string;
 };
@@ -157,11 +163,11 @@ export const Customer$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  id: z.string(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   modified_at: z.nullable(
     z.string().datetime({ offset: true }).transform(v => new Date(v)),
   ),
-  id: z.string(),
   metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
   external_id: z.nullable(z.string()),
   email: z.string(),
@@ -188,9 +194,9 @@ export const Customer$inboundSchema: z.ZodType<
 
 /** @internal */
 export type Customer$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
   metadata: { [k: string]: string | number | boolean };
   external_id: string | null;
   email: string;
@@ -208,9 +214,9 @@ export const Customer$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Customer
 > = z.object({
+  id: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),
   modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
-  id: z.string(),
   metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
   externalId: z.nullable(z.string()),
   email: z.string(),

package/src/models/components/customercreate.ts

@@ -47,6 +47,9 @@ export type CustomerCreate = {
    * The email address of the customer. This must be unique within the organization.
    */
   email: string;
+  /**
+   * The name of the customer.
+   */
   name?: string | null | undefined;
   billingAddress?: Address | null | undefined;
   taxId?: Array<string | TaxIDFormat | null> | null | undefined;

package/src/models/components/customerordersubscription.ts

@@ -36,20 +36,59 @@ export type CustomerOrderSubscription = {
    * The ID of the object.
    */
   id: string;
+  /**
+   * The amount of the subscription.
+   */
   amount: number | null;
+  /**
+   * The currency of the subscription.
+   */
   currency: string | null;
   recurringInterval: SubscriptionRecurringInterval;
   status: SubscriptionStatus;
+  /**
+   * The start timestamp of the current billing period.
+   */
   currentPeriodStart: Date;
+  /**
+   * The end timestamp of the current billing period.
+   */
   currentPeriodEnd: Date | null;
+  /**
+   * Whether the subscription will be canceled at the end of the current period.
+   */
   cancelAtPeriodEnd: boolean;
+  /**
+   * The timestamp when the subscription was canceled. The subscription might still be active if `cancel_at_period_end` is `true`.
+   */
   canceledAt: Date | null;
+  /**
+   * The timestamp when the subscription started.
+   */
   startedAt: Date | null;
+  /**
+   * The timestamp when the subscription will end.
+   */
   endsAt: Date | null;
+  /**
+   * The timestamp when the subscription ended.
+   */
   endedAt: Date | null;
+  /**
+   * The ID of the subscribed customer.
+   */
   customerId: string;
+  /**
+   * The ID of the subscribed product.
+   */
   productId: string;
+  /**
+   * The ID of the subscribed price.
+   */
   priceId: string;
+  /**
+   * The ID of the applied discount, if any.
+   */
   discountId: string | null;
   checkoutId: string | null;
   customerCancellationReason: CustomerCancellationReason | null;