@polar-sh/sdk 0.19.0 → 0.19.2

package/src/funcs/customerSessionsCreate.ts

@@ -0,0 +1,132 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { PolarCore } from "../core.js";
+import { encodeJSON } 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 { Result } from "../types/fp.js";
+
+/**
+ * Create Customer Session
+ *
+ * @remarks
+ * Create a customer session.
+ */
+export async function customerSessionsCreate(
+  client: PolarCore,
+  request: components.CustomerSessionCreate,
+  options?: RequestOptions,
+): Promise<
+  Result<
+    components.CustomerSession,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  const parsed = safeParse(
+    request,
+    (value) => components.CustomerSessionCreate$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return parsed;
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v1/customer-sessions/")();
+
+  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: "customer-sessions:create",
+    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: "POST",
+    baseURL: options?.serverURL,
+    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: ["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.CustomerSession,
+    | errors.HTTPValidationError
+    | SDKError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(201, components.CustomerSession$inboundSchema),
+    M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
+    M.fail(["4XX", "5XX"]),
+  )(response, { extraFields: responseFields });
+  if (!result.ok) {
+    return result;
+  }
+
+  return result;
+}

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.19.0",
-  genVersion: "2.480.1",
-  userAgent: "speakeasy-sdk/typescript 0.19.0 2.480.1 0.1.0 @polar-sh/sdk",
+  sdkVersion: "0.19.2",
+  genVersion: "2.481.0",
+  userAgent: "speakeasy-sdk/typescript 0.19.2 2.481.0 0.1.0 @polar-sh/sdk",
 } as const;

package/src/models/components/benefitcreate.ts

@@ -45,11 +45,11 @@ import {
 
 export type BenefitCreate =
   | (BenefitAdsCreate & { type: "ads" })
+  | (BenefitCustomCreate & { type: "custom" })
   | (BenefitDiscordCreate & { type: "discord" })
   | (BenefitDownloadablesCreate & { type: "downloadables" })
   | (BenefitGitHubRepositoryCreate & { type: "github_repository" })
-  | (BenefitLicenseKeysCreate & { type: "license_keys" })
-  | (BenefitCustomCreate & { type: "custom" });
+  | (BenefitLicenseKeysCreate & { type: "license_keys" });
 
 /** @internal */
 export const BenefitCreate$inboundSchema: z.ZodType<
@@ -60,6 +60,11 @@ export const BenefitCreate$inboundSchema: z.ZodType<
   BenefitAdsCreate$inboundSchema.and(
     z.object({ type: z.literal("ads") }).transform((v) => ({ type: v.type })),
   ),
+  BenefitCustomCreate$inboundSchema.and(
+    z.object({ type: z.literal("custom") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
   BenefitDiscordCreate$inboundSchema.and(
     z.object({ type: z.literal("discord") }).transform((v) => ({
       type: v.type,
@@ -80,21 +85,16 @@ export const BenefitCreate$inboundSchema: z.ZodType<
       type: v.type,
     })),
   ),
-  BenefitCustomCreate$inboundSchema.and(
-    z.object({ type: z.literal("custom") }).transform((v) => ({
-      type: v.type,
-    })),
-  ),
 ]);
 
 /** @internal */
 export type BenefitCreate$Outbound =
   | (BenefitAdsCreate$Outbound & { type: "ads" })
+  | (BenefitCustomCreate$Outbound & { type: "custom" })
   | (BenefitDiscordCreate$Outbound & { type: "discord" })
   | (BenefitDownloadablesCreate$Outbound & { type: "downloadables" })
   | (BenefitGitHubRepositoryCreate$Outbound & { type: "github_repository" })
-  | (BenefitLicenseKeysCreate$Outbound & { type: "license_keys" })
-  | (BenefitCustomCreate$Outbound & { type: "custom" });
+  | (BenefitLicenseKeysCreate$Outbound & { type: "license_keys" });
 
 /** @internal */
 export const BenefitCreate$outboundSchema: z.ZodType<
@@ -105,6 +105,11 @@ export const BenefitCreate$outboundSchema: z.ZodType<
   BenefitAdsCreate$outboundSchema.and(
     z.object({ type: z.literal("ads") }).transform((v) => ({ type: v.type })),
   ),
+  BenefitCustomCreate$outboundSchema.and(
+    z.object({ type: z.literal("custom") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
   BenefitDiscordCreate$outboundSchema.and(
     z.object({ type: z.literal("discord") }).transform((v) => ({
       type: v.type,
@@ -125,11 +130,6 @@ export const BenefitCreate$outboundSchema: z.ZodType<
       type: v.type,
     })),
   ),
-  BenefitCustomCreate$outboundSchema.and(
-    z.object({ type: z.literal("custom") }).transform((v) => ({
-      type: v.type,
-    })),
-  ),
 ]);
 
 /**

package/src/models/components/benefitcustom.ts

@@ -62,7 +62,7 @@ export type BenefitCustom = {
    */
   properties: BenefitCustomProperties;
   /**
-   * Whether the benefit is taxable.
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   isTaxApplicable: boolean;
 };

package/src/models/components/benefitcustomcreate.ts

@@ -35,10 +35,6 @@ export type BenefitCustomCreate = {
    * The ID of the organization owning the benefit. **Required unless you use an organization token.**
    */
   organizationId?: string | null | undefined;
-  /**
-   * Whether the benefit is taxable.
-   */
-  isTaxApplicable: boolean;
   /**
    * Properties for creating a benefit of type `custom`.
    */
@@ -75,12 +71,10 @@ export const BenefitCustomCreate$inboundSchema: z.ZodType<
   type: z.literal("custom").optional(),
   description: z.string(),
   organization_id: z.nullable(z.string()).optional(),
-  is_tax_applicable: z.boolean(),
   properties: BenefitCustomCreateProperties$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
     "organization_id": "organizationId",
-    "is_tax_applicable": "isTaxApplicable",
   });
 });
 
