@polar-sh/sdk 0.26.1 → 0.27.0

package/src/models/operations/customerportalsubscriptionsupdate.ts

@@ -14,6 +14,10 @@ import {
 } from "../components/customersubscriptionupdate.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+export type CustomerPortalSubscriptionsUpdateSecurity = {
+  customerSession: string;
+};
+
 export type CustomerPortalSubscriptionsUpdateRequest = {
   /**
    * The subscription ID.
@@ -22,6 +26,80 @@ export type CustomerPortalSubscriptionsUpdateRequest = {
   customerSubscriptionUpdate: CustomerSubscriptionUpdate;
 };
 
+/** @internal */
+export const CustomerPortalSubscriptionsUpdateSecurity$inboundSchema: z.ZodType<
+  CustomerPortalSubscriptionsUpdateSecurity,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  customer_session: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "customer_session": "customerSession",
+  });
+});
+
+/** @internal */
+export type CustomerPortalSubscriptionsUpdateSecurity$Outbound = {
+  customer_session: string;
+};
+
+/** @internal */
+export const CustomerPortalSubscriptionsUpdateSecurity$outboundSchema:
+  z.ZodType<
+    CustomerPortalSubscriptionsUpdateSecurity$Outbound,
+    z.ZodTypeDef,
+    CustomerPortalSubscriptionsUpdateSecurity
+  > = z.object({
+    customerSession: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      customerSession: "customer_session",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CustomerPortalSubscriptionsUpdateSecurity$ {
+  /** @deprecated use `CustomerPortalSubscriptionsUpdateSecurity$inboundSchema` instead. */
+  export const inboundSchema =
+    CustomerPortalSubscriptionsUpdateSecurity$inboundSchema;
+  /** @deprecated use `CustomerPortalSubscriptionsUpdateSecurity$outboundSchema` instead. */
+  export const outboundSchema =
+    CustomerPortalSubscriptionsUpdateSecurity$outboundSchema;
+  /** @deprecated use `CustomerPortalSubscriptionsUpdateSecurity$Outbound` instead. */
+  export type Outbound = CustomerPortalSubscriptionsUpdateSecurity$Outbound;
+}
+
+export function customerPortalSubscriptionsUpdateSecurityToJSON(
+  customerPortalSubscriptionsUpdateSecurity:
+    CustomerPortalSubscriptionsUpdateSecurity,
+): string {
+  return JSON.stringify(
+    CustomerPortalSubscriptionsUpdateSecurity$outboundSchema.parse(
+      customerPortalSubscriptionsUpdateSecurity,
+    ),
+  );
+}
+
+export function customerPortalSubscriptionsUpdateSecurityFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CustomerPortalSubscriptionsUpdateSecurity,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CustomerPortalSubscriptionsUpdateSecurity$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CustomerPortalSubscriptionsUpdateSecurity' from JSON`,
+  );
+}
+
 /** @internal */
 export const CustomerPortalSubscriptionsUpdateRequest$inboundSchema: z.ZodType<
   CustomerPortalSubscriptionsUpdateRequest,

package/src/sdk/benefitgrants.ts

@@ -7,12 +7,19 @@ import { customerPortalBenefitGrantsList } from "../funcs/customerPortalBenefitG
 import { customerPortalBenefitGrantsUpdate } from "../funcs/customerPortalBenefitGrantsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import { CustomerBenefitGrant } from "../models/components/customerbenefitgrant.js";
-import { CustomerPortalBenefitGrantsGetRequest } from "../models/operations/customerportalbenefitgrantsget.js";
+import {
+  CustomerPortalBenefitGrantsGetRequest,
+  CustomerPortalBenefitGrantsGetSecurity,
+} from "../models/operations/customerportalbenefitgrantsget.js";
 import {
   CustomerPortalBenefitGrantsListRequest,
   CustomerPortalBenefitGrantsListResponse,
+  CustomerPortalBenefitGrantsListSecurity,
 } from "../models/operations/customerportalbenefitgrantslist.js";
-import { CustomerPortalBenefitGrantsUpdateRequest } from "../models/operations/customerportalbenefitgrantsupdate.js";
+import {
+  CustomerPortalBenefitGrantsUpdateRequest,
+  CustomerPortalBenefitGrantsUpdateSecurity,
+} from "../models/operations/customerportalbenefitgrantsupdate.js";
 import { unwrapAsync } from "../types/fp.js";
 import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
