@polar-sh/sdk 0.40.3 → 0.41.0

package/src/models/components/subscriptionproductupdatedevent.ts

@@ -48,6 +48,10 @@ export type SubscriptionProductUpdatedEvent = {
    * ID of the customer in your system associated with the event.
    */
   externalCustomerId: string | null;
+  /**
+   * Number of direct child events linked to this event.
+   */
+  childCount?: number | undefined;
   /**
    * The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.
    */
@@ -71,6 +75,7 @@ export const SubscriptionProductUpdatedEvent$inboundSchema: z.ZodType<
   customer_id: z.nullable(z.string()),
   customer: z.nullable(Customer$inboundSchema),
   external_customer_id: z.nullable(z.string()),
+  child_count: z.number().int().default(0),
   source: z.literal("system"),
   name: z.literal("subscription.product_updated"),
   metadata: SubscriptionProductUpdatedMetadata$inboundSchema,
@@ -79,6 +84,7 @@ export const SubscriptionProductUpdatedEvent$inboundSchema: z.ZodType<
     "organization_id": "organizationId",
     "customer_id": "customerId",
     "external_customer_id": "externalCustomerId",
+    "child_count": "childCount",
   });
 });
 
@@ -90,6 +96,7 @@ export type SubscriptionProductUpdatedEvent$Outbound = {
   customer_id: string | null;
   customer: Customer$Outbound | null;
   external_customer_id: string | null;
+  child_count: number;
   source: "system";
   name: "subscription.product_updated";
   metadata: SubscriptionProductUpdatedMetadata$Outbound;
@@ -107,6 +114,7 @@ export const SubscriptionProductUpdatedEvent$outboundSchema: z.ZodType<
   customerId: z.nullable(z.string()),
   customer: z.nullable(Customer$outboundSchema),
   externalCustomerId: z.nullable(z.string()),
+  childCount: z.number().int().default(0),
   source: z.literal("system"),
   name: z.literal("subscription.product_updated"),
   metadata: SubscriptionProductUpdatedMetadata$outboundSchema,
@@ -115,6 +123,7 @@ export const SubscriptionProductUpdatedEvent$outboundSchema: z.ZodType<
     organizationId: "organization_id",
     customerId: "customer_id",
     externalCustomerId: "external_customer_id",
+    childCount: "child_count",
   });
 });
 

package/src/models/components/subscriptionrevokedevent.ts

@@ -48,6 +48,10 @@ export type SubscriptionRevokedEvent = {
    * ID of the customer in your system associated with the event.
    */
   externalCustomerId: string | null;
+  /**
+   * Number of direct child events linked to this event.
+   */
+  childCount?: number | undefined;
   /**
    * The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.
    */
@@ -71,6 +75,7 @@ export const SubscriptionRevokedEvent$inboundSchema: z.ZodType<
   customer_id: z.nullable(z.string()),
   customer: z.nullable(Customer$inboundSchema),
   external_customer_id: z.nullable(z.string()),
+  child_count: z.number().int().default(0),
   source: z.literal("system"),
   name: z.literal("subscription.revoked"),
   metadata: SubscriptionRevokedMetadata$inboundSchema,
@@ -79,6 +84,7 @@ export const SubscriptionRevokedEvent$inboundSchema: z.ZodType<
     "organization_id": "organizationId",
     "customer_id": "customerId",
     "external_customer_id": "externalCustomerId",
+    "child_count": "childCount",
   });
 });
 
@@ -90,6 +96,7 @@ export type SubscriptionRevokedEvent$Outbound = {
   customer_id: string | null;
   customer: Customer$Outbound | null;
   external_customer_id: string | null;
+  child_count: number;
   source: "system";
   name: "subscription.revoked";
   metadata: SubscriptionRevokedMetadata$Outbound;
@@ -107,6 +114,7 @@ export const SubscriptionRevokedEvent$outboundSchema: z.ZodType<
   customerId: z.nullable(z.string()),
   customer: z.nullable(Customer$outboundSchema),
   externalCustomerId: z.nullable(z.string()),
+  childCount: z.number().int().default(0),
   source: z.literal("system"),
   name: z.literal("subscription.revoked"),
   metadata: SubscriptionRevokedMetadata$outboundSchema,
@@ -115,6 +123,7 @@ export const SubscriptionRevokedEvent$outboundSchema: z.ZodType<
     organizationId: "organization_id",
     customerId: "customer_id",
     externalCustomerId: "external_customer_id",
+    childCount: "child_count",
   });
 });
 

package/src/models/components/userevent.ts

@@ -48,6 +48,10 @@ export type UserEvent = {
    * ID of the customer in your system associated with the event.
    */
   externalCustomerId: string | null;
+  /**
+   * Number of direct child events linked to this event.
+   */
+  childCount?: number | undefined;
   /**
    * The name of the event.
    */
@@ -71,6 +75,7 @@ export const UserEvent$inboundSchema: z.ZodType<
   customer_id: z.nullable(z.string()),
   customer: z.nullable(Customer$inboundSchema),
   external_customer_id: z.nullable(z.string()),
+  child_count: z.number().int().default(0),
   name: z.string(),
   source: z.literal("user"),
   metadata: z.record(EventMetadataOutput$inboundSchema),
@@ -79,6 +84,7 @@ export const UserEvent$inboundSchema: z.ZodType<
     "organization_id": "organizationId",
     "customer_id": "customerId",
     "external_customer_id": "externalCustomerId",
+    "child_count": "childCount",
   });
 });
 
