@metronome/sdk 0.2.0 → 0.3.0

package/src/index.ts

@@ -190,6 +190,7 @@ export class Metronome extends Core.APIClient {
 
 Metronome.V2 = V2;
 Metronome.V1 = V1;
+
 export declare namespace Metronome {
   export type RequestOptions = Core.RequestOptions;
 

package/src/resources/shared.ts

@@ -1774,6 +1774,12 @@ export namespace ScheduleDuration {
 export interface SchedulePointInTime {
   credit_type?: CreditTypeData;
 
+  /**
+   * This field is only applicable to commit invoice schedules. If true, this
+   * schedule will not generate an invoice.
+   */
+  do_not_invoice?: boolean;
+
   schedule_items?: Array<SchedulePointInTime.ScheduleItem>;
 }
 

package/src/resources/v1/contracts/contracts.ts

@@ -1719,6 +1719,12 @@ export namespace ContractCreateParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -1866,6 +1872,18 @@ export namespace ContractCreateParams {
          * your payment type.
          */
         invoice_metadata?: { [key: string]: string };
+
+        /**
+         * If true, the payment will be made assuming the customer is present (i.e. on
+         * session).
+         *
+         * If false, the payment will be made assuming the customer is not present (i.e.
+         * off session). For cardholders from a country with an e-mandate requirement (e.g.
+         * India), the payment may be declined.
+         *
+         * If left blank, will default to false.
+         */
+        on_session_payment?: boolean;
       }
     }
 
@@ -2050,6 +2068,12 @@ export namespace ContractCreateParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -2622,8 +2646,8 @@ export namespace ContractCreateParams {
       unit_price: number;
 
       /**
-       * This field is currently required. Upcoming recurring commit/credit configuration
-       * options will allow it to be optional.
+       * This field is required unless a subscription is attached via
+       * `subscription_config`.
        */
       quantity?: number;
     }
@@ -2837,8 +2861,8 @@ export namespace ContractCreateParams {
       unit_price: number;
 
       /**
-       * This field is currently required. Upcoming recurring commit/credit configuration
-       * options will allow it to be optional.
+       * This field is required unless a subscription is attached via
+       * `subscription_config`.
        */
       quantity?: number;
     }
@@ -2976,6 +3000,8 @@ export namespace ContractCreateParams {
      */
     schedule: ScheduledCharge.Schedule;
 
+    custom_fields?: { [key: string]: string };
+
     /**
      * displayed on invoices
      */
@@ -2997,6 +3023,12 @@ export namespace ContractCreateParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -3610,6 +3642,12 @@ export namespace ContractAmendParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -3757,6 +3795,18 @@ export namespace ContractAmendParams {
          * your payment type.
          */
         invoice_metadata?: { [key: string]: string };
+
+        /**
+         * If true, the payment will be made assuming the customer is present (i.e. on
+         * session).
+         *
+         * If false, the payment will be made assuming the customer is not present (i.e.
+         * off session). For cardholders from a country with an e-mandate requirement (e.g.
+         * India), the payment may be declined.
+         *
+         * If left blank, will default to false.
+         */
+        on_session_payment?: boolean;
       }
     }
 
@@ -3941,6 +3991,12 @@ export namespace ContractAmendParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -4283,6 +4339,8 @@ export namespace ContractAmendParams {
      */
     schedule: ScheduledCharge.Schedule;
 
+    custom_fields?: { [key: string]: string };
+
     /**
      * displayed on invoices
      */
@@ -4304,6 +4362,12 @@ export namespace ContractAmendParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and

package/src/resources/v1/contracts/products.ts

@@ -428,6 +428,8 @@ export interface ProductCreateParams {
    */
   composite_tags?: Array<string>;
 
+  custom_fields?: { [key: string]: string };
+
   /**
    * Beta feature only available for composite products. If true, products with $0
    * will not be included when computing composite usage. Defaults to false

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

@@ -36,6 +36,7 @@ export class Commits extends APIResource {
    *         timestamp: '2020-03-01T00:00:00.000Z',
    *       },
    *     ],
+   *     do_not_invoice: false,
    *   },
    *   name: 'My Commit',
    * });
@@ -240,6 +241,12 @@ export namespace CommitCreateParams {
      */
     credit_type_id?: string;
 
+    /**
+     * This field is only applicable to commit invoice schedules. If true, this
+     * schedule will not generate an invoice.
+     */
+    do_not_invoice?: boolean;
+
     /**
      * Enter the unit price and quantity for the charge or instead only send the
      * amount. If amount is sent, the unit price is assumed to be the amount and

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

@@ -207,6 +207,15 @@ export namespace Invoice {
 
     total: number;
 
+    /**
+     * The type of line item. Possible values are 'aws_royalty',
+     * 'applied_commit_or_credit', 'scheduled', 'commit_purchase', 'cpu_conversion',
+     * 'discount', 'gcp_royalty', 'postpaid_trueup', 'professional_services',
+     * 'subscription', 'usage', 'legacy', 'minimum', 'product_charge',
+     * 'trial_discount', 'rollover', 'seat', 'grouped_charge'.
+     */
+    type: string;
+
     /**
      * Details about the credit or commit that was applied to this line item. Only
      * present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`

package/src/resources/v2/contracts.ts

@@ -4683,6 +4683,12 @@ export namespace ContractGetEditHistoryResponse {
 
       netsuite_sales_order_id?: string | null;
 
+      /**
+       * If multiple commits are applicable, the one with the lower priority will apply
+       * first.
+       */
+      priority?: number | null;
+
       product_id?: string;
 
       rollover_fraction?: number | null;
@@ -4837,6 +4843,12 @@ export namespace ContractGetEditHistoryResponse {
 
       netsuite_sales_order_id?: string | null;
 
+      /**
+       * If multiple credits are applicable, the one with the lower priority will apply
+       * first.
+       */
+      priority?: number | null;
+
       rollover_fraction?: number | null;
     }
 
@@ -4937,6 +4949,12 @@ export namespace ContractGetEditHistoryResponse {
          */
         credit_type_id?: string;
 
+        /**
+         * This field is only applicable to commit invoice schedules. If true, this
+         * schedule will not generate an invoice.
+         */
+        do_not_invoice?: boolean;
+
         /**
          * Enter the unit price and quantity for the charge or instead only send the
          * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -5720,6 +5738,12 @@ export namespace ContractEditParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -5867,6 +5891,18 @@ export namespace ContractEditParams {
          * your payment type.
          */
         invoice_metadata?: { [key: string]: string };
+
+        /**
+         * If true, the payment will be made assuming the customer is present (i.e. on
+         * session).
+         *
+         * If false, the payment will be made assuming the customer is not present (i.e.
+         * off session). For cardholders from a country with an e-mandate requirement (e.g.
+         * India), the payment may be declined.
+         *
+         * If left blank, will default to false.
+         */
+        on_session_payment?: boolean;
       }
     }
 
@@ -6050,6 +6086,12 @@ export namespace ContractEditParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -6611,8 +6653,8 @@ export namespace ContractEditParams {
       unit_price: number;
 
       /**
-       * This field is currently required. Upcoming recurring commit/credit configuration
-       * options will allow it to be optional.
+       * This field is required unless a subscription is attached via
+       * `subscription_config`.
        */
       quantity?: number;
     }
@@ -6828,8 +6870,8 @@ export namespace ContractEditParams {
       unit_price: number;
 
       /**
-       * This field is currently required. Upcoming recurring commit/credit configuration
-       * options will allow it to be optional.
+       * This field is required unless a subscription is attached via
+       * `subscription_config`.
        */
       quantity?: number;
     }
@@ -6970,6 +7012,8 @@ export namespace ContractEditParams {
      */
     schedule: AddScheduledCharge.Schedule;
 
+    custom_fields?: { [key: string]: string };
+
     /**
      * displayed on invoices
      */
@@ -6991,6 +7035,12 @@ export namespace ContractEditParams {
        */
       credit_type_id?: string;
 
+      /**
+       * This field is only applicable to commit invoice schedules. If true, this
+       * schedule will not generate an invoice.
+       */
+      do_not_invoice?: boolean;
+
       /**
        * Enter the unit price and quantity for the charge or instead only send the
        * amount. If amount is sent, the unit price is assumed to be the amount and
@@ -7285,6 +7335,8 @@ export namespace ContractEditParams {
 
     netsuite_sales_order_id?: string | null;
 
+    priority?: number | null;
+
     product_id?: string;
 
     rollover_fraction?: number | null;
@@ -7412,6 +7464,8 @@ export namespace ContractEditParams {
 
     netsuite_sales_order_id?: string | null;
 
+    priority?: number | null;
+
     product_id?: string;
   }
 
@@ -7879,6 +7933,12 @@ export interface ContractEditCommitParams {
 
   invoice_schedule?: ContractEditCommitParams.InvoiceSchedule;
 
+  /**
+   * If multiple commits are applicable, the one with the lower priority will apply
+   * first.
+   */
+  priority?: number | null;
+
   product_id?: string;
 
   /**
@@ -8004,6 +8064,12 @@ export interface ContractEditCreditParams {
    */
   applicable_product_tags?: Array<string> | null;
 
+  /**
+   * If multiple commits are applicable, the one with the lower priority will apply
+   * first.
+   */
+  priority?: number | null;
+
   product_id?: string;
 
   /**

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0'; // x-release-please-version
+export const VERSION = '0.3.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0";
+export declare const VERSION = "0.3.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0'; // x-release-please-version
+exports.VERSION = '0.3.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.0'; // x-release-please-version
+export const VERSION = '0.3.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map