@metronome/sdk 2.2.0 → 3.4.1

package/src/resources/v1/customers/plans.ts

@@ -7,6 +7,9 @@ import { CursorPage, type CursorPageParams, PagePromise } from '../../../core/pa
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * [Plans](https://docs.metronome.com/pricing-and-packaging/create-plans/) determine the base pricing for a customer. Use these endpoints to add a plan to a customer, end a customer plan, retrieve plans, and retrieve plan details. Create plans in the [Metronome app](https://app.metronome.com/plans).
+ */
 export class Plans extends APIResource {
   /**
    * List the given customer's plans in reverse-chronological order. This is a Plans
@@ -197,19 +200,19 @@ export namespace PlanListPriceAdjustmentsResponse {
 
 export interface PlanListParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 }
 
 export interface PlanAddParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
   /**
-   * Body param:
+   * Body param
    */
   plan_id: string;
 
@@ -326,7 +329,7 @@ export namespace PlanAddParams {
 
 export interface PlanEndParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 
@@ -359,7 +362,7 @@ export interface PlanEndParams {
 
 export interface PlanListPriceAdjustmentsParams extends CursorPageParams {
   /**
-   * Path param:
+   * Path param
    */
   customer_id: string;
 

package/src/resources/v1/dashboards.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * [Customers](https://docs.metronome.com/provisioning/create-customers/) in Metronome represent your users for all billing and reporting. Use these endpoints to create, retrieve, update, and archive customers and their billing configuration.
+ */
 export class Dashboards extends APIResource {
   /**
    * Generate secure, embeddable dashboard URLs that allow you to seamlessly

package/src/resources/v1/index.ts

@@ -33,6 +33,7 @@ export {
   type ContractAmendResponse,
   type ContractArchiveResponse,
   type ContractCreateHistoricalInvoicesResponse,
+  type ContractGetNetBalanceResponse,
   type ContractListBalancesResponse,
   type ContractRetrieveRateScheduleResponse,
   type ContractRetrieveSubscriptionQuantityHistoryResponse,
@@ -45,6 +46,7 @@ export {
   type ContractAmendParams,
   type ContractArchiveParams,
   type ContractCreateHistoricalInvoicesParams,
+  type ContractGetNetBalanceParams,
   type ContractListBalancesParams,
   type ContractRetrieveRateScheduleParams,
   type ContractRetrieveSubscriptionQuantityHistoryParams,
@@ -88,6 +90,7 @@ export {
   type CustomerCreateResponse,
   type CustomerRetrieveResponse,
   type CustomerArchiveResponse,
+  type CustomerArchiveBillingConfigurationsResponse,
   type CustomerListBillableMetricsResponse,
   type CustomerListCostsResponse,
   type CustomerPreviewEventsResponse,
@@ -98,6 +101,7 @@ export {
   type CustomerRetrieveParams,
   type CustomerListParams,
   type CustomerArchiveParams,
+  type CustomerArchiveBillingConfigurationsParams,
   type CustomerListBillableMetricsParams,
   type CustomerListCostsParams,
   type CustomerPreviewEventsParams,
@@ -122,6 +126,21 @@ export {
   type InvoiceRegenerateParams,
   type InvoiceVoidParams,
 } from './invoices';
+export {
+  Packages,
+  type PackageCreateResponse,
+  type PackageRetrieveResponse,
+  type PackageListResponse,
+  type PackageArchiveResponse,
+  type PackageListContractsOnPackageResponse,
+  type PackageCreateParams,
+  type PackageRetrieveParams,
+  type PackageListParams,
+  type PackageArchiveParams,
+  type PackageListContractsOnPackageParams,
+  type PackageListResponsesCursorPage,
+  type PackageListContractsOnPackageResponsesCursorPage,
+} from './packages';
 export {
   Payments,
   type Payment,

package/src/resources/v1/invoices.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 
+/**
+ * [Invoices](https://docs.metronome.com/invoicing/) reflect how much a customer spent during a period, which is the basis for billing. Metronome automatically generates invoices based upon your pricing, packaging, and usage events. Use these endpoints to retrieve invoices.
+ */
 export class Invoices extends APIResource {
   /**
    * This endpoint regenerates a voided invoice and recalculates the invoice based on