@polar-sh/sdk 0.47.1 → 0.48.0

package/src/funcs/ordersReceipt.ts

@@ -0,0 +1,198 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { PolarCore } 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 {
+  OrderReceipt,
+  OrderReceipt$inboundSchema,
+} from "../models/components/orderreceipt.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import {
+  HTTPValidationError,
+  HTTPValidationError$inboundSchema,
+} from "../models/errors/httpvalidationerror.js";
+import { PolarError } from "../models/errors/polarerror.js";
+import {
+  ResourceNotFound,
+  ResourceNotFound$inboundSchema,
+} from "../models/errors/resourcenotfound.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  OrdersReceiptRequest,
+  OrdersReceiptRequest$outboundSchema,
+} from "../models/operations/ordersreceipt.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get Order Receipt
+ *
+ * @remarks
+ * Get a presigned URL to download an order's receipt PDF.
+ *
+ * **Scopes**: `orders:read`
+ */
+export function ordersReceipt(
+  client: PolarCore,
+  request: OrdersReceiptRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    OrderReceipt | undefined,
+    | ResourceNotFound
+    | HTTPValidationError
+    | PolarError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: PolarCore,
+  request: OrdersReceiptRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      OrderReceipt | undefined,
+      | ResourceNotFound
+      | HTTPValidationError
+      | PolarError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => z.parse(OrdersReceiptRequest$outboundSchema, 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/orders/{id}/receipt")(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 = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "orders:receipt",
+    oAuth2Scopes: null,
+
+    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,
+    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<
+    OrderReceipt | undefined,
+    | ResourceNotFound
+    | HTTPValidationError
+    | PolarError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, z.optional(OrderReceipt$inboundSchema)),
+    M.nil(202, z.optional(OrderReceipt$inboundSchema)),
+    M.jsonErr(404, ResourceNotFound$inboundSchema),
+    M.jsonErr(422, HTTPValidationError$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/organizationsGet.ts

@@ -46,6 +46,8 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Get an organization by ID.
+ *
+ * **Scopes**: `organizations:read` `organizations:write`
  */
 export function organizationsGet(
   client: PolarCore,

package/src/funcs/{organizationsList.ts → organizationsListOrganizations.ts}

@@ -50,7 +50,7 @@ import {
  *
  * **Scopes**: `organizations:read` `organizations:write`
  */
-export function organizationsList(
+export function organizationsListOrganizations(
   client: PolarCore,
   request: OrganizationsListRequest,
   options?: RequestOptions,
@@ -241,7 +241,7 @@ async function $do(
     }
 
     const nextVal = () =>
-      organizationsList(
+      organizationsListOrganizations(
         client,
         {
           ...request,

package/src/funcs/organizationsUpdate.ts

@@ -50,6 +50,8 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Update an organization.
+ *
+ * **Scopes**: `organizations:write`
  */
 export function organizationsUpdate(
   client: PolarCore,

package/src/funcs/paymentsList.ts

@@ -118,6 +118,7 @@ async function $do(
   const query = encodeFormQuery({
     "checkout_id": payload.checkout_id,
     "customer_email": payload.customer_email,
+    "customer_id": payload.customer_id,
     "limit": payload.limit,
     "method": payload.method,
     "order_id": payload.order_id,

package/src/funcs/validateWebhook.ts

@@ -196,6 +196,7 @@ export async function validateWebhook(_client: PolarCore, {
   >
 > {
   const request = normalizeRequest(rawRequest);
+  const jsonString = await request.text();
   const knownSchemas = [
     webhookCheckoutCreatedPayloadFromJSON,
     webhookCheckoutUpdatedPayloadFromJSON,
@@ -234,8 +235,6 @@ export async function validateWebhook(_client: PolarCore, {
     webhookBenefitGrantRevokedPayloadFromJSON,
   ];
 
-  const jsonString = await request.text();
-
   for (const schema of knownSchemas) {
     const ret = schema(jsonString);
     if (ret.ok) {

package/src/lib/config.ts

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

package/src/models/components/balancecreditordermetadata.ts

@@ -18,6 +18,7 @@ export type BalanceCreditOrderMetadata = {
   taxState?: string | null | undefined;
   taxCountry?: string | null | undefined;
   fee: number;
+  exchangeRate?: number | undefined;
 };
 
 /** @internal */
@@ -35,6 +36,7 @@ export const BalanceCreditOrderMetadata$inboundSchema: z.ZodMiniType<
     tax_state: z.optional(z.nullable(z.string())),
     tax_country: z.optional(z.nullable(z.string())),
     fee: z.int(),
+    exchange_rate: z.optional(z.number()),
   }),
   z.transform((v) => {
     return remap$(v, {
@@ -44,6 +46,7 @@ export const BalanceCreditOrderMetadata$inboundSchema: z.ZodMiniType<
       "tax_amount": "taxAmount",
       "tax_state": "taxState",
       "tax_country": "taxCountry",
+      "exchange_rate": "exchangeRate",
     });
   }),
 );

package/src/models/components/customerindividual.ts

@@ -72,6 +72,10 @@ export type CustomerIndividual = {
    * The ID of the organization owning the customer.
    */
   organizationId: string;
+  /**
+   * The ID of the customer's default payment method, if any. Use the payment methods endpoint to retrieve its details.
+   */
+  defaultPaymentMethodId?: string | null | undefined;
   /**
    * Timestamp for when the customer was soft deleted.
    */
@@ -136,6 +140,7 @@ export const CustomerIndividual$inboundSchema: z.ZodMiniType<
     ),
     locale: z.optional(z.nullable(z.string())),
     organization_id: z.string(),
+    default_payment_method_id: z.optional(z.nullable(z.string())),
     deleted_at: z.nullable(
       z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
     ),
@@ -150,6 +155,7 @@ export const CustomerIndividual$inboundSchema: z.ZodMiniType<
       "billing_address": "billingAddress",
       "tax_id": "taxId",
       "organization_id": "organizationId",
+      "default_payment_method_id": "defaultPaymentMethodId",
       "deleted_at": "deletedAt",
       "avatar_url": "avatarUrl",
     });
@@ -170,6 +176,7 @@ export type CustomerIndividual$Outbound = {
   tax_id: Array<string | string | null> | null;
   locale?: string | null | undefined;
   organization_id: string;
+  default_payment_method_id?: string | null | undefined;
   deleted_at: string | null;
   avatar_url: string;
 };
@@ -195,6 +202,7 @@ export const CustomerIndividual$outboundSchema: z.ZodMiniType<
     ),
     locale: z.optional(z.nullable(z.string())),
     organizationId: z.string(),
+    defaultPaymentMethodId: z.optional(z.nullable(z.string())),
     deletedAt: z.nullable(z.pipe(z.date(), z.transform(v => v.toISOString()))),
     avatarUrl: z.string(),
   }),
@@ -207,6 +215,7 @@ export const CustomerIndividual$outboundSchema: z.ZodMiniType<
       billingAddress: "billing_address",
       taxId: "tax_id",
       organizationId: "organization_id",
+      defaultPaymentMethodId: "default_payment_method_id",
       deletedAt: "deleted_at",
       avatarUrl: "avatar_url",
     });

package/src/models/components/customerorder.ts

@@ -88,13 +88,17 @@ export type CustomerOrder = {
   billingName: string | null;
   billingAddress: Address | null;
   /**
-   * The invoice number associated with this order.
+   * The invoice number associated with this order. `null` while the order is in `draft` status; assigned at finalize.
    */
-  invoiceNumber: string;
+  invoiceNumber: string | null;
   /**
    * Whether an invoice has been generated for this order.
    */
   isInvoiceGenerated: boolean;
+  /**
+   * The receipt number for this order. Set once the order is paid for organizations with receipts enabled. When set, a downloadable receipt PDF can be obtained via the receipt endpoint.
+   */
+  receiptNumber: string | null;
   /**
    * Number of seats purchased (for seat-based one-time orders).
    */
@@ -118,6 +122,14 @@ export type CustomerOrder = {
    * When the next payment retry is scheduled
    */
   nextPaymentAttemptAt?: Date | null | undefined;
+  /**
+   * Amount in cents that can still be refunded (net, before taxes). Accounts for any applied customer balance and previous refunds.
+   */
+  refundableAmount: number;
+  /**
+   * Sales tax in cents that would be refunded if the full refundable amount is refunded.
+   */
+  refundableTaxAmount: number;
 };
 
 /** @internal */
@@ -149,8 +161,9 @@ export const CustomerOrder$inboundSchema: z.ZodMiniType<
     billing_reason: OrderBillingReason$inboundSchema,
     billing_name: z.nullable(z.string()),
     billing_address: z.nullable(Address$inboundSchema),
-    invoice_number: z.string(),
+    invoice_number: z.nullable(z.string()),
     is_invoice_generated: z.boolean(),
+    receipt_number: z.nullable(z.string()),
     seats: z.optional(z.nullable(z.int())),
     customer_id: z.string(),
     product_id: z.nullable(z.string()),
@@ -167,6 +180,8 @@ export const CustomerOrder$inboundSchema: z.ZodMiniType<
         z.transform(v => new Date(v)),
       )),
     ),
+    refundable_amount: z.int(),
+    refundable_tax_amount: z.int(),
   }),
   z.transform((v) => {
     return remap$(v, {
@@ -186,12 +201,15 @@ export const CustomerOrder$inboundSchema: z.ZodMiniType<
       "billing_address": "billingAddress",
       "invoice_number": "invoiceNumber",
       "is_invoice_generated": "isInvoiceGenerated",
+      "receipt_number": "receiptNumber",
       "customer_id": "customerId",
       "product_id": "productId",
       "discount_id": "discountId",
       "subscription_id": "subscriptionId",
       "checkout_id": "checkoutId",
       "next_payment_attempt_at": "nextPaymentAttemptAt",
+      "refundable_amount": "refundableAmount",
+      "refundable_tax_amount": "refundableTaxAmount",
     });
   }),
 );

package/src/models/components/customerorderreceipt.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Order's receipt data.
+ */
+export type CustomerOrderReceipt = {
+  /**
+   * The URL to the receipt PDF.
+   */
+  url: string;
+};
+
+/** @internal */
+export const CustomerOrderReceipt$inboundSchema: z.ZodMiniType<
+  CustomerOrderReceipt,
+  unknown
+> = z.object({
+  url: z.string(),
+});
+
+export function customerOrderReceiptFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerOrderReceipt, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerOrderReceipt$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerOrderReceipt' from JSON`,
+  );
+}

package/src/models/components/customerpaymentmethodcard.ts

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+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 {
+  PaymentMethodCardMetadata,
+  PaymentMethodCardMetadata$inboundSchema,
+} from "./paymentmethodcardmetadata.js";
+import {
+  PaymentProcessor,
+  PaymentProcessor$inboundSchema,
+} from "./paymentprocessor.js";
+
+export type CustomerPaymentMethodCard = {
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  processor: PaymentProcessor;
+  customerId: string;
+  type: "card";
+  methodMetadata: PaymentMethodCardMetadata;
+  /**
+   * Whether this payment method is the customer's default payment method.
+   */
+  isDefault: boolean;
+};
+
+/** @internal */
+export const CustomerPaymentMethodCard$inboundSchema: z.ZodMiniType<
+  CustomerPaymentMethodCard,
+  unknown
+> = z.pipe(
+  z.object({
+    id: z.string(),
+    created_at: z.pipe(
+      z.iso.datetime({ offset: true }),
+      z.transform(v => new Date(v)),
+    ),
+    modified_at: z.nullable(
+      z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
+    ),
+    processor: PaymentProcessor$inboundSchema,
+    customer_id: z.string(),
+    type: z.literal("card"),
+    method_metadata: PaymentMethodCardMetadata$inboundSchema,
+    is_default: z.boolean(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "modified_at": "modifiedAt",
+      "customer_id": "customerId",
+      "method_metadata": "methodMetadata",
+      "is_default": "isDefault",
+    });
+  }),
+);
+
+export function customerPaymentMethodCardFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerPaymentMethodCard, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerPaymentMethodCard$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerPaymentMethodCard' from JSON`,
+  );
+}