@@ -89,7 +83,6 @@ export type BenefitCustomCreate$Outbound = {
   type: "custom";
   description: string;
   organization_id?: string | null | undefined;
-  is_tax_applicable: boolean;
   properties: BenefitCustomCreateProperties$Outbound;
 };
 
@@ -102,12 +95,10 @@ export const BenefitCustomCreate$outboundSchema: z.ZodType<
   type: z.literal("custom").default("custom"),
   description: z.string(),
   organizationId: z.nullable(z.string()).optional(),
-  isTaxApplicable: z.boolean(),
   properties: BenefitCustomCreateProperties$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
     organizationId: "organization_id",
-    isTaxApplicable: "is_tax_applicable",
   });
 });
 

package/src/models/components/benefitgithubrepositoryproperties.ts

@@ -40,6 +40,10 @@ export type BenefitGitHubRepositoryProperties = {
    * The permission level to grant. Read more about roles and their permissions on [GitHub documentation](https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role).
    */
   permission: Permission;
+  /**
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  repositoryId?: string | null | undefined;
 };
 
 /** @internal */
@@ -70,10 +74,12 @@ export const BenefitGitHubRepositoryProperties$inboundSchema: z.ZodType<
   repository_owner: z.string(),
   repository_name: z.string(),
   permission: Permission$inboundSchema,
+  repository_id: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "repository_owner": "repositoryOwner",
     "repository_name": "repositoryName",
+    "repository_id": "repositoryId",
   });
 });
 
@@ -82,6 +88,7 @@ export type BenefitGitHubRepositoryProperties$Outbound = {
   repository_owner: string;
   repository_name: string;
   permission: string;
+  repository_id?: string | null | undefined;
 };
 
 /** @internal */
@@ -93,10 +100,12 @@ export const BenefitGitHubRepositoryProperties$outboundSchema: z.ZodType<
   repositoryOwner: z.string(),
   repositoryName: z.string(),
   permission: Permission$outboundSchema,
+  repositoryId: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     repositoryOwner: "repository_owner",
     repositoryName: "repository_name",
+    repositoryId: "repository_id",
   });
 });
 

package/src/models/components/checkout.ts

@@ -76,6 +76,8 @@ export type CheckoutDiscount =
   | CheckoutDiscountPercentageRepeatDuration
   | CheckoutDiscountFixedRepeatDuration;
 
+export type CustomerMetadata = string | number | boolean;
+
 /**
  * Checkout session data retrieved using an access token.
  */
@@ -192,6 +194,7 @@ export type Checkout = {
     | null;
   subscriptionId: string | null;
   attachedCustomFields: Array<AttachedCustomField>;
+  customerMetadata: { [k: string]: string | number | boolean };
 };
 
 /** @internal */
@@ -400,6 +403,54 @@ export function checkoutDiscountFromJSON(
   );
 }
 
