@polar-sh/sdk 0.29.0 → 0.29.2

package/src/models/components/subscriptioncustomer.ts

@@ -24,6 +24,10 @@ export type SubscriptionCustomerMetadata = string | number | boolean;
 export type SubscriptionCustomerTaxId = string | TaxIDFormat;
 
 export type SubscriptionCustomer = {
+  /**
+   * The ID of the customer.
+   */
+  id: string;
   /**
    * Creation timestamp of the object.
    */
@@ -32,10 +36,6 @@ export type SubscriptionCustomer = {
    * 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.
@@ -49,9 +49,15 @@ export type SubscriptionCustomer = {
    * 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;
 };
@@ -160,11 +166,11 @@ export const SubscriptionCustomer$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(),
@@ -191,9 +197,9 @@ export const SubscriptionCustomer$inboundSchema: z.ZodType<
 
 /** @internal */
 export type SubscriptionCustomer$Outbound = {
+  id: string;
   created_at: string;
   modified_at: string | null;
-  id: string;
   metadata: { [k: string]: string | number | boolean };
   external_id: string | null;
   email: string;
@@ -211,9 +217,9 @@ export const SubscriptionCustomer$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SubscriptionCustomer
 > = 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/webhookcustomercreatedpayload.ts

@@ -0,0 +1,93 @@
+/*
+ * 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";
+import {
+  Customer,
+  Customer$inboundSchema,
+  Customer$Outbound,
+  Customer$outboundSchema,
+} from "./customer.js";
+
+/**
+ * Sent when a new customer is created.
+ *
+ * @remarks
+ *
+ * A customer can be created:
+ *
+ * * After a successful checkout.
+ * * Programmatically via the API.
+ *
+ * **Discord & Slack support:** Basic
+ */
+export type WebhookCustomerCreatedPayload = {
+  type?: "customer.created" | undefined;
+  /**
+   * A customer in an organization.
+   */
+  data: Customer;
+};
+
+/** @internal */
+export const WebhookCustomerCreatedPayload$inboundSchema: z.ZodType<
+  WebhookCustomerCreatedPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("customer.created").optional(),
+  data: Customer$inboundSchema,
+});
+
+/** @internal */
+export type WebhookCustomerCreatedPayload$Outbound = {
+  type: "customer.created";
+  data: Customer$Outbound;
+};
+
+/** @internal */
+export const WebhookCustomerCreatedPayload$outboundSchema: z.ZodType<
+  WebhookCustomerCreatedPayload$Outbound,
+  z.ZodTypeDef,
+  WebhookCustomerCreatedPayload
+> = z.object({
+  type: z.literal("customer.created").default("customer.created" as const),
+  data: Customer$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WebhookCustomerCreatedPayload$ {
+  /** @deprecated use `WebhookCustomerCreatedPayload$inboundSchema` instead. */
+  export const inboundSchema = WebhookCustomerCreatedPayload$inboundSchema;
+  /** @deprecated use `WebhookCustomerCreatedPayload$outboundSchema` instead. */
+  export const outboundSchema = WebhookCustomerCreatedPayload$outboundSchema;
+  /** @deprecated use `WebhookCustomerCreatedPayload$Outbound` instead. */
+  export type Outbound = WebhookCustomerCreatedPayload$Outbound;
+}
+
+export function webhookCustomerCreatedPayloadToJSON(
+  webhookCustomerCreatedPayload: WebhookCustomerCreatedPayload,
+): string {
+  return JSON.stringify(
+    WebhookCustomerCreatedPayload$outboundSchema.parse(
+      webhookCustomerCreatedPayload,
+    ),
+  );
+}
+
+export function webhookCustomerCreatedPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookCustomerCreatedPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebhookCustomerCreatedPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookCustomerCreatedPayload' from JSON`,
+  );
+}

package/src/models/components/webhookcustomerdeletedpayload.ts

@@ -0,0 +1,88 @@
+/*
+ * 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";
+import {
+  Customer,
+  Customer$inboundSchema,
+  Customer$Outbound,
+  Customer$outboundSchema,
+} from "./customer.js";
+
+/**
+ * Sent when a customer is deleted.
+ *
+ * @remarks
+ *
+ * **Discord & Slack support:** Basic
+ */
+export type WebhookCustomerDeletedPayload = {
+  type?: "customer.deleted" | undefined;
+  /**
+   * A customer in an organization.
+   */
+  data: Customer;
+};
+
+/** @internal */
+export const WebhookCustomerDeletedPayload$inboundSchema: z.ZodType<
+  WebhookCustomerDeletedPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("customer.deleted").optional(),
+  data: Customer$inboundSchema,
+});
+
+/** @internal */
+export type WebhookCustomerDeletedPayload$Outbound = {
+  type: "customer.deleted";
+  data: Customer$Outbound;
+};
+
+/** @internal */
+export const WebhookCustomerDeletedPayload$outboundSchema: z.ZodType<
+  WebhookCustomerDeletedPayload$Outbound,
+  z.ZodTypeDef,
+  WebhookCustomerDeletedPayload
+> = z.object({
+  type: z.literal("customer.deleted").default("customer.deleted" as const),
+  data: Customer$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WebhookCustomerDeletedPayload$ {
+  /** @deprecated use `WebhookCustomerDeletedPayload$inboundSchema` instead. */
+  export const inboundSchema = WebhookCustomerDeletedPayload$inboundSchema;
+  /** @deprecated use `WebhookCustomerDeletedPayload$outboundSchema` instead. */
+  export const outboundSchema = WebhookCustomerDeletedPayload$outboundSchema;
+  /** @deprecated use `WebhookCustomerDeletedPayload$Outbound` instead. */
+  export type Outbound = WebhookCustomerDeletedPayload$Outbound;
+}
+
+export function webhookCustomerDeletedPayloadToJSON(
+  webhookCustomerDeletedPayload: WebhookCustomerDeletedPayload,
+): string {
+  return JSON.stringify(
+    WebhookCustomerDeletedPayload$outboundSchema.parse(
+      webhookCustomerDeletedPayload,
+    ),
+  );
+}
+
+export function webhookCustomerDeletedPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookCustomerDeletedPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebhookCustomerDeletedPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookCustomerDeletedPayload' from JSON`,
+  );
+}