package/src/models/components/customerpaymentmethodgeneric.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+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 {
+  PaymentProcessor,
+  PaymentProcessor$inboundSchema,
+} from "./paymentprocessor.js";
+
+export type CustomerPaymentMethodGeneric = {
+  /**
+   * The ID of the object.
+   */
+  id: string;
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  processor: PaymentProcessor;
+  customerId: string;
+  type: string;
+  /**
+   * Whether this payment method is the customer's default payment method.
+   */
+  isDefault: boolean;
+};
+
+/** @internal */
+export const CustomerPaymentMethodGeneric$inboundSchema: z.ZodMiniType<
+  CustomerPaymentMethodGeneric,
+  unknown
+> = z.pipe(
+  z.object({
+    id: z.string(),
+    created_at: z.pipe(
+      z.iso.datetime({ offset: true }),
+      z.transform(v => new Date(v)),
+    ),
+    modified_at: z.nullable(
+      z.pipe(z.iso.datetime({ offset: true }), z.transform(v => new Date(v))),
+    ),
+    processor: PaymentProcessor$inboundSchema,
+    customer_id: z.string(),
+    type: z.string(),
+    is_default: z.boolean(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "modified_at": "modifiedAt",
+      "customer_id": "customerId",
+      "is_default": "isDefault",
+    });
+  }),
+);
+
+export function customerPaymentMethodGenericFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerPaymentMethodGeneric, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerPaymentMethodGeneric$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerPaymentMethodGeneric' from JSON`,
+  );
+}