@@ -21,9 +28,12 @@ export class BenefitGrants extends ClientSDK {
    * List Benefit Grants
    *
    * @remarks
-   * List benefits grants of the authenticated customer or user.
+   * List benefits grants of the authenticated customer.
+   *
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
    */
   async list(
+    security: CustomerPortalBenefitGrantsListSecurity,
     request: CustomerPortalBenefitGrantsListRequest,
     options?: RequestOptions,
   ): Promise<
@@ -31,6 +41,7 @@ export class BenefitGrants extends ClientSDK {
   > {
     return unwrapResultIterator(customerPortalBenefitGrantsList(
       this,
+      security,
       request,
       options,
     ));
@@ -40,14 +51,18 @@ export class BenefitGrants extends ClientSDK {
    * Get Benefit Grant
    *
    * @remarks
-   * Get a benefit grant by ID for the authenticated customer or user.
+   * Get a benefit grant by ID for the authenticated customer.
+   *
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
    */
   async get(
+    security: CustomerPortalBenefitGrantsGetSecurity,
     request: CustomerPortalBenefitGrantsGetRequest,
     options?: RequestOptions,
   ): Promise<CustomerBenefitGrant> {
     return unwrapAsync(customerPortalBenefitGrantsGet(
       this,
+      security,
       request,
       options,
     ));
@@ -57,14 +72,18 @@ export class BenefitGrants extends ClientSDK {
    * Update Benefit Grant
    *
    * @remarks
-   * Update a benefit grant for the authenticated customer or user.
+   * Update a benefit grant for the authenticated customer.
+   *
+   * **Scopes**: `customer_portal:write`
    */
   async update(
+    security: CustomerPortalBenefitGrantsUpdateSecurity,
     request: CustomerPortalBenefitGrantsUpdateRequest,
     options?: RequestOptions,
   ): Promise<CustomerBenefitGrant> {
     return unwrapAsync(customerPortalBenefitGrantsUpdate(
       this,
+      security,
       request,
       options,
     ));

package/src/sdk/benefits.ts

@@ -31,6 +31,8 @@ export class Benefits extends ClientSDK {
    *
    * @remarks
    * List benefits.
+   *
+   * **Scopes**: `benefits:read` `benefits:write`
    */
   async list(
     request: BenefitsListRequest,
@@ -48,6 +50,8 @@ export class Benefits extends ClientSDK {
    *
    * @remarks
    * Create a benefit.
+   *
+   * **Scopes**: `benefits:write`
    */
   async create(
     request: BenefitCreate,
@@ -65,6 +69,8 @@ export class Benefits extends ClientSDK {
    *
    * @remarks
    * Get a benefit by ID.
+   *
+   * **Scopes**: `benefits:read` `benefits:write`
    */
   async get(
     request: BenefitsGetRequest,
@@ -82,6 +88,8 @@ export class Benefits extends ClientSDK {
    *
    * @remarks
    * Update a benefit.
+   *
+   * **Scopes**: `benefits:write`
    */
   async update(
     request: BenefitsUpdateRequest,
@@ -103,6 +111,8 @@ export class Benefits extends ClientSDK {
    * > [!WARNING]
    * > Every grants associated with the benefit will be revoked.
    * > Users will lose access to the benefit.
+   *
+   * **Scopes**: `benefits:write`
    */
   async delete(
     request: BenefitsDeleteRequest,
@@ -122,6 +132,8 @@ export class Benefits extends ClientSDK {
    * List the individual grants for a benefit.
    *
    * It's especially useful to check if a user has been granted a benefit.
+   *
+   * **Scopes**: `benefits:read` `benefits:write`
    */
   async grants(
     request: BenefitsGrantsRequest,

package/src/sdk/checkoutlinks.ts

@@ -26,6 +26,8 @@ export class CheckoutLinks extends ClientSDK {
    *
    * @remarks
    * List checkout links.
+   *
+   * **Scopes**: `checkout_links:read` `checkout_links:write`
    */
   async list(
     request: CheckoutLinksListRequest,
@@ -43,6 +45,8 @@ export class CheckoutLinks extends ClientSDK {
    *
    * @remarks
    * Create a checkout link.
+   *
+   * **Scopes**: `checkout_links:write`
    */
   async create(
     request: CheckoutLinksCreateCheckoutLinkCreate,
@@ -60,6 +64,8 @@ export class CheckoutLinks extends ClientSDK {
    *
    * @remarks
    * Get a checkout link by ID.
+   *
+   * **Scopes**: `checkout_links:read` `checkout_links:write`
    */
   async get(
     request: CheckoutLinksGetRequest,
@@ -77,6 +83,8 @@ export class CheckoutLinks extends ClientSDK {
    *
    * @remarks
    * Update a checkout link.
+   *
+   * **Scopes**: `checkout_links:write`
    */
   async update(
     request: CheckoutLinksUpdateRequest,
@@ -94,6 +102,8 @@ export class CheckoutLinks extends ClientSDK {
    *
    * @remarks
    * Delete a checkout link.
+   *
+   * **Scopes**: `checkout_links:write`
    */
   async delete(
     request: CheckoutLinksDeleteRequest,

package/src/sdk/checkouts.ts

@@ -32,6 +32,8 @@ export class Checkouts extends ClientSDK {
    *
    * @remarks
    * List checkout sessions.
+   *
+   * **Scopes**: `checkouts:read` `checkouts:write`
    */
   async list(
     request: CheckoutsListRequest,
@@ -49,6 +51,8 @@ export class Checkouts extends ClientSDK {
    *
    * @remarks
    * Create a checkout session.
+   *
+   * **Scopes**: `checkouts:write`
    */
   async create(
     request: CheckoutCreate,
@@ -66,6 +70,8 @@ export class Checkouts extends ClientSDK {
    *
    * @remarks
    * Get a checkout session by ID.
+   *
+   * **Scopes**: `checkouts:read` `checkouts:write`
    */
   async get(
     request: CheckoutsGetRequest,
@@ -83,6 +89,8 @@ export class Checkouts extends ClientSDK {
    *
    * @remarks
    * Update a checkout session.
+   *
+   * **Scopes**: `checkouts:write`
    */
   async update(
     request: CheckoutsUpdateRequest,
@@ -136,6 +144,8 @@ export class Checkouts extends ClientSDK {
    * Confirm a checkout session by client secret.
    *
    * Orders and subscriptions will be processed.
+   *
+   * **Scopes**:
    */
   async clientConfirm(
     request: CheckoutsClientConfirmRequest,

package/src/sdk/clients.ts

@@ -25,6 +25,8 @@ export class Clients extends ClientSDK {
    *
    * @remarks
    * List OAuth2 clients.
+   *
+   * **Scopes**:
    */
   async list(
     request: Oauth2ClientsListRequest,
@@ -42,6 +44,8 @@ export class Clients extends ClientSDK {
    *
    * @remarks
    * Create an OAuth2 client.
+   *
+   * **Scopes**:
    */
   async create(
     request: OAuth2ClientConfiguration,
@@ -59,6 +63,8 @@ export class Clients extends ClientSDK {
    *
    * @remarks
    * Get an OAuth2 client by Client ID.
+   *
+   * **Scopes**:
    */
   async get(
     request: Oauth2ClientsOauth2GetClientRequest,
@@ -76,6 +82,8 @@ export class Clients extends ClientSDK {
    *
    * @remarks
    * Update an OAuth2 client.
+   *
+   * **Scopes**:
    */
   async update(
     request: Oauth2ClientsOauth2UpdateClientRequest,
@@ -93,6 +101,8 @@ export class Clients extends ClientSDK {
    *
    * @remarks
    * Delete an OAuth2 client.
+   *
+   * **Scopes**:
    */
   async delete(
     request: Oauth2ClientsOauth2DeleteClientRequest,

package/src/sdk/customers.ts

@@ -26,6 +26,8 @@ export class Customers extends ClientSDK {
    *
    * @remarks
    * List customers.
+   *
+   * **Scopes**: `customers:read` `customers:write`
    */
   async list(
     request: CustomersListRequest,
@@ -43,6 +45,8 @@ export class Customers extends ClientSDK {
    *
    * @remarks
    * Create a customer.
+   *
+   * **Scopes**: `customers:write`
    */
   async create(
     request: CustomerCreate,
@@ -60,6 +64,8 @@ export class Customers extends ClientSDK {
    *
    * @remarks
    * Get a customer by ID.
+   *
+   * **Scopes**: `customers:read` `customers:write`
    */
   async get(
     request: CustomersGetRequest,
@@ -77,6 +83,8 @@ export class Customers extends ClientSDK {
    *
    * @remarks
    * Update a customer.
+   *
+   * **Scopes**: `customers:write`
    */
   async update(
     request: CustomersUpdateRequest,
@@ -96,6 +104,8 @@ export class Customers extends ClientSDK {
    * Delete a customer.
    *
    * Immediately cancels any active subscriptions and revokes any active benefits.
+   *
+   * **Scopes**: `customers:write`
    */
   async delete(
     request: CustomersDeleteRequest,

package/src/sdk/customersessions.ts

@@ -14,6 +14,8 @@ export class CustomerSessions extends ClientSDK {
    *
    * @remarks
    * Create a customer session.
+   *
+   * **Scopes**: `customer_sessions:write`
    */
   async create(
     request: CustomerSessionCreate,

package/src/sdk/customfields.ts

@@ -26,6 +26,8 @@ export class CustomFields extends ClientSDK {
    *
    * @remarks
    * List custom fields.
+   *
+   * **Scopes**: `custom_fields:read` `custom_fields:write`
    */
   async list(
     request: CustomFieldsListRequest,
@@ -43,6 +45,8 @@ export class CustomFields extends ClientSDK {
    *
    * @remarks
    * Create a custom field.
+   *
+   * **Scopes**: `custom_fields:write`
    */
   async create(
     request: CustomFieldCreate,
@@ -60,6 +64,8 @@ export class CustomFields extends ClientSDK {
    *
    * @remarks
    * Get a custom field by ID.
+   *
+   * **Scopes**: `custom_fields:read` `custom_fields:write`
    */
   async get(
     request: CustomFieldsGetRequest,
@@ -77,6 +83,8 @@ export class CustomFields extends ClientSDK {
    *
    * @remarks
    * Update a custom field.
+   *
+   * **Scopes**: `custom_fields:write`
    */
   async update(
     request: CustomFieldsUpdateRequest,
@@ -94,6 +102,8 @@ export class CustomFields extends ClientSDK {
    *
    * @remarks
    * Delete a custom field.
+   *
+   * **Scopes**: `custom_fields:write`
    */
   async delete(
     request: CustomFieldsDeleteRequest,

package/src/sdk/discounts.ts

@@ -26,6 +26,8 @@ export class Discounts extends ClientSDK {
    *
    * @remarks
    * List discounts.
+   *
+   * **Scopes**: `discounts:read` `discounts:write`
    */
   async list(
     request: DiscountsListRequest,
@@ -43,6 +45,8 @@ export class Discounts extends ClientSDK {
    *
    * @remarks
    * Create a discount.
+   *
+   * **Scopes**: `discounts:write`
    */
   async create(
     request: DiscountCreate,
@@ -60,6 +64,8 @@ export class Discounts extends ClientSDK {
    *
    * @remarks
    * Get a discount by ID.
+   *
+   * **Scopes**: `discounts:read` `discounts:write`
    */
   async get(
     request: DiscountsGetRequest,
@@ -77,6 +83,8 @@ export class Discounts extends ClientSDK {
    *
    * @remarks
    * Update a discount.
+   *
+   * **Scopes**: `discounts:write`
    */
   async update(
     request: DiscountsUpdateRequest,
@@ -94,6 +102,8 @@ export class Discounts extends ClientSDK {
    *
    * @remarks
    * Delete a discount.
+   *
+   * **Scopes**: `discounts:write`
    */
   async delete(
     request: DiscountsDeleteRequest,

package/src/sdk/downloadables.ts

@@ -9,6 +9,7 @@ import { CustomerPortalDownloadablesCustomerPortalDownloadablesGetRequest } from
 import {
   CustomerPortalDownloadablesListRequest,
   CustomerPortalDownloadablesListResponse,
+  CustomerPortalDownloadablesListSecurity,
 } from "../models/operations/customerportaldownloadableslist.js";
 import { unwrapAsync } from "../types/fp.js";
 import { PageIterator, unwrapResultIterator } from "../types/operations.js";
@@ -16,8 +17,12 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 export class Downloadables extends ClientSDK {
   /**
    * List Downloadables
+   *
+   * @remarks
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
    */
   async list(
+    security: CustomerPortalDownloadablesListSecurity,
     request: CustomerPortalDownloadablesListRequest,
     options?: RequestOptions,
   ): Promise<
@@ -25,6 +30,7 @@ export class Downloadables extends ClientSDK {
   > {
     return unwrapResultIterator(customerPortalDownloadablesList(
       this,
+      security,
       request,
       options,
     ));

package/src/sdk/events.ts

@@ -23,6 +23,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * List events.
+   *
+   * **Scopes**: `events:read` `events:write`
    */
   async list(
     request: EventsListRequest,
@@ -40,6 +42,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Get an event by ID.
+   *
+   * **Scopes**: `events:read` `events:write`
    */
   async get(
     request: EventsGetRequest,
@@ -57,6 +61,8 @@ export class Events extends ClientSDK {
    *
    * @remarks
    * Ingest batch of events.
+   *
+   * **Scopes**: `events:write`
    */
   async ingest(
     request: EventsIngest,

package/src/sdk/externalorganizations.ts

@@ -16,6 +16,8 @@ export class ExternalOrganizations extends ClientSDK {
    *
    * @remarks
    * List external organizations.
+   *
+   * **Scopes**: `external_organizations:read`
    */
   async list(
     request: ExternalOrganizationsListRequest,

package/src/sdk/files.ts

@@ -32,6 +32,8 @@ export class Files extends ClientSDK {
    *
    * @remarks
    * List files.
+   *
+   * **Scopes**: `files:write`
    */
   async list(
     request: FilesListRequest,
@@ -49,6 +51,8 @@ export class Files extends ClientSDK {
    *
    * @remarks
    * Create a file.
+   *
+   * **Scopes**: `files:write`
    */
   async create(
     request: FileCreate,
@@ -66,6 +70,8 @@ export class Files extends ClientSDK {
    *
    * @remarks
    * Complete a file upload.
+   *
+   * **Scopes**: `files:write`
    */
   async uploaded(
     request: FilesUploadedRequest,
@@ -83,6 +89,8 @@ export class Files extends ClientSDK {
    *
    * @remarks
    * Update a file.
+   *
+   * **Scopes**: `files:write`
    */
   async update(
     request: FilesUpdateRequest,
@@ -100,6 +108,8 @@ export class Files extends ClientSDK {
    *
    * @remarks
    * Delete a file.
+   *
+   * **Scopes**: `files:write`
    */
   async delete(
     request: FilesDeleteRequest,

package/src/sdk/licensekeys.ts

@@ -26,6 +26,8 @@ export class LicenseKeys extends ClientSDK {
    *
    * @remarks
    * Get license keys connected to the given organization & filters.
+   *
+   * **Scopes**: `license_keys:read` `license_keys:write`
    */
   async list(
     request: LicenseKeysListRequest,
@@ -43,6 +45,8 @@ export class LicenseKeys extends ClientSDK {
    *
    * @remarks
    * Get a license key.
+   *
+   * **Scopes**: `license_keys:read` `license_keys:write`
    */
   async get(
     request: LicenseKeysGetRequest,
@@ -60,6 +64,8 @@ export class LicenseKeys extends ClientSDK {
    *
    * @remarks
    * Update a license key.
+   *
+   * **Scopes**: `license_keys:write`
    */
   async update(
     request: LicenseKeysUpdateRequest,
@@ -77,6 +83,8 @@ export class LicenseKeys extends ClientSDK {
    *
    * @remarks
    * Get a license key activation.
+   *
+   * **Scopes**: `license_keys:read` `license_keys:write`
    */
   async getActivation(
     request: LicenseKeysGetActivationRequest,

package/src/sdk/meters.ts

@@ -32,6 +32,8 @@ export class Meters extends ClientSDK {
    *
    * @remarks
    * List meters.
+   *
+   * **Scopes**: `meters:read` `meters:write`
    */
   async list(
     request: MetersListRequest,
@@ -49,6 +51,8 @@ export class Meters extends ClientSDK {
    *
    * @remarks
    * Create a meter.
+   *
+   * **Scopes**: `meters:write`
    */
   async create(
     request: MeterCreate,
@@ -66,6 +70,8 @@ export class Meters extends ClientSDK {
    *
    * @remarks
    * Get a meter by ID.
+   *
+   * **Scopes**: `meters:read` `meters:write`
    */
   async get(
     request: MetersGetRequest,
@@ -83,6 +89,8 @@ export class Meters extends ClientSDK {
    *
    * @remarks
    * Update a meter.
+   *
+   * **Scopes**: `meters:write`
    */
   async update(
     request: MetersUpdateRequest,
@@ -100,6 +108,8 @@ export class Meters extends ClientSDK {
    *
    * @remarks
    * Get events matching the filter of a meter.
+   *
+   * **Scopes**: `meters:read` `meters:write`
    */
   async events(
     request: MetersEventsRequest,
@@ -117,6 +127,8 @@ export class Meters extends ClientSDK {
    *
    * @remarks
    * Get quantities of a meter over a time period.
+   *
+   * **Scopes**: `meters:read` `meters:write`
    */
   async quantities(
     request: MetersQuantitiesRequest,