package/src/models/components/webhookcustomerstatechangedpayload.ts

@@ -0,0 +1,103 @@
+/*
+ * 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";
+import {
+  CustomerState,
+  CustomerState$inboundSchema,
+  CustomerState$Outbound,
+  CustomerState$outboundSchema,
+} from "./customerstate.js";
+
+/**
+ * Sent when a customer state has changed.
+ *
+ * @remarks
+ *
+ * It's triggered when:
+ *
+ * * Customer is created, updated or deleted.
+ * * A subscription is created or updated.
+ * * A benefit is granted or revoked.
+ *
+ * **Discord & Slack support:** Basic
+ */
+export type WebhookCustomerStateChangedPayload = {
+  type?: "customer.state_changed" | undefined;
+  /**
+   * A customer along with additional state information:
+   *
+   * @remarks
+   *
+   * * Active subscriptions
+   * * Active benefits
+   */
+  data: CustomerState;
+};
+
+/** @internal */
+export const WebhookCustomerStateChangedPayload$inboundSchema: z.ZodType<
+  WebhookCustomerStateChangedPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("customer.state_changed").optional(),
+  data: CustomerState$inboundSchema,
+});
+
+/** @internal */
+export type WebhookCustomerStateChangedPayload$Outbound = {
+  type: "customer.state_changed";
+  data: CustomerState$Outbound;
+};
+
+/** @internal */
+export const WebhookCustomerStateChangedPayload$outboundSchema: z.ZodType<
+  WebhookCustomerStateChangedPayload$Outbound,
+  z.ZodTypeDef,
+  WebhookCustomerStateChangedPayload
+> = z.object({
+  type: z.literal("customer.state_changed").default(
+    "customer.state_changed" as const,
+  ),
+  data: CustomerState$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WebhookCustomerStateChangedPayload$ {
+  /** @deprecated use `WebhookCustomerStateChangedPayload$inboundSchema` instead. */
+  export const inboundSchema = WebhookCustomerStateChangedPayload$inboundSchema;
+  /** @deprecated use `WebhookCustomerStateChangedPayload$outboundSchema` instead. */
+  export const outboundSchema =
+    WebhookCustomerStateChangedPayload$outboundSchema;
+  /** @deprecated use `WebhookCustomerStateChangedPayload$Outbound` instead. */
+  export type Outbound = WebhookCustomerStateChangedPayload$Outbound;
+}
+
+export function webhookCustomerStateChangedPayloadToJSON(
+  webhookCustomerStateChangedPayload: WebhookCustomerStateChangedPayload,
+): string {
+  return JSON.stringify(
+    WebhookCustomerStateChangedPayload$outboundSchema.parse(
+      webhookCustomerStateChangedPayload,
+    ),
+  );
+}
+
+export function webhookCustomerStateChangedPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookCustomerStateChangedPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      WebhookCustomerStateChangedPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookCustomerStateChangedPayload' from JSON`,
+  );
+}