@@ -90,6 +96,7 @@ export type UserEvent$Outbound = {
   customer_id: string | null;
   customer: Customer$Outbound | null;
   external_customer_id: string | null;
+  child_count: number;
   name: string;
   source: "user";
   metadata: { [k: string]: EventMetadataOutput$Outbound };
@@ -107,6 +114,7 @@ export const UserEvent$outboundSchema: z.ZodType<
   customerId: z.nullable(z.string()),
   customer: z.nullable(Customer$outboundSchema),
   externalCustomerId: z.nullable(z.string()),
+  childCount: z.number().int().default(0),
   name: z.string(),
   source: z.literal("user"),
   metadata: z.record(EventMetadataOutput$outboundSchema),
@@ -115,6 +123,7 @@ export const UserEvent$outboundSchema: z.ZodType<
     organizationId: "organization_id",
     customerId: "customer_id",
     externalCustomerId: "external_customer_id",
+    childCount: "child_count",
   });
 });
 

package/src/models/operations/eventslist.ts

@@ -96,6 +96,10 @@ export type EventsListRequest = {
    * Query to filter events.
    */
   query?: string | null | undefined;
+  /**
+   * Filter events by parent event ID. When not specified, returns root events only.
+   */
+  parentId?: string | null | undefined;
   /**
    * Page number, defaults to 1.
    */
@@ -401,6 +405,7 @@ export const EventsListRequest$inboundSchema: z.ZodType<
     z.union([EventSource$inboundSchema, z.array(EventSource$inboundSchema)]),
   ).optional(),
   query: z.nullable(z.string()).optional(),
+  parent_id: z.nullable(z.string()).optional(),
   page: z.number().int().default(1),
   limit: z.number().int().default(10),
   sorting: z.nullable(z.array(EventSortProperty$inboundSchema)).optional(),
@@ -413,6 +418,7 @@ export const EventsListRequest$inboundSchema: z.ZodType<
     "customer_id": "customerId",
     "external_customer_id": "externalCustomerId",
     "meter_id": "meterId",
+    "parent_id": "parentId",
   });
 });
 
@@ -428,6 +434,7 @@ export type EventsListRequest$Outbound = {
   name?: string | Array<string> | null | undefined;
   source?: string | Array<string> | null | undefined;
   query?: string | null | undefined;
+  parent_id?: string | null | undefined;
   page: number;
   limit: number;
   sorting?: Array<string> | null | undefined;
@@ -455,6 +462,7 @@ export const EventsListRequest$outboundSchema: z.ZodType<
     z.union([EventSource$outboundSchema, z.array(EventSource$outboundSchema)]),
   ).optional(),
   query: z.nullable(z.string()).optional(),
+  parentId: z.nullable(z.string()).optional(),
   page: z.number().int().default(1),
   limit: z.number().int().default(10),
   sorting: z.nullable(z.array(EventSortProperty$outboundSchema)).optional(),
@@ -467,6 +475,7 @@ export const EventsListRequest$outboundSchema: z.ZodType<
     customerId: "customer_id",
     externalCustomerId: "external_customer_id",
     meterId: "meter_id",
+    parentId: "parent_id",
   });
 });
 

package/.devcontainer/README.md

@@ -1,35 +0,0 @@
-
-<div align="center">
-    <a href="https://codespaces.new/polarsource/polar-js.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
-</div>
-<br>
-
-> **Remember to shutdown a GitHub Codespace when it is not in use!**
-
-# Dev Containers Quick Start
-
-The default location for usage snippets is the `samples` directory.
-
-## Running a Usage Sample
-
-A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
-
-```
-ts-node root.ts
-```
-
-## Generating Additional Usage Samples
-
-The speakeasy CLI allows you to generate more usage snippets. Here's how:
-
-- To generate a sample for a specific operation by providing an operation ID, use:
-
-```
-speakeasy generate usage -s https://api.polar.sh/openapi.json -l typescript -i {INPUT_OPERATION_ID} -o ./samples
-```
-
-- To generate samples for an entire namespace (like a tag or group name), use:
-
-```
-speakeasy generate usage -s https://api.polar.sh/openapi.json -l typescript -n {INPUT_TAG_NAME} -o ./samples
-```

package/docs/sdks/benefitgrants/README.md

@@ -1,88 +0,0 @@
-# BenefitGrants
-(*benefitGrants*)
-
-## Overview
-
-### Available Operations
-
-* [list](#list) - List Benefit Grants
-
-## list
-
-List benefit grants across all benefits for the authenticated organization.
-
-**Scopes**: `benefits:read` `benefits:write`
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="benefit-grants:list" method="get" path="/v1/benefit-grants/" -->
-```typescript
-import { Polar } from "@polar-sh/sdk";
-
-const polar = new Polar({
-  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const result = await polar.benefitGrants.list({
-    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
-  });
-
-  for await (const page of result) {
-    console.log(page);
-  }
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { PolarCore } from "@polar-sh/sdk/core.js";
-import { benefitGrantsList } from "@polar-sh/sdk/funcs/benefitGrantsList.js";
-
-// Use `PolarCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const polar = new PolarCore({
-  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
-});
-
-async function run() {
-  const res = await benefitGrantsList(polar, {
-    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    for await (const page of result) {
-    console.log(page);
-  }
-  } else {
-    console.log("benefitGrantsList failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.BenefitGrantsListRequest](../../models/operations/benefitgrantslistrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.BenefitGrantsListResponse](../../models/operations/benefitgrantslistresponse.md)\>**
-
-### Errors
-
-| Error Type                 | Status Code                | Content Type               |
-| -------------------------- | -------------------------- | -------------------------- |
-| errors.HTTPValidationError | 422                        | application/json           |
-| errors.SDKError            | 4XX, 5XX                   | \*/\*                      |