@metronome/sdk 3.0.0 → 3.5.0

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

@@ -8,6 +8,9 @@ import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
+/**
+ * [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 {
   /**
    * Retrieve detailed information for a specific invoice by its unique identifier.
@@ -299,8 +302,8 @@ export interface Invoice {
   billable_status?: unknown;
 
   /**
-   * Account hierarchy M3 - Required on invoices with type USAGE_CONSOLIDATED. List
-   * of constituent invoices that were consolidated to create this invoice.
+   * Required on invoices with type USAGE_CONSOLIDATED. List of constituent invoices
+   * that were consolidated to create this invoice.
    */
   constituent_invoices?: Array<Invoice.ConstituentInvoice>;
 
@@ -348,8 +351,8 @@ export interface Invoice {
   netsuite_sales_order_id?: string;
 
   /**
-   * Account hierarchy M3 - Required for account hierarchy usage invoices. An object
-   * containing the contract and customer UUIDs that pay for this invoice.
+   * Required for account hierarchy usage invoices. An object containing the contract
+   * and customer UUIDs that pay for this invoice.
    */
   payer?: Invoice.Payer;
 
@@ -500,9 +503,9 @@ export namespace Invoice {
     netsuite_item_id?: string;
 
     /**
-     * Account hierarchy M3 - Present on line items from invoices with type
-     * USAGE_CONSOLIDATED. Indicates the original customer, contract, invoice and line
-     * item from which this line item was copied.
+     * Present on line items from invoices with type USAGE_CONSOLIDATED. Indicates the
+     * original customer, contract, invoice and line item from which this line item was
+     * copied.
      */
     origin?: LineItem.Origin;
 
@@ -583,6 +586,12 @@ export namespace Invoice {
      */
     subscription_custom_fields?: { [key: string]: string };
 
+    /**
+     * ID of the subscription that this line item is associated with. Only present on
+     * line items with product of `SUBSCRIPTION` type.
+     */
+    subscription_id?: string;
+
     /**
      * Populated if the line item has a tiered price.
      */
@@ -607,9 +616,9 @@ export namespace Invoice {
     }
 
     /**
-     * Account hierarchy M3 - Present on line items from invoices with type
-     * USAGE_CONSOLIDATED. Indicates the original customer, contract, invoice and line
-     * item from which this line item was copied.
+     * Present on line items from invoices with type USAGE_CONSOLIDATED. Indicates the
+     * original customer, contract, invoice and line item from which this line item was
+     * copied.
      */
     export interface Origin {
       contract_id: string;
@@ -906,8 +915,8 @@ export namespace Invoice {
   }
 
   /**
-   * Account hierarchy M3 - Required for account hierarchy usage invoices. An object
-   * containing the contract and customer UUIDs that pay for this invoice.
+   * Required for account hierarchy usage invoices. An object containing the contract
+   * and customer UUIDs that pay for this invoice.
    */
   export interface Payer {
     contract_id: string;

package/src/resources/v1/customers/named-schedules.ts

@@ -5,6 +5,9 @@ import { APIPromise } from '../../../core/api-promise';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 
+/**
+ * Named schedules are used for storing custom data that can change over time. Named schedules are often used in custom pricing logic.
+ */
 export class NamedSchedules extends APIResource {
   /**
    * Get a named schedule for the given customer. This endpoint's availability is

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

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