feat(api): OpenAPI spec update via Stainless API (#117)

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 91
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/metronome%2Fmetronome-a89210f56e000a978cd97348ab656503553f7a93d055561792d012c4a70cd5da.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/metronome%2Fmetronome-4de9563f4ab2e7aa37e854d325c2166633d1e484d3bbaffeee3a98774f3b52ba.yml

api.md

@@ -6,7 +6,7 @@ Types:
 - <code><a href="./src/resources/shared.ts">Commit</a></code>
 - <code><a href="./src/resources/shared.ts">ContractWithoutAmendments</a></code>
 - <code><a href="./src/resources/shared.ts">Credit</a></code>
-- <code><a href="./src/resources/shared.ts">CreditType</a></code>
+- <code><a href="./src/resources/shared.ts">CreditTypeData</a></code>
 - <code><a href="./src/resources/shared.ts">Discount</a></code>
 - <code><a href="./src/resources/shared.ts">EventTypeFilter</a></code>
 - <code><a href="./src/resources/shared.ts">ID</a></code>

src/index.ts

@@ -344,7 +344,7 @@ export namespace Metronome {
   export import Commit = API.Commit;
   export import ContractWithoutAmendments = API.ContractWithoutAmendments;
   export import Credit = API.Credit;
-  export import CreditType = API.CreditType;
+  export import CreditTypeData = API.CreditTypeData;
   export import Discount = API.Discount;
   export import EventTypeFilter = API.EventTypeFilter;
   export import ID = API.ID;

src/resources/alerts.ts

@@ -142,7 +142,15 @@ export namespace AlertCreateParams {
 }
 
 export interface AlertArchiveParams {
+  /**
+   * The Metronome ID of the alert
+   */
   id: string;
+
+  /**
+   * If true, resets the uniqueness key on this alert so it can be re-used
+   */
+  release_uniqueness_key?: boolean;
 }
 
 export namespace Alerts {

src/resources/contracts/contracts.ts

@@ -456,7 +456,7 @@ export namespace ContractRetrieveRateScheduleResponse {
         | 'CUSTOM'
         | 'custom';
 
-      credit_type?: Shared.CreditType;
+      credit_type?: Shared.CreditTypeData;
 
       /**
        * Commit rate proration configuration. Only valid for SUBSCRIPTION rate_type.

src/resources/contracts/rate-cards/rate-cards.ts

@@ -103,7 +103,7 @@ export namespace RateCardRetrieveResponse {
 
     description?: string;
 
-    fiat_credit_type?: Shared.CreditType;
+    fiat_credit_type?: Shared.CreditTypeData;
   }
 
   export namespace Data {
@@ -121,7 +121,7 @@ export namespace RateCardRetrieveResponse {
 
         created_by?: string;
 
-        credit_type?: Shared.CreditType;
+        credit_type?: Shared.CreditTypeData;
 
         custom_rate?: Record<string, unknown>;
 
@@ -162,7 +162,7 @@ export namespace RateCardRetrieveResponse {
          */
         commit_rate?: Update.CommitRate;
 
-        credit_type?: Shared.CreditType;
+        credit_type?: Shared.CreditTypeData;
 
         custom_rate?: Record<string, unknown>;
 
@@ -196,7 +196,7 @@ export namespace RateCardRetrieveResponse {
             | 'CUSTOM'
             | 'custom';
 
-          credit_type?: Shared.CreditType;
+          credit_type?: Shared.CreditTypeData;
 
           /**
            * Commit rate proration configuration. Only valid for SUBSCRIPTION rate_type.
@@ -239,7 +239,7 @@ export namespace RateCardRetrieveResponse {
     }
 
     export interface CreditTypeConversion {
-      custom_credit_type: Shared.CreditType;
+      custom_credit_type: Shared.CreditTypeData;
 
       fiat_per_custom_credit: string;
     }
@@ -269,7 +269,7 @@ export interface RateCardListResponse {
 
   description?: string;
 
-  fiat_credit_type?: Shared.CreditType;
+  fiat_credit_type?: Shared.CreditTypeData;
 }
 
 export namespace RateCardListResponse {
@@ -287,7 +287,7 @@ export namespace RateCardListResponse {
 
       created_by?: string;
 
-      credit_type?: Shared.CreditType;
+      credit_type?: Shared.CreditTypeData;
 
       custom_rate?: Record<string, unknown>;
 
@@ -328,7 +328,7 @@ export namespace RateCardListResponse {
        */
       commit_rate?: Update.CommitRate;
 
-      credit_type?: Shared.CreditType;
+      credit_type?: Shared.CreditTypeData;
 
       custom_rate?: Record<string, unknown>;
 
@@ -362,7 +362,7 @@ export namespace RateCardListResponse {
           | 'CUSTOM'
           | 'custom';
 
-        credit_type?: Shared.CreditType;
+        credit_type?: Shared.CreditTypeData;
 
         /**
          * Commit rate proration configuration. Only valid for SUBSCRIPTION rate_type.
@@ -405,7 +405,7 @@ export namespace RateCardListResponse {
   }
 
   export interface CreditTypeConversion {
-    custom_credit_type: Shared.CreditType;
+    custom_credit_type: Shared.CreditTypeData;
 
     fiat_per_custom_credit: string;
   }
@@ -462,7 +462,7 @@ export namespace RateCardRetrieveRateScheduleResponse {
         | 'CUSTOM'
         | 'custom';
 
-      credit_type?: Shared.CreditType;
+      credit_type?: Shared.CreditTypeData;
 
       /**
        * Commit rate proration configuration. Only valid for SUBSCRIPTION rate_type.

src/resources/contracts/rate-cards/rates.ts

@@ -93,7 +93,7 @@ export namespace RateListResponse {
       | 'CUSTOM'
       | 'custom';
 
-    credit_type?: Shared.CreditType;
+    credit_type?: Shared.CreditTypeData;
 
     /**
      * Commit rate proration configuration. Only valid for SUBSCRIPTION rate_type.
@@ -151,7 +151,7 @@ export namespace RateAddResponse {
      */
     commit_rate?: Data.CommitRate;
 
-    credit_type?: Shared.CreditType;
+    credit_type?: Shared.CreditTypeData;
 
     /**
      * Only set for CUSTOM rate_type. This field is interpreted by custom rate
@@ -213,7 +213,7 @@ export namespace RateAddResponse {
         | 'CUSTOM'
         | 'custom';
 
-      credit_type?: Shared.CreditType;
+      credit_type?: Shared.CreditTypeData;
 
       /**
        * Commit rate proration configuration. Only valid for SUBSCRIPTION rate_type.
@@ -400,7 +400,7 @@ export namespace RateAddParams {
       | 'CUSTOM'
       | 'custom';
 
-    credit_type?: Shared.CreditType;
+    credit_type?: Shared.CreditTypeData;
 
     /**
      * Commit rate proration configuration. Only valid for SUBSCRIPTION rate_type.
@@ -535,7 +535,7 @@ export namespace RateAddManyParams {
         | 'CUSTOM'
         | 'custom';
 
-      credit_type?: Shared.CreditType;
+      credit_type?: Shared.CreditTypeData;
 
       /**
        * Commit rate proration configuration. Only valid for SUBSCRIPTION rate_type.

src/resources/credit-grants.ts

@@ -267,7 +267,7 @@ export namespace CreditGrantListResponse {
     /**
      * the credit type for the amount granted
      */
-    credit_type: Shared.CreditType;
+    credit_type: Shared.CreditTypeData;
   }
 
   /**
@@ -279,7 +279,7 @@ export namespace CreditGrantListResponse {
     /**
      * the credit type for the amount paid
      */
-    credit_type: Shared.CreditType;
+    credit_type: Shared.CreditTypeData;
   }
 
   export interface Product {
@@ -316,7 +316,7 @@ export namespace CreditGrantListEntriesResponse {
 
   export namespace Data {
     export interface Ledger {
-      credit_type: Shared.CreditType;
+      credit_type: Shared.CreditTypeData;
 
       /**
        * the effective balances at the end of the specified time window

src/resources/customers/alerts.ts

@@ -102,7 +102,7 @@ export namespace CustomerAlert {
      */
     credit_grant_type_filters?: Array<string>;
 
-    credit_type?: Shared.CreditType | null;
+    credit_type?: Shared.CreditTypeData | null;
 
     /**
      * A list of custom field filters for alert types that support advanced filtering

src/resources/customers/invoices.ts

@@ -68,7 +68,7 @@ export class InvoiceListBreakdownsResponsesCursorPage extends CursorPage<Invoice
 export interface Invoice {
   id: string;
 
-  credit_type: Shared.CreditType;
+  credit_type: Shared.CreditTypeData;
 
   customer_id: string;
 
@@ -150,7 +150,7 @@ export interface Invoice {
 
 export namespace Invoice {
   export interface LineItem {
-    credit_type: Shared.CreditType;
+    credit_type: Shared.CreditTypeData;
 
     name: string;
 
@@ -421,7 +421,7 @@ export namespace Invoice {
   }
 
   export interface InvoiceAdjustment {
-    credit_type: Shared.CreditType;
+    credit_type: Shared.CreditTypeData;
 
     name: string;
 

src/resources/customers/plans.ts

@@ -100,7 +100,7 @@ export namespace PlanListResponse {
 
       amount_remaining: number;
 
-      credit_type: Shared.CreditType;
+      credit_type: Shared.CreditTypeData;
     }
   }
 }

src/resources/plans.ts

@@ -95,11 +95,11 @@ export namespace PlanDetail {
   export interface CreditGrant {
     amount_granted: number;
 
-    amount_granted_credit_type: Shared.CreditType;
+    amount_granted_credit_type: Shared.CreditTypeData;
 
     amount_paid: number;
 
-    amount_paid_credit_type: Shared.CreditType;
+    amount_paid_credit_type: Shared.CreditTypeData;
 
     effective_duration: number;
 
@@ -117,7 +117,7 @@ export namespace PlanDetail {
   }
 
   export interface Minimum {
-    credit_type: Shared.CreditType;
+    credit_type: Shared.CreditTypeData;
 
     name: string;
 
@@ -131,9 +131,9 @@ export namespace PlanDetail {
   }
 
   export interface OverageRate {
-    credit_type: Shared.CreditType;
+    credit_type: Shared.CreditTypeData;
 
-    fiat_credit_type: Shared.CreditType;
+    fiat_credit_type: Shared.CreditTypeData;
 
     /**
      * Used in price ramps. Indicates how many billing periods pass before the charge
@@ -164,7 +164,7 @@ export interface PlanListChargesResponse {
 
   charge_type: 'usage' | 'fixed' | 'composite' | 'minimum' | 'seat';
 
-  credit_type: Shared.CreditType;
+  credit_type: Shared.CreditTypeData;
 
   custom_fields: Record<string, string>;
 

src/resources/shared.ts

@@ -515,7 +515,7 @@ export namespace Credit {
   }
 }
 
-export interface CreditType {
+export interface CreditTypeData {
   id: string;
 
   name: string;
@@ -574,7 +574,7 @@ export interface Override {
 
   applicable_product_tags?: Array<string>;
 
-  credit_type?: CreditType;
+  credit_type?: CreditTypeData;
 
   ending_before?: string;
 
@@ -644,7 +644,7 @@ export namespace Override {
   export interface OverwriteRate {
     rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'TIERED' | 'CUSTOM';
 
-    credit_type?: Shared.CreditType;
+    credit_type?: Shared.CreditTypeData;
 
     /**
      * Only set for CUSTOM rate_type. This field is interpreted by custom rate
@@ -747,7 +747,7 @@ export interface ProService {
 export interface Rate {
   rate_type: 'FLAT' | 'PERCENTAGE' | 'SUBSCRIPTION' | 'CUSTOM' | 'TIERED';
 
-  credit_type?: CreditType;
+  credit_type?: CreditTypeData;
 
   /**
    * Only set for CUSTOM rate_type. This field is interpreted by custom rate
@@ -821,7 +821,7 @@ export namespace ScheduledCharge {
 export interface ScheduleDuration {
   schedule_items: Array<ScheduleDuration.ScheduleItem>;
 
-  credit_type?: CreditType;
+  credit_type?: CreditTypeData;
 }
 
 export namespace ScheduleDuration {
@@ -837,7 +837,7 @@ export namespace ScheduleDuration {
 }
 
 export interface SchedulePointInTime {
-  credit_type?: CreditType;
+  credit_type?: CreditTypeData;
 
   schedule_items?: Array<SchedulePointInTime.ScheduleItem>;
 }

tests/api-resources/alerts.test.ts

@@ -62,6 +62,9 @@ describe('resource alerts', () => {
   });
 
   test('archive: required and optional params', async () => {
-    const response = await client.alerts.archive({ id: '8deed800-1b7a-495d-a207-6c52bac54dc9' });
+    const response = await client.alerts.archive({
+      id: '8deed800-1b7a-495d-a207-6c52bac54dc9',
+      release_uniqueness_key: true,
+    });
   });
 });