+/** @internal */
+export const CustomerMetadata$inboundSchema: z.ZodType<
+  CustomerMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/** @internal */
+export type CustomerMetadata$Outbound = string | number | boolean;
+
+/** @internal */
+export const CustomerMetadata$outboundSchema: z.ZodType<
+  CustomerMetadata$Outbound,
+  z.ZodTypeDef,
+  CustomerMetadata
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerMetadata$ {
+  /** @deprecated use `CustomerMetadata$inboundSchema` instead. */
+  export const inboundSchema = CustomerMetadata$inboundSchema;
+  /** @deprecated use `CustomerMetadata$outboundSchema` instead. */
+  export const outboundSchema = CustomerMetadata$outboundSchema;
+  /** @deprecated use `CustomerMetadata$Outbound` instead. */
+  export type Outbound = CustomerMetadata$Outbound;
+}
+
+export function customerMetadataToJSON(
+  customerMetadata: CustomerMetadata,
+): string {
+  return JSON.stringify(
+    CustomerMetadata$outboundSchema.parse(customerMetadata),
+  );
+}
+
+export function customerMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const Checkout$inboundSchema: z.ZodType<
   Checkout,
@@ -456,6 +507,9 @@ export const Checkout$inboundSchema: z.ZodType<
   ),
   subscription_id: z.nullable(z.string()),
   attached_custom_fields: z.array(AttachedCustomField$inboundSchema),
+  customer_metadata: z.record(
+    z.union([z.string(), z.number().int(), z.boolean()]),
+  ),
 }).transform((v) => {
   return remap$(v, {
     "created_at": "createdAt",
@@ -488,6 +542,7 @@ export const Checkout$inboundSchema: z.ZodType<
     "product_price": "productPrice",
     "subscription_id": "subscriptionId",
     "attached_custom_fields": "attachedCustomFields",
+    "customer_metadata": "customerMetadata",
   });
 });
 
@@ -536,6 +591,7 @@ export type Checkout$Outbound = {
     | null;
   subscription_id: string | null;
   attached_custom_fields: Array<AttachedCustomField$Outbound>;
+  customer_metadata: { [k: string]: string | number | boolean };
 };
 
 /** @internal */
@@ -592,6 +648,9 @@ export const Checkout$outboundSchema: z.ZodType<
   ),
   subscriptionId: z.nullable(z.string()),
   attachedCustomFields: z.array(AttachedCustomField$outboundSchema),
+  customerMetadata: z.record(
+    z.union([z.string(), z.number().int(), z.boolean()]),
+  ),
 }).transform((v) => {
   return remap$(v, {
     createdAt: "created_at",
@@ -624,6 +683,7 @@ export const Checkout$outboundSchema: z.ZodType<
     productPrice: "product_price",
     subscriptionId: "subscription_id",
     attachedCustomFields: "attached_custom_fields",
+    customerMetadata: "customer_metadata",
   });
 });
 

package/src/models/components/checkoutlinkupdate.ts