package/src/models/components/customerportalcustomerupdate.ts

@@ -14,6 +14,7 @@ export type CustomerPortalCustomerUpdate = {
   billingName?: string | null | undefined;
   billingAddress?: AddressInput | null | undefined;
   taxId?: string | null | undefined;
+  defaultPaymentMethodId?: string | null | undefined;
 };
 
 /** @internal */
@@ -21,6 +22,7 @@ export type CustomerPortalCustomerUpdate$Outbound = {
   billing_name?: string | null | undefined;
   billing_address?: AddressInput$Outbound | null | undefined;
   tax_id?: string | null | undefined;
+  default_payment_method_id?: string | null | undefined;
 };
 
 /** @internal */
@@ -32,12 +34,14 @@ export const CustomerPortalCustomerUpdate$outboundSchema: z.ZodMiniType<
     billingName: z.optional(z.nullable(z.string())),
     billingAddress: z.optional(z.nullable(AddressInput$outboundSchema)),
     taxId: z.optional(z.nullable(z.string())),
+    defaultPaymentMethodId: z.optional(z.nullable(z.string())),
   }),
   z.transform((v) => {
     return remap$(v, {
       billingName: "billing_name",
       billingAddress: "billing_address",
       taxId: "tax_id",
+      defaultPaymentMethodId: "default_payment_method_id",
     });
   }),
 );