@polar-sh/sdk 0.26.0 → 0.27.0

package/src/sdk/metrics.ts

@@ -16,6 +16,8 @@ export class Metrics extends ClientSDK {
    *
    * @remarks
    * Get metrics about your orders and subscriptions.
+   *
+   * **Scopes**: `metrics:read`
    */
   async get(
     request: MetricsGetRequest,
@@ -33,6 +35,8 @@ export class Metrics extends ClientSDK {
    *
    * @remarks
    * Get the interval limits for the metrics endpoint.
+   *
+   * **Scopes**: `metrics:read`
    */
   async limits(
     options?: RequestOptions,

package/src/sdk/oauth2.ts

@@ -27,6 +27,9 @@ export class Oauth2 extends ClientSDK {
 
   /**
    * Authorize
+   *
+   * @remarks
+   * **Scopes**:
    */
   async authorize(
     options?: RequestOptions,

package/src/sdk/orders.ts

@@ -23,6 +23,8 @@ export class Orders extends ClientSDK {
    *
    * @remarks
    * List orders.
+   *
+   * **Scopes**: `orders:read`
    */
   async list(
     request: OrdersListRequest,
@@ -40,6 +42,8 @@ export class Orders extends ClientSDK {
    *
    * @remarks
    * Get an order by ID.
+   *
+   * **Scopes**: `orders:read`
    */
   async get(
     request: OrdersGetRequest,
@@ -57,6 +61,8 @@ export class Orders extends ClientSDK {
    *
    * @remarks
    * Get an order's invoice data.
+   *
+   * **Scopes**: `orders:read`
    */
   async invoice(
     request: OrdersInvoiceRequest,

package/src/sdk/organizations.ts

@@ -24,6 +24,8 @@ export class Organizations extends ClientSDK {
    *
    * @remarks
    * List organizations.
+   *
+   * **Scopes**: `organizations:read` `organizations:write`
    */
   async list(
     request: OrganizationsListRequest,
@@ -41,6 +43,8 @@ export class Organizations extends ClientSDK {
    *
    * @remarks
    * Create an organization.
+   *
+   * **Scopes**: `organizations:write`
    */
   async create(
     request: OrganizationCreate,
@@ -58,6 +62,8 @@ export class Organizations extends ClientSDK {
    *
    * @remarks
    * Get an organization by ID.
+   *
+   * **Scopes**: `organizations:read` `organizations:write`
    */
   async get(
     request: OrganizationsGetRequest,
@@ -75,6 +81,8 @@ export class Organizations extends ClientSDK {
    *
    * @remarks
    * Update an organization.
+   *
+   * **Scopes**: `organizations:write`
    */
   async update(
     request: OrganizationsUpdateRequest,

package/src/sdk/polarcustomers.ts

@@ -2,25 +2,139 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { customerPortalCustomersAddPaymentMethod } from "../funcs/customerPortalCustomersAddPaymentMethod.js";
+import { customerPortalCustomersDeletePaymentMethod } from "../funcs/customerPortalCustomersDeletePaymentMethod.js";
 import { customerPortalCustomersGet } from "../funcs/customerPortalCustomersGet.js";
+import { customerPortalCustomersGetPaymentMethods } from "../funcs/customerPortalCustomersGetPaymentMethods.js";
+import { customerPortalCustomersUpdate } from "../funcs/customerPortalCustomersUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import { CustomerPaymentMethodCreate } from "../models/components/customerpaymentmethodcreate.js";
 import { CustomerPortalCustomer } from "../models/components/customerportalcustomer.js";
-import { CustomerPortalCustomersGetRequest } from "../models/operations/customerportalcustomersget.js";
+import { CustomerPortalCustomerUpdate } from "../models/components/customerportalcustomerupdate.js";
+import {
+  CustomerPortalCustomersAddPaymentMethodResponseCustomerPortalCustomersAddPaymentMethod,
+  CustomerPortalCustomersAddPaymentMethodSecurity,
+} from "../models/operations/customerportalcustomersaddpaymentmethod.js";
+import {
+  CustomerPortalCustomersDeletePaymentMethodRequest,
+  CustomerPortalCustomersDeletePaymentMethodSecurity,
+} from "../models/operations/customerportalcustomersdeletepaymentmethod.js";
+import { CustomerPortalCustomersGetSecurity } from "../models/operations/customerportalcustomersget.js";
+import {
+  CustomerPortalCustomersGetPaymentMethodsRequest,
+  CustomerPortalCustomersGetPaymentMethodsResponse,
+  CustomerPortalCustomersGetPaymentMethodsSecurity,
+} from "../models/operations/customerportalcustomersgetpaymentmethods.js";
+import { CustomerPortalCustomersUpdateSecurity } from "../models/operations/customerportalcustomersupdate.js";
 import { unwrapAsync } from "../types/fp.js";
+import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
 export class PolarCustomers extends ClientSDK {
   /**
    * Get Customer
    *
    * @remarks
-   * Get a customer by ID for the authenticated customer or user.
+   * Get authenticated customer.
+   *
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
    */
   async get(
-    request: CustomerPortalCustomersGetRequest,
+    security: CustomerPortalCustomersGetSecurity,
     options?: RequestOptions,
   ): Promise<CustomerPortalCustomer> {
     return unwrapAsync(customerPortalCustomersGet(
       this,
+      security,
+      options,
+    ));
+  }
+
+  /**
+   * Update Customer
+   *
+   * @remarks
+   * Update authenticated customer.
+   *
+   * **Scopes**: `customer_portal:write`
+   */
+  async update(
+    security: CustomerPortalCustomersUpdateSecurity,
+    request: CustomerPortalCustomerUpdate,
+    options?: RequestOptions,
+  ): Promise<CustomerPortalCustomer> {
+    return unwrapAsync(customerPortalCustomersUpdate(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Customer Payment Methods
+   *
+   * @remarks
+   * Get saved payment methods of the authenticated customer.
+   *
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
+   */
+  async getPaymentMethods(
+    security: CustomerPortalCustomersGetPaymentMethodsSecurity,
+    request: CustomerPortalCustomersGetPaymentMethodsRequest,
+    options?: RequestOptions,
+  ): Promise<
+    PageIterator<
+      CustomerPortalCustomersGetPaymentMethodsResponse,
+      { page: number }
+    >
+  > {
+    return unwrapResultIterator(customerPortalCustomersGetPaymentMethods(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Add Customer Payment Method
+   *
+   * @remarks
+   * Add a payment method to the authenticated customer.
+   *
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
+   */
+  async addPaymentMethod(
+    security: CustomerPortalCustomersAddPaymentMethodSecurity,
+    request: CustomerPaymentMethodCreate,
+    options?: RequestOptions,
+  ): Promise<
+    CustomerPortalCustomersAddPaymentMethodResponseCustomerPortalCustomersAddPaymentMethod
+  > {
+    return unwrapAsync(customerPortalCustomersAddPaymentMethod(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete Customer Payment Method
+   *
+   * @remarks
+   * Delete a payment method from the authenticated customer.
+   *
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
+   */
+  async deletePaymentMethod(
+    security: CustomerPortalCustomersDeletePaymentMethodSecurity,
+    request: CustomerPortalCustomersDeletePaymentMethodRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(customerPortalCustomersDeletePaymentMethod(
+      this,
+      security,
       request,
       options,
     ));

package/src/sdk/polarlicensekeys.ts

@@ -14,10 +14,14 @@ import { LicenseKeyDeactivate } from "../models/components/licensekeydeactivate.
 import { LicenseKeyValidate } from "../models/components/licensekeyvalidate.js";
 import { LicenseKeyWithActivations } from "../models/components/licensekeywithactivations.js";
 import { ValidatedLicenseKey } from "../models/components/validatedlicensekey.js";
-import { CustomerPortalLicenseKeysGetRequest } from "../models/operations/customerportallicensekeysget.js";
+import {
+  CustomerPortalLicenseKeysGetRequest,
+  CustomerPortalLicenseKeysGetSecurity,
+} from "../models/operations/customerportallicensekeysget.js";
 import {
   CustomerPortalLicenseKeysListRequest,
   CustomerPortalLicenseKeysListResponse,
+  CustomerPortalLicenseKeysListSecurity,
 } from "../models/operations/customerportallicensekeyslist.js";
 import { unwrapAsync } from "../types/fp.js";
 import { PageIterator, unwrapResultIterator } from "../types/operations.js";
@@ -25,8 +29,12 @@ import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 export class PolarLicenseKeys extends ClientSDK {
   /**
    * List License Keys
+   *
+   * @remarks
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
    */
   async list(
+    security: CustomerPortalLicenseKeysListSecurity,
     request: CustomerPortalLicenseKeysListRequest,
     options?: RequestOptions,
   ): Promise<
@@ -34,6 +42,7 @@ export class PolarLicenseKeys extends ClientSDK {
   > {
     return unwrapResultIterator(customerPortalLicenseKeysList(
       this,
+      security,
       request,
       options,
     ));
@@ -44,13 +53,17 @@ export class PolarLicenseKeys extends ClientSDK {
    *
    * @remarks
    * Get a license key.
+   *
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
    */
   async get(
+    security: CustomerPortalLicenseKeysGetSecurity,
     request: CustomerPortalLicenseKeysGetRequest,
     options?: RequestOptions,
   ): Promise<LicenseKeyWithActivations> {
     return unwrapAsync(customerPortalLicenseKeysGet(
       this,
+      security,
       request,
       options,
     ));

package/src/sdk/polarorders.ts

@@ -8,11 +8,18 @@ import { customerPortalOrdersList } from "../funcs/customerPortalOrdersList.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import { CustomerOrder } from "../models/components/customerorder.js";
 import { CustomerOrderInvoice } from "../models/components/customerorderinvoice.js";
-import { CustomerPortalOrdersGetRequest } from "../models/operations/customerportalordersget.js";
-import { CustomerPortalOrdersInvoiceRequest } from "../models/operations/customerportalordersinvoice.js";
+import {
+  CustomerPortalOrdersGetRequest,
+  CustomerPortalOrdersGetSecurity,
+} from "../models/operations/customerportalordersget.js";
+import {
+  CustomerPortalOrdersInvoiceRequest,
+  CustomerPortalOrdersInvoiceSecurity,
+} from "../models/operations/customerportalordersinvoice.js";
 import {
   CustomerPortalOrdersListRequest,
   CustomerPortalOrdersListResponse,
+  CustomerPortalOrdersListSecurity,
 } from "../models/operations/customerportalorderslist.js";
 import { unwrapAsync } from "../types/fp.js";
 import { PageIterator, unwrapResultIterator } from "../types/operations.js";
@@ -22,14 +29,18 @@ export class PolarOrders extends ClientSDK {
    * List Orders
    *
    * @remarks
-   * List orders of the authenticated customer or user.
+   * List orders of the authenticated customer.
+   *
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
    */
   async list(
+    security: CustomerPortalOrdersListSecurity,
     request: CustomerPortalOrdersListRequest,
     options?: RequestOptions,
   ): Promise<PageIterator<CustomerPortalOrdersListResponse, { page: number }>> {
     return unwrapResultIterator(customerPortalOrdersList(
       this,
+      security,
       request,
       options,
     ));
@@ -39,14 +50,18 @@ export class PolarOrders extends ClientSDK {
    * Get Order
    *
    * @remarks
-   * Get an order by ID for the authenticated customer or user.
+   * Get an order by ID for the authenticated customer.
+   *
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
    */
   async get(
+    security: CustomerPortalOrdersGetSecurity,
     request: CustomerPortalOrdersGetRequest,
     options?: RequestOptions,
   ): Promise<CustomerOrder> {
     return unwrapAsync(customerPortalOrdersGet(
       this,
+      security,
       request,
       options,
     ));
@@ -57,13 +72,17 @@ export class PolarOrders extends ClientSDK {
    *
    * @remarks
    * Get an order's invoice data.
+   *
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
    */
   async invoice(
+    security: CustomerPortalOrdersInvoiceSecurity,
     request: CustomerPortalOrdersInvoiceRequest,
     options?: RequestOptions,
   ): Promise<CustomerOrderInvoice> {
     return unwrapAsync(customerPortalOrdersInvoice(
       this,
+      security,
       request,
       options,
     ));

package/src/sdk/polarsubscriptions.ts

@@ -8,13 +8,23 @@ import { customerPortalSubscriptionsList } from "../funcs/customerPortalSubscrip
 import { customerPortalSubscriptionsUpdate } from "../funcs/customerPortalSubscriptionsUpdate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import { CustomerSubscription } from "../models/components/customersubscription.js";
-import { CustomerPortalSubscriptionsCancelRequest } from "../models/operations/customerportalsubscriptionscancel.js";
-import { CustomerPortalSubscriptionsGetRequest } from "../models/operations/customerportalsubscriptionsget.js";
+import {
+  CustomerPortalSubscriptionsCancelRequest,
+  CustomerPortalSubscriptionsCancelSecurity,
+} from "../models/operations/customerportalsubscriptionscancel.js";
+import {
+  CustomerPortalSubscriptionsGetRequest,
+  CustomerPortalSubscriptionsGetSecurity,
+} from "../models/operations/customerportalsubscriptionsget.js";
 import {
   CustomerPortalSubscriptionsListRequest,
   CustomerPortalSubscriptionsListResponse,
+  CustomerPortalSubscriptionsListSecurity,
 } from "../models/operations/customerportalsubscriptionslist.js";
-import { CustomerPortalSubscriptionsUpdateRequest } from "../models/operations/customerportalsubscriptionsupdate.js";
+import {
+  CustomerPortalSubscriptionsUpdateRequest,
+  CustomerPortalSubscriptionsUpdateSecurity,
+} from "../models/operations/customerportalsubscriptionsupdate.js";
 import { unwrapAsync } from "../types/fp.js";
 import { PageIterator, unwrapResultIterator } from "../types/operations.js";
 
@@ -23,9 +33,12 @@ export class PolarSubscriptions extends ClientSDK {
    * List Subscriptions
    *
    * @remarks
-   * List subscriptions of the authenticated customer or user.
+   * List subscriptions of the authenticated customer.
+   *
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
    */
   async list(
+    security: CustomerPortalSubscriptionsListSecurity,
     request: CustomerPortalSubscriptionsListRequest,
     options?: RequestOptions,
   ): Promise<
@@ -33,6 +46,7 @@ export class PolarSubscriptions extends ClientSDK {
   > {
     return unwrapResultIterator(customerPortalSubscriptionsList(
       this,
+      security,
       request,
       options,
     ));
@@ -42,14 +56,18 @@ export class PolarSubscriptions extends ClientSDK {
    * Get Subscription
    *
    * @remarks
-   * Get a subscription for the authenticated customer or user.
+   * Get a subscription for the authenticated customer.
+   *
+   * **Scopes**: `customer_portal:read` `customer_portal:write`
    */
   async get(
+    security: CustomerPortalSubscriptionsGetSecurity,
     request: CustomerPortalSubscriptionsGetRequest,
     options?: RequestOptions,
   ): Promise<CustomerSubscription> {
     return unwrapAsync(customerPortalSubscriptionsGet(
       this,
+      security,
       request,
       options,
     ));
@@ -59,14 +77,18 @@ export class PolarSubscriptions extends ClientSDK {
    * Update Subscription
    *
    * @remarks
-   * Update a subscription of the authenticated customer or user.
+   * Update a subscription of the authenticated customer.
+   *
+   * **Scopes**: `customer_portal:write`
    */
   async update(
+    security: CustomerPortalSubscriptionsUpdateSecurity,
     request: CustomerPortalSubscriptionsUpdateRequest,
     options?: RequestOptions,
   ): Promise<CustomerSubscription> {
     return unwrapAsync(customerPortalSubscriptionsUpdate(
       this,
+      security,
       request,
       options,
     ));
@@ -76,14 +98,18 @@ export class PolarSubscriptions extends ClientSDK {
    * Cancel Subscription
    *
    * @remarks
-   * Cancel a subscription of the authenticated customer or user.
+   * Cancel a subscription of the authenticated customer.
+   *
+   * **Scopes**: `customer_portal:write`
    */
   async cancel(
+    security: CustomerPortalSubscriptionsCancelSecurity,
     request: CustomerPortalSubscriptionsCancelRequest,
     options?: RequestOptions,
   ): Promise<CustomerSubscription> {
     return unwrapAsync(customerPortalSubscriptionsCancel(
       this,
+      security,
       request,
       options,
     ));

package/src/sdk/products.ts

@@ -26,6 +26,8 @@ export class Products extends ClientSDK {
    *
    * @remarks
    * List products.
+   *
+   * **Scopes**: `products:read` `products:write`
    */
   async list(
     request: ProductsListRequest,
@@ -43,6 +45,8 @@ export class Products extends ClientSDK {
    *
    * @remarks
    * Create a product.
+   *
+   * **Scopes**: `products:write`
    */
   async create(
     request: ProductCreate,
@@ -60,6 +64,8 @@ export class Products extends ClientSDK {
    *
    * @remarks
    * Get a product by ID.
+   *
+   * **Scopes**: `products:read` `products:write`
    */
   async get(
     request: ProductsGetRequest,
@@ -77,6 +83,8 @@ export class Products extends ClientSDK {
    *
    * @remarks
    * Update a product.
+   *
+   * **Scopes**: `products:write`
    */
   async update(
     request: ProductsUpdateRequest,
@@ -94,6 +102,8 @@ export class Products extends ClientSDK {
    *
    * @remarks
    * Update benefits granted by a product.
+   *
+   * **Scopes**: `products:write`
    */
   async updateBenefits(
     request: ProductsUpdateBenefitsRequest,

package/src/sdk/refunds.ts

@@ -20,6 +20,8 @@ export class Refunds extends ClientSDK {
    *
    * @remarks
    * List products.
+   *
+   * **Scopes**: `refunds:read` `refunds:write`
    */
   async list(
     request: RefundsListRequest,
@@ -37,6 +39,8 @@ export class Refunds extends ClientSDK {
    *
    * @remarks
    * Create a refund.
+   *
+   * **Scopes**: `refunds:write`
    */
   async create(
     request: RefundCreate,

package/src/sdk/repositories.ts

@@ -22,6 +22,8 @@ export class Repositories extends ClientSDK {
    *
    * @remarks
    * List repositories.
+   *
+   * **Scopes**: `repositories:read` `repositories:write`
    */
   async list(
     request: RepositoriesListRequest,
@@ -39,6 +41,8 @@ export class Repositories extends ClientSDK {
    *
    * @remarks
    * Get a repository by ID.
+   *
+   * **Scopes**: `repositories:read` `repositories:write`
    */
   async get(
     request: RepositoriesGetRequest,
@@ -56,6 +60,8 @@ export class Repositories extends ClientSDK {
    *
    * @remarks
    * Update a repository.
+   *
+   * **Scopes**: `repositories:write`
    */
   async update(
     request: RepositoriesUpdateRequest,

package/src/sdk/subscriptions.ts

@@ -26,6 +26,8 @@ export class Subscriptions extends ClientSDK {
    *
    * @remarks
    * List subscriptions.
+   *
+   * **Scopes**: `subscriptions:read` `subscriptions:write`
    */
   async list(
     request: SubscriptionsListRequest,
@@ -43,6 +45,8 @@ export class Subscriptions extends ClientSDK {
    *
    * @remarks
    * Export subscriptions as a CSV file.
+   *
+   * **Scopes**: `subscriptions:read` `subscriptions:write`
    */
   async export(
     request: SubscriptionsExportRequest,
@@ -60,6 +64,8 @@ export class Subscriptions extends ClientSDK {
    *
    * @remarks
    * Get a subscription by ID.
+   *
+   * **Scopes**: `subscriptions:write`
    */
   async get(
     request: SubscriptionsGetRequest,
@@ -77,6 +83,8 @@ export class Subscriptions extends ClientSDK {
    *
    * @remarks
    * Update a subscription.
+   *
+   * **Scopes**: `subscriptions:write`
    */
   async update(
     request: SubscriptionsUpdateRequest,
@@ -94,6 +102,8 @@ export class Subscriptions extends ClientSDK {
    *
    * @remarks
    * Revoke a subscription, i.e cancel immediately.
+   *
+   * **Scopes**: `subscriptions:write`
    */
   async revoke(
     request: SubscriptionsRevokeRequest,