@polar-sh/sdk 0.29.0 → 0.29.2

package/src/models/components/customerstate.ts

@@ -0,0 +1,308 @@
+/*
+ * 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 {
+  Address,
+  Address$inboundSchema,
+  Address$Outbound,
+  Address$outboundSchema,
+} from "./address.js";
+import {
+  CustomerStateBenefitGrant,
+  CustomerStateBenefitGrant$inboundSchema,
+  CustomerStateBenefitGrant$Outbound,
+  CustomerStateBenefitGrant$outboundSchema,
+} from "./customerstatebenefitgrant.js";
+import {
+  CustomerStateSubscription,
+  CustomerStateSubscription$inboundSchema,
+  CustomerStateSubscription$Outbound,
+  CustomerStateSubscription$outboundSchema,
+} from "./customerstatesubscription.js";
+import {
+  TaxIDFormat,
+  TaxIDFormat$inboundSchema,
+  TaxIDFormat$outboundSchema,
+} from "./taxidformat.js";
+
+export type CustomerStateMetadata = string | number | boolean;
+
+export type CustomerStateTaxId = string | TaxIDFormat;
+
+/**
+ * A customer along with additional state information:
+ *
+ * @remarks
+ *
+ * * Active subscriptions
+ * * Active benefits
+ */
+export type CustomerState = {
+  /**
+   * The ID of the customer.
+   */
+  id: string;
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  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.
+   */
+  externalId: string | null;
+  /**
+   * The email address of the customer. This must be unique within the organization.
+   */
+  email: string;
+  /**
+   * 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;
+  /**
+   * The customer's active subscriptions.
+   */
+  activeSubscriptions: Array<CustomerStateSubscription>;
+  /**
+   * The customer's active benefit grants.
+   */
+  grantedBenefits: Array<CustomerStateBenefitGrant>;
+  avatarUrl: string;
+};
+
+/** @internal */
+export const CustomerStateMetadata$inboundSchema: z.ZodType<
+  CustomerStateMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number().int(), z.boolean()]);
+
+/** @internal */
+export type CustomerStateMetadata$Outbound = string | number | boolean;
+
+/** @internal */
+export const CustomerStateMetadata$outboundSchema: z.ZodType<
+  CustomerStateMetadata$Outbound,
+  z.ZodTypeDef,
+  CustomerStateMetadata
+> = 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 CustomerStateMetadata$ {
+  /** @deprecated use `CustomerStateMetadata$inboundSchema` instead. */
+  export const inboundSchema = CustomerStateMetadata$inboundSchema;
+  /** @deprecated use `CustomerStateMetadata$outboundSchema` instead. */
+  export const outboundSchema = CustomerStateMetadata$outboundSchema;
+  /** @deprecated use `CustomerStateMetadata$Outbound` instead. */
+  export type Outbound = CustomerStateMetadata$Outbound;
+}
+
+export function customerStateMetadataToJSON(
+  customerStateMetadata: CustomerStateMetadata,
+): string {
+  return JSON.stringify(
+    CustomerStateMetadata$outboundSchema.parse(customerStateMetadata),
+  );
+}
+
+export function customerStateMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerStateMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerStateMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerStateMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const CustomerStateTaxId$inboundSchema: z.ZodType<
+  CustomerStateTaxId,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), TaxIDFormat$inboundSchema]);
+
+/** @internal */
+export type CustomerStateTaxId$Outbound = string | string;
+
+/** @internal */
+export const CustomerStateTaxId$outboundSchema: z.ZodType<
+  CustomerStateTaxId$Outbound,
+  z.ZodTypeDef,
+  CustomerStateTaxId
+> = z.union([z.string(), TaxIDFormat$outboundSchema]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerStateTaxId$ {
+  /** @deprecated use `CustomerStateTaxId$inboundSchema` instead. */
+  export const inboundSchema = CustomerStateTaxId$inboundSchema;
+  /** @deprecated use `CustomerStateTaxId$outboundSchema` instead. */
+  export const outboundSchema = CustomerStateTaxId$outboundSchema;
+  /** @deprecated use `CustomerStateTaxId$Outbound` instead. */
+  export type Outbound = CustomerStateTaxId$Outbound;
+}
+
+export function customerStateTaxIdToJSON(
+  customerStateTaxId: CustomerStateTaxId,
+): string {
+  return JSON.stringify(
+    CustomerStateTaxId$outboundSchema.parse(customerStateTaxId),
+  );
+}
+
+export function customerStateTaxIdFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerStateTaxId, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerStateTaxId$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerStateTaxId' from JSON`,
+  );
+}
+
+/** @internal */
+export const CustomerState$inboundSchema: z.ZodType<
+  CustomerState,
+  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)),
+  ),
+  metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
+  external_id: z.nullable(z.string()),
+  email: z.string(),
+  email_verified: z.boolean(),
+  name: z.nullable(z.string()),
+  billing_address: z.nullable(Address$inboundSchema),
+  tax_id: z.nullable(
+    z.array(z.nullable(z.union([z.string(), TaxIDFormat$inboundSchema]))),
+  ),
+  organization_id: z.string(),
+  active_subscriptions: z.array(CustomerStateSubscription$inboundSchema),
+  granted_benefits: z.array(CustomerStateBenefitGrant$inboundSchema),
+  avatar_url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "modified_at": "modifiedAt",
+    "external_id": "externalId",
+    "email_verified": "emailVerified",
+    "billing_address": "billingAddress",
+    "tax_id": "taxId",
+    "organization_id": "organizationId",
+    "active_subscriptions": "activeSubscriptions",
+    "granted_benefits": "grantedBenefits",
+    "avatar_url": "avatarUrl",
+  });
+});
+
+/** @internal */
+export type CustomerState$Outbound = {
+  id: string;
+  created_at: string;
+  modified_at: string | null;
+  metadata: { [k: string]: string | number | boolean };
+  external_id: string | null;
+  email: string;
+  email_verified: boolean;
+  name: string | null;
+  billing_address: Address$Outbound | null;
+  tax_id: Array<string | string | null> | null;
+  organization_id: string;
+  active_subscriptions: Array<CustomerStateSubscription$Outbound>;
+  granted_benefits: Array<CustomerStateBenefitGrant$Outbound>;
+  avatar_url: string;
+};
+
+/** @internal */
+export const CustomerState$outboundSchema: z.ZodType<
+  CustomerState$Outbound,
+  z.ZodTypeDef,
+  CustomerState
+> = z.object({
+  id: z.string(),
+  createdAt: z.date().transform(v => v.toISOString()),
+  modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  metadata: z.record(z.union([z.string(), z.number().int(), z.boolean()])),
+  externalId: z.nullable(z.string()),
+  email: z.string(),
+  emailVerified: z.boolean(),
+  name: z.nullable(z.string()),
+  billingAddress: z.nullable(Address$outboundSchema),
+  taxId: z.nullable(
+    z.array(z.nullable(z.union([z.string(), TaxIDFormat$outboundSchema]))),
+  ),
+  organizationId: z.string(),
+  activeSubscriptions: z.array(CustomerStateSubscription$outboundSchema),
+  grantedBenefits: z.array(CustomerStateBenefitGrant$outboundSchema),
+  avatarUrl: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    modifiedAt: "modified_at",
+    externalId: "external_id",
+    emailVerified: "email_verified",
+    billingAddress: "billing_address",
+    taxId: "tax_id",
+    organizationId: "organization_id",
+    activeSubscriptions: "active_subscriptions",
+    grantedBenefits: "granted_benefits",
+    avatarUrl: "avatar_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerState$ {
+  /** @deprecated use `CustomerState$inboundSchema` instead. */
+  export const inboundSchema = CustomerState$inboundSchema;
+  /** @deprecated use `CustomerState$outboundSchema` instead. */
+  export const outboundSchema = CustomerState$outboundSchema;
+  /** @deprecated use `CustomerState$Outbound` instead. */
+  export type Outbound = CustomerState$Outbound;
+}
+
+export function customerStateToJSON(customerState: CustomerState): string {
+  return JSON.stringify(CustomerState$outboundSchema.parse(customerState));
+}
+
+export function customerStateFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerState, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerState$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerState' from JSON`,
+  );
+}

package/src/models/components/customerstatebenefitgrant.ts

@@ -0,0 +1,261 @@
+/*
+ * 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 {
+  BenefitGrantCustomProperties,
+  BenefitGrantCustomProperties$inboundSchema,
+  BenefitGrantCustomProperties$Outbound,
+  BenefitGrantCustomProperties$outboundSchema,
+} from "./benefitgrantcustomproperties.js";
+import {
+  BenefitGrantDiscordProperties,
+  BenefitGrantDiscordProperties$inboundSchema,
+  BenefitGrantDiscordProperties$Outbound,
+  BenefitGrantDiscordProperties$outboundSchema,
+} from "./benefitgrantdiscordproperties.js";
+import {
+  BenefitGrantDownloadablesProperties,
+  BenefitGrantDownloadablesProperties$inboundSchema,
+  BenefitGrantDownloadablesProperties$Outbound,
+  BenefitGrantDownloadablesProperties$outboundSchema,
+} from "./benefitgrantdownloadablesproperties.js";
+import {
+  BenefitGrantGitHubRepositoryProperties,
+  BenefitGrantGitHubRepositoryProperties$inboundSchema,
+  BenefitGrantGitHubRepositoryProperties$Outbound,
+  BenefitGrantGitHubRepositoryProperties$outboundSchema,
+} from "./benefitgrantgithubrepositoryproperties.js";
+import {
+  BenefitGrantLicenseKeysProperties,
+  BenefitGrantLicenseKeysProperties$inboundSchema,
+  BenefitGrantLicenseKeysProperties$Outbound,
+  BenefitGrantLicenseKeysProperties$outboundSchema,
+} from "./benefitgrantlicensekeysproperties.js";
+import {
+  BenefitType,
+  BenefitType$inboundSchema,
+  BenefitType$outboundSchema,
+} from "./benefittype.js";
+
+export type CustomerStateBenefitGrantProperties =
+  | BenefitGrantCustomProperties
+  | BenefitGrantDownloadablesProperties
+  | BenefitGrantLicenseKeysProperties
+  | BenefitGrantDiscordProperties
+  | BenefitGrantGitHubRepositoryProperties;
+
+/**
+ * An active benefit grant for a customer.
+ */
+export type CustomerStateBenefitGrant = {
+  /**
+   * The ID of the grant.
+   */
+  id: string;
+  /**
+   * Creation timestamp of the object.
+   */
+  createdAt: Date;
+  /**
+   * Last modification timestamp of the object.
+   */
+  modifiedAt: Date | null;
+  /**
+   * The timestamp when the benefit was granted.
+   */
+  grantedAt: Date;
+  /**
+   * The ID of the benefit concerned by this grant.
+   */
+  benefitId: string;
+  benefitType: BenefitType;
+  properties:
+    | BenefitGrantCustomProperties
+    | BenefitGrantDownloadablesProperties
+    | BenefitGrantLicenseKeysProperties
+    | BenefitGrantDiscordProperties
+    | BenefitGrantGitHubRepositoryProperties;
+};
+
+/** @internal */
+export const CustomerStateBenefitGrantProperties$inboundSchema: z.ZodType<
+  CustomerStateBenefitGrantProperties,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  BenefitGrantCustomProperties$inboundSchema,
+  BenefitGrantDownloadablesProperties$inboundSchema,
+  BenefitGrantLicenseKeysProperties$inboundSchema,
+  BenefitGrantDiscordProperties$inboundSchema,
+  BenefitGrantGitHubRepositoryProperties$inboundSchema,
+]);
+
+/** @internal */
+export type CustomerStateBenefitGrantProperties$Outbound =
+  | BenefitGrantCustomProperties$Outbound
+  | BenefitGrantDownloadablesProperties$Outbound
+  | BenefitGrantLicenseKeysProperties$Outbound
+  | BenefitGrantDiscordProperties$Outbound
+  | BenefitGrantGitHubRepositoryProperties$Outbound;
+
+/** @internal */
+export const CustomerStateBenefitGrantProperties$outboundSchema: z.ZodType<
+  CustomerStateBenefitGrantProperties$Outbound,
+  z.ZodTypeDef,
+  CustomerStateBenefitGrantProperties
+> = z.union([
+  BenefitGrantCustomProperties$outboundSchema,
+  BenefitGrantDownloadablesProperties$outboundSchema,
+  BenefitGrantLicenseKeysProperties$outboundSchema,
+  BenefitGrantDiscordProperties$outboundSchema,
+  BenefitGrantGitHubRepositoryProperties$outboundSchema,
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerStateBenefitGrantProperties$ {
+  /** @deprecated use `CustomerStateBenefitGrantProperties$inboundSchema` instead. */
+  export const inboundSchema =
+    CustomerStateBenefitGrantProperties$inboundSchema;
+  /** @deprecated use `CustomerStateBenefitGrantProperties$outboundSchema` instead. */
+  export const outboundSchema =
+    CustomerStateBenefitGrantProperties$outboundSchema;
+  /** @deprecated use `CustomerStateBenefitGrantProperties$Outbound` instead. */
+  export type Outbound = CustomerStateBenefitGrantProperties$Outbound;
+}
+
+export function customerStateBenefitGrantPropertiesToJSON(
+  customerStateBenefitGrantProperties: CustomerStateBenefitGrantProperties,
+): string {
+  return JSON.stringify(
+    CustomerStateBenefitGrantProperties$outboundSchema.parse(
+      customerStateBenefitGrantProperties,
+    ),
+  );
+}
+
+export function customerStateBenefitGrantPropertiesFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerStateBenefitGrantProperties, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CustomerStateBenefitGrantProperties$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerStateBenefitGrantProperties' from JSON`,
+  );
+}
+
+/** @internal */
+export const CustomerStateBenefitGrant$inboundSchema: z.ZodType<
+  CustomerStateBenefitGrant,
+  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)),
+  ),
+  granted_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  benefit_id: z.string(),
+  benefit_type: BenefitType$inboundSchema,
+  properties: z.union([
+    BenefitGrantCustomProperties$inboundSchema,
+    BenefitGrantDownloadablesProperties$inboundSchema,
+    BenefitGrantLicenseKeysProperties$inboundSchema,
+    BenefitGrantDiscordProperties$inboundSchema,
+    BenefitGrantGitHubRepositoryProperties$inboundSchema,
+  ]),
+}).transform((v) => {
+  return remap$(v, {
+    "created_at": "createdAt",
+    "modified_at": "modifiedAt",
+    "granted_at": "grantedAt",
+    "benefit_id": "benefitId",
+    "benefit_type": "benefitType",
+  });
+});
+
+/** @internal */
+export type CustomerStateBenefitGrant$Outbound = {
+  id: string;
+  created_at: string;
+  modified_at: string | null;
+  granted_at: string;
+  benefit_id: string;
+  benefit_type: string;
+  properties:
+    | BenefitGrantCustomProperties$Outbound
+    | BenefitGrantDownloadablesProperties$Outbound
+    | BenefitGrantLicenseKeysProperties$Outbound
+    | BenefitGrantDiscordProperties$Outbound
+    | BenefitGrantGitHubRepositoryProperties$Outbound;
+};
+
+/** @internal */
+export const CustomerStateBenefitGrant$outboundSchema: z.ZodType<
+  CustomerStateBenefitGrant$Outbound,
+  z.ZodTypeDef,
+  CustomerStateBenefitGrant
+> = z.object({
+  id: z.string(),
+  createdAt: z.date().transform(v => v.toISOString()),
+  modifiedAt: z.nullable(z.date().transform(v => v.toISOString())),
+  grantedAt: z.date().transform(v => v.toISOString()),
+  benefitId: z.string(),
+  benefitType: BenefitType$outboundSchema,
+  properties: z.union([
+    BenefitGrantCustomProperties$outboundSchema,
+    BenefitGrantDownloadablesProperties$outboundSchema,
+    BenefitGrantLicenseKeysProperties$outboundSchema,
+    BenefitGrantDiscordProperties$outboundSchema,
+    BenefitGrantGitHubRepositoryProperties$outboundSchema,
+  ]),
+}).transform((v) => {
+  return remap$(v, {
+    createdAt: "created_at",
+    modifiedAt: "modified_at",
+    grantedAt: "granted_at",
+    benefitId: "benefit_id",
+    benefitType: "benefit_type",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerStateBenefitGrant$ {
+  /** @deprecated use `CustomerStateBenefitGrant$inboundSchema` instead. */
+  export const inboundSchema = CustomerStateBenefitGrant$inboundSchema;
+  /** @deprecated use `CustomerStateBenefitGrant$outboundSchema` instead. */
+  export const outboundSchema = CustomerStateBenefitGrant$outboundSchema;
+  /** @deprecated use `CustomerStateBenefitGrant$Outbound` instead. */
+  export type Outbound = CustomerStateBenefitGrant$Outbound;
+}
+
+export function customerStateBenefitGrantToJSON(
+  customerStateBenefitGrant: CustomerStateBenefitGrant,
+): string {
+  return JSON.stringify(
+    CustomerStateBenefitGrant$outboundSchema.parse(customerStateBenefitGrant),
+  );
+}
+
+export function customerStateBenefitGrantFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomerStateBenefitGrant, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomerStateBenefitGrant$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomerStateBenefitGrant' from JSON`,
+  );
+}