package/src/models/components/webhookcustomerupdatedpayload.ts

@@ -0,0 +1,92 @@
+/*
+ * 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";
+import {
+  Customer,
+  Customer$inboundSchema,
+  Customer$Outbound,
+  Customer$outboundSchema,
+} from "./customer.js";
+
+/**
+ * Sent when a customer is updated.
+ *
+ * @remarks
+ *
+ * This event is fired when the customer details are updated.
+ *
+ * If you want to be notified when a customer subscription or benefit state changes, you should listen to the `customer_state_changed` event.
+ *
+ * **Discord & Slack support:** Basic
+ */
+export type WebhookCustomerUpdatedPayload = {
+  type?: "customer.updated" | undefined;
+  /**
+   * A customer in an organization.
+   */
+  data: Customer;
+};
+
+/** @internal */
+export const WebhookCustomerUpdatedPayload$inboundSchema: z.ZodType<
+  WebhookCustomerUpdatedPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("customer.updated").optional(),
+  data: Customer$inboundSchema,
+});
+
+/** @internal */
+export type WebhookCustomerUpdatedPayload$Outbound = {
+  type: "customer.updated";
+  data: Customer$Outbound;
+};
+
+/** @internal */
+export const WebhookCustomerUpdatedPayload$outboundSchema: z.ZodType<
+  WebhookCustomerUpdatedPayload$Outbound,
+  z.ZodTypeDef,
+  WebhookCustomerUpdatedPayload
+> = z.object({
+  type: z.literal("customer.updated").default("customer.updated" as const),
+  data: Customer$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WebhookCustomerUpdatedPayload$ {
+  /** @deprecated use `WebhookCustomerUpdatedPayload$inboundSchema` instead. */
+  export const inboundSchema = WebhookCustomerUpdatedPayload$inboundSchema;
+  /** @deprecated use `WebhookCustomerUpdatedPayload$outboundSchema` instead. */
+  export const outboundSchema = WebhookCustomerUpdatedPayload$outboundSchema;
+  /** @deprecated use `WebhookCustomerUpdatedPayload$Outbound` instead. */
+  export type Outbound = WebhookCustomerUpdatedPayload$Outbound;
+}
+
+export function webhookCustomerUpdatedPayloadToJSON(
+  webhookCustomerUpdatedPayload: WebhookCustomerUpdatedPayload,
+): string {
+  return JSON.stringify(
+    WebhookCustomerUpdatedPayload$outboundSchema.parse(
+      webhookCustomerUpdatedPayload,
+    ),
+  );
+}
+
+export function webhookCustomerUpdatedPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookCustomerUpdatedPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WebhookCustomerUpdatedPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookCustomerUpdatedPayload' from JSON`,
+  );
+}

package/src/models/components/webhookordercreatedpayload.ts