@@ -14,20 +14,6 @@ export type CheckoutLinkUpdateMetadata = string | number | boolean;
  * Schema to update an existing checkout link.
  */
 export type CheckoutLinkUpdate = {
-  /**
-   * Key-value object allowing you to store additional information.
-   *
-   * @remarks
-   *
-   * The key must be a string with a maximum length of **40 characters**.
-   * The value must be either:
-   *
-   * * A string with a maximum length of **500 characters**
-   * * An integer
-   * * A boolean
-   *
-   * You can store up to **50 key-value pairs**.
-   */
   metadata?: { [k: string]: string | number | boolean } | null | undefined;
   label?: string | null | undefined;
   /**

package/src/models/components/checkoutpricecreate.ts

@@ -35,6 +35,8 @@ export type CheckoutPriceCreatePaymentProcessor = ClosedEnum<
   typeof CheckoutPriceCreatePaymentProcessor
 >;
 
+export type CheckoutPriceCreateCustomerMetadata = string | number | boolean;
+
 /**
  * Create a new checkout session from a product price.
  *
@@ -85,6 +87,21 @@ export type CheckoutPriceCreate = {
   customerIpAddress?: string | null | undefined;
   customerBillingAddress?: Address | null | undefined;
   customerTaxId?: string | null | undefined;
+  /**
+   * Key-value object allowing you to store additional information that'll be copied to the created customer.
+   *
+   * @remarks
+   *
+   * The key must be a string with a maximum length of **40 characters**.
+   * The value must be either:
+   *
+   * * A string with a maximum length of **500 characters**
+   * * An integer
+   * * A boolean
+   *
+   * You can store up to **50 key-value pairs**.
+   */
+  customerMetadata?: { [k: string]: string | number | boolean } | undefined;
   /**
    * ID of a subscription to upgrade. It must be on a free pricing. If checkout is successful, metadata set on this checkout will be copied to the subscription, and existing keys will be overwritten.
    */
@@ -228,6 +245,62 @@ export namespace CheckoutPriceCreatePaymentProcessor$ {
     CheckoutPriceCreatePaymentProcessor$outboundSchema;
 }
 
+/** @internal */
+export const CheckoutPriceCreateCustomerMetadata$inboundSchema: z.ZodType<
+  CheckoutPriceCreateCustomerMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/** @internal */
+export type CheckoutPriceCreateCustomerMetadata$Outbound =
+  | string
+  | number
+  | boolean;
+
+/** @internal */
+export const CheckoutPriceCreateCustomerMetadata$outboundSchema: z.ZodType<
+  CheckoutPriceCreateCustomerMetadata$Outbound,
+  z.ZodTypeDef,
+  CheckoutPriceCreateCustomerMetadata
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CheckoutPriceCreateCustomerMetadata$ {
+  /** @deprecated use `CheckoutPriceCreateCustomerMetadata$inboundSchema` instead. */
+  export const inboundSchema =
+    CheckoutPriceCreateCustomerMetadata$inboundSchema;
+  /** @deprecated use `CheckoutPriceCreateCustomerMetadata$outboundSchema` instead. */
+  export const outboundSchema =
+    CheckoutPriceCreateCustomerMetadata$outboundSchema;
+  /** @deprecated use `CheckoutPriceCreateCustomerMetadata$Outbound` instead. */
+  export type Outbound = CheckoutPriceCreateCustomerMetadata$Outbound;
+}
+
+export function checkoutPriceCreateCustomerMetadataToJSON(
+  checkoutPriceCreateCustomerMetadata: CheckoutPriceCreateCustomerMetadata,
+): string {
+  return JSON.stringify(
+    CheckoutPriceCreateCustomerMetadata$outboundSchema.parse(
+      checkoutPriceCreateCustomerMetadata,
+    ),
+  );
+}
+
+export function checkoutPriceCreateCustomerMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<CheckoutPriceCreateCustomerMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CheckoutPriceCreateCustomerMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CheckoutPriceCreateCustomerMetadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const CheckoutPriceCreate$inboundSchema: z.ZodType<
   CheckoutPriceCreate,
@@ -249,6 +322,9 @@ export const CheckoutPriceCreate$inboundSchema: z.ZodType<
   customer_ip_address: z.nullable(z.string()).optional(),
   customer_billing_address: z.nullable(Address$inboundSchema).optional(),
   customer_tax_id: z.nullable(z.string()).optional(),
+  customer_metadata: z.record(
+    z.union([z.string(), z.number().int(), z.boolean()]),
+  ).optional(),
   subscription_id: z.nullable(z.string()).optional(),
   success_url: z.nullable(z.string()).optional(),
   embed_origin: z.nullable(z.string()).optional(),
@@ -265,6 +341,7 @@ export const CheckoutPriceCreate$inboundSchema: z.ZodType<
     "customer_ip_address": "customerIpAddress",
     "customer_billing_address": "customerBillingAddress",
     "customer_tax_id": "customerTaxId",
+    "customer_metadata": "customerMetadata",
     "subscription_id": "subscriptionId",
     "success_url": "successUrl",
     "embed_origin": "embedOrigin",
@@ -286,6 +363,7 @@ export type CheckoutPriceCreate$Outbound = {
   customer_ip_address?: string | null | undefined;
   customer_billing_address?: Address$Outbound | null | undefined;
   customer_tax_id?: string | null | undefined;
+  customer_metadata?: { [k: string]: string | number | boolean } | undefined;
   subscription_id?: string | null | undefined;
   success_url?: string | null | undefined;
   embed_origin?: string | null | undefined;
@@ -313,6 +391,9 @@ export const CheckoutPriceCreate$outboundSchema: z.ZodType<
   customerIpAddress: z.nullable(z.string()).optional(),
   customerBillingAddress: z.nullable(Address$outboundSchema).optional(),
   customerTaxId: z.nullable(z.string()).optional(),
+  customerMetadata: z.record(
+    z.union([z.string(), z.number().int(), z.boolean()]),
+  ).optional(),
   subscriptionId: z.nullable(z.string()).optional(),
   successUrl: z.nullable(z.string()).optional(),
   embedOrigin: z.nullable(z.string()).optional(),
@@ -329,6 +410,7 @@ export const CheckoutPriceCreate$outboundSchema: z.ZodType<
     customerIpAddress: "customer_ip_address",
     customerBillingAddress: "customer_billing_address",
     customerTaxId: "customer_tax_id",
+    customerMetadata: "customer_metadata",
     subscriptionId: "subscription_id",
     successUrl: "success_url",
     embedOrigin: "embed_origin",