@@ -18,6 +18,13 @@ import {
  *
  * @remarks
  *
+ * A new order is created when:
+ *
+ * * A customer purchases a one-time product. In this case, `billing_reason` is set to `purchase`.
+ * * A customer starts a subscription. In this case, `billing_reason` is set to `subscription_create`.
+ * * A subscription is renewed. In this case, `billing_reason` is set to `subscription_cycle`.
+ * * A subscription is upgraded, downgraded or revoked with an immediate proration invoice. In this case, `billing_reason` is set to `subscription_update`.
+ *
  * **Discord & Slack support:** Full
  */
 export type WebhookOrderCreatedPayload = {

package/src/models/components/webhooksubscriptioncreatedpayload.ts

@@ -18,6 +18,8 @@ import {
  *
  * @remarks
  *
+ * When this event occurs, the subscription `status` might not be `active` yet, as we can still have to wait for the first payment to be processed.
+ *
  * **Discord & Slack support:** Full
  */
 export type WebhookSubscriptionCreatedPayload = {

package/src/models/operations/customersgetstate.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 CustomersGetStateRequest = {
+  /**
+   * The customer ID.
+   */
+  id: string;
+};
+
+/** @internal */
+export const CustomersGetStateRequest$inboundSchema: z.ZodType<
+  CustomersGetStateRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+});
+
+/** @internal */
+export type CustomersGetStateRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const CustomersGetStateRequest$outboundSchema: z.ZodType<
+  CustomersGetStateRequest$Outbound,
+  z.ZodTypeDef,
+  CustomersGetStateRequest
+> = z.object({
+  id: 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 CustomersGetStateRequest$ {
+  /** @deprecated use `CustomersGetStateRequest$inboundSchema` instead. */
+  export const inboundSchema = CustomersGetStateRequest$inboundSchema;
+  /** @deprecated use `CustomersGetStateRequest$outboundSchema` instead. */
+  export const outboundSchema = CustomersGetStateRequest$outboundSchema;
+  /** @deprecated use `CustomersGetStateRequest$Outbound` instead. */
+  export type Outbound = CustomersGetStateRequest$Outbound;
+}
+
+export function customersGetStateRequestToJSON(
+  customersGetStateRequest: CustomersGetStateRequest,
+): string {
+  return JSON.stringify(
+    CustomersGetStateRequest$outboundSchema.parse(customersGetStateRequest),
+  );
+}
+
+export function customersGetStateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomersGetStateRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomersGetStateRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomersGetStateRequest' from JSON`,
+  );
+}

package/src/models/operations/customersgetstateexternal.ts

@@ -0,0 +1,80 @@
+/*
+ * 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";
+
+export type CustomersGetStateExternalRequest = {
+  /**
+   * The customer external ID.
+   */
+  externalId: string;
+};
+
+/** @internal */
+export const CustomersGetStateExternalRequest$inboundSchema: z.ZodType<
+  CustomersGetStateExternalRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  external_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "external_id": "externalId",
+  });
+});
+
+/** @internal */
+export type CustomersGetStateExternalRequest$Outbound = {
+  external_id: string;
+};
+
+/** @internal */
+export const CustomersGetStateExternalRequest$outboundSchema: z.ZodType<
+  CustomersGetStateExternalRequest$Outbound,
+  z.ZodTypeDef,
+  CustomersGetStateExternalRequest
+> = z.object({
+  externalId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    externalId: "external_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomersGetStateExternalRequest$ {
+  /** @deprecated use `CustomersGetStateExternalRequest$inboundSchema` instead. */
+  export const inboundSchema = CustomersGetStateExternalRequest$inboundSchema;
+  /** @deprecated use `CustomersGetStateExternalRequest$outboundSchema` instead. */
+  export const outboundSchema = CustomersGetStateExternalRequest$outboundSchema;
+  /** @deprecated use `CustomersGetStateExternalRequest$Outbound` instead. */
+  export type Outbound = CustomersGetStateExternalRequest$Outbound;
+}
+
+export function customersGetStateExternalRequestToJSON(
+  customersGetStateExternalRequest: CustomersGetStateExternalRequest,
+): string {
+  return JSON.stringify(
+    CustomersGetStateExternalRequest$outboundSchema.parse(
+      customersGetStateExternalRequest,
+    ),
+  );
+}
+
+export function customersGetStateExternalRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomersGetStateExternalRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomersGetStateExternalRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomersGetStateExternalRequest' from JSON`,
+  );
+}

package/src/sdk/customers.ts

@@ -7,16 +7,21 @@ import { customersDelete } from "../funcs/customersDelete.js";
 import { customersDeleteExternal } from "../funcs/customersDeleteExternal.js";
 import { customersGet } from "../funcs/customersGet.js";
 import { customersGetExternal } from "../funcs/customersGetExternal.js";
+import { customersGetState } from "../funcs/customersGetState.js";
+import { customersGetStateExternal } from "../funcs/customersGetStateExternal.js";
 import { customersList } from "../funcs/customersList.js";
 import { customersUpdate } from "../funcs/customersUpdate.js";
 import { customersUpdateExternal } from "../funcs/customersUpdateExternal.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import { Customer } from "../models/components/customer.js";
 import { CustomerCreate } from "../models/components/customercreate.js";
+import { CustomerState } from "../models/components/customerstate.js";
 import { CustomersDeleteRequest } from "../models/operations/customersdelete.js";
 import { CustomersDeleteExternalRequest } from "../models/operations/customersdeleteexternal.js";
 import { CustomersGetRequest } from "../models/operations/customersget.js";
 import { CustomersGetExternalRequest } from "../models/operations/customersgetexternal.js";
+import { CustomersGetStateRequest } from "../models/operations/customersgetstate.js";
+import { CustomersGetStateExternalRequest } from "../models/operations/customersgetstateexternal.js";
 import {
   CustomersListRequest,
   CustomersListResponse,
@@ -182,4 +187,54 @@ export class Customers extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * 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`
+   */
+  async getState(
+    request: CustomersGetStateRequest,
+    options?: RequestOptions,
+  ): Promise<CustomerState> {
+    return unwrapAsync(customersGetState(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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`
+   */
+  async getStateExternal(
+    request: CustomersGetStateExternalRequest,
+    options?: RequestOptions,
+  ): Promise<CustomerState> {
+    return unwrapAsync(customersGetStateExternal(
+      this,
+      request,
+      options,
+    ));
+  }
 }