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

Metronome-Industries · Jun 28, 2024 · 46da725 · 46da725
1 parent 72ac25b
commit 46da725
Show file tree

Hide file tree

Showing 19 changed files with 35 additions and 30 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+.prism.log
 node_modules
 yarn-error.log
 codegen.log

diff --git a/.stats.yml b/.stats.yml
@@ -1,2 +1,2 @@
 configured_endpoints: 48
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/metronome%2Fmetronome-3aa1a571be1e0fb229fbd0c7fb1c9eb9dcbb1296613c7a07b3ebc16ac76aba44.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/metronome%2Fmetronome-1ba87fe3b31769922c40c192fab50b9bdda6518303b16c4c1821ea8ecefb5def.yml
diff --git a/src/index.ts b/src/index.ts
@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from './core';
 import * as Errors from './error';
-import { type Agent } from './_shims/index';
 import * as Uploads from './uploads';
+import { type Agent } from './_shims/index';
 import * as qs from 'qs';
+import * as Core from '@metronome/sdk/core';
 import * as Pagination from '@metronome/sdk/pagination';
 import * as API from '@metronome/sdk/resources/index';
 
@@ -76,7 +76,9 @@ export interface ClientOptions {
   defaultQuery?: Core.DefaultQuery;
 }
 
-/** API Client for interfacing with the Metronome API. */
+/**
+ * API Client for interfacing with the Metronome API.
+ */
 export class Metronome extends Core.APIClient {
   bearerToken: string;
   webhookSecret: string | null;
@@ -122,6 +124,7 @@ export class Metronome extends Core.APIClient {
       maxRetries: options.maxRetries,
       fetch: options.fetch,
     });
+
     this._options = options;
 
     this.bearerToken = bearerToken;

diff --git a/src/resources/alerts.ts b/src/resources/alerts.ts
@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
+import * as Core from '@metronome/sdk/core';
 import * as AlertsAPI from '@metronome/sdk/resources/alerts';
 import * as Shared from '@metronome/sdk/resources/shared';
 

diff --git a/src/resources/audit-logs.ts b/src/resources/audit-logs.ts
@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
 import { isRequestOptions } from '@metronome/sdk/core';
+import * as Core from '@metronome/sdk/core';
 import * as AuditLogsAPI from '@metronome/sdk/resources/audit-logs';
 import { CursorPage, type CursorPageParams } from '@metronome/sdk/pagination';
 

diff --git a/src/resources/billable-metrics.ts b/src/resources/billable-metrics.ts
@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
 import { isRequestOptions } from '@metronome/sdk/core';
+import * as Core from '@metronome/sdk/core';
 import * as BillableMetricsAPI from '@metronome/sdk/resources/billable-metrics';
 import * as Shared from '@metronome/sdk/resources/shared';
 import { CursorPage, type CursorPageParams } from '@metronome/sdk/pagination';

diff --git a/src/resources/credit-grants.ts b/src/resources/credit-grants.ts
@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
 import { isRequestOptions } from '@metronome/sdk/core';
+import * as Core from '@metronome/sdk/core';
 import * as CreditGrantsAPI from '@metronome/sdk/resources/credit-grants';
 import * as Shared from '@metronome/sdk/resources/shared';
 import { CursorPage, type CursorPageParams } from '@metronome/sdk/pagination';

diff --git a/src/resources/custom-fields.ts b/src/resources/custom-fields.ts
@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
 import { isRequestOptions } from '@metronome/sdk/core';
+import * as Core from '@metronome/sdk/core';
 import * as CustomFieldsAPI from '@metronome/sdk/resources/custom-fields';
 
 export class CustomFields extends APIResource {

diff --git a/src/resources/customers/alerts.ts b/src/resources/customers/alerts.ts
@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
+import * as Core from '@metronome/sdk/core';
 import * as AlertsAPI from '@metronome/sdk/resources/customers/alerts';
 import * as Shared from '@metronome/sdk/resources/shared';
 

diff --git a/src/resources/customers/billing-config.ts b/src/resources/customers/billing-config.ts
@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
+import * as Core from '@metronome/sdk/core';
 import * as BillingConfigAPI from '@metronome/sdk/resources/customers/billing-config';
 
 export class BillingConfig extends APIResource {

diff --git a/src/resources/customers/customers.ts b/src/resources/customers/customers.ts
@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
 import { isRequestOptions } from '@metronome/sdk/core';
+import * as Core from '@metronome/sdk/core';
 import * as CustomersAPI from '@metronome/sdk/resources/customers/customers';
 import * as Shared from '@metronome/sdk/resources/shared';
 import * as AlertsAPI from '@metronome/sdk/resources/customers/alerts';
@@ -398,6 +398,9 @@ export interface CustomerSetNameResponse {
 }
 
 export interface CustomerCreateParams {
+  /**
+   * This will be truncated to 160 characters if the provided name is longer.
+   */
   name: string;
 
   billing_config?: CustomerCreateParams.BillingConfig;
@@ -516,7 +519,8 @@ export interface CustomerSetIngestAliasesParams {
 
 export interface CustomerSetNameParams {
   /**
-   * The new name for the customer
+   * The new name for the customer. This will be truncated to 160 characters if the
+   * provided name is longer.
    */
   name: string;
 }

diff --git a/src/resources/customers/invoices.ts b/src/resources/customers/invoices.ts
@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
 import { isRequestOptions } from '@metronome/sdk/core';
+import * as Core from '@metronome/sdk/core';
 import * as InvoicesAPI from '@metronome/sdk/resources/customers/invoices';
 import * as Shared from '@metronome/sdk/resources/shared';
 import { CursorPage, type CursorPageParams } from '@metronome/sdk/pagination';

diff --git a/src/resources/customers/plans.ts b/src/resources/customers/plans.ts
@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
 import { isRequestOptions } from '@metronome/sdk/core';
+import * as Core from '@metronome/sdk/core';
 import * as PlansAPI from '@metronome/sdk/resources/customers/plans';
 import * as Shared from '@metronome/sdk/resources/shared';
 import { CursorPage, type CursorPageParams } from '@metronome/sdk/pagination';

diff --git a/src/resources/dashboards.ts b/src/resources/dashboards.ts
@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
+import * as Core from '@metronome/sdk/core';
 import * as DashboardsAPI from '@metronome/sdk/resources/dashboards';
 
 export class Dashboards extends APIResource {

diff --git a/src/resources/plans.ts b/src/resources/plans.ts
@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
 import { isRequestOptions } from '@metronome/sdk/core';
+import * as Core from '@metronome/sdk/core';
 import * as PlansAPI from '@metronome/sdk/resources/plans';
 import * as Shared from '@metronome/sdk/resources/shared';
 import * as CustomersAPI from '@metronome/sdk/resources/customers/customers';

diff --git a/src/resources/services.ts b/src/resources/services.ts
@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
+import * as Core from '@metronome/sdk/core';
 import * as ServicesAPI from '@metronome/sdk/resources/services';
 
 export class Services extends APIResource {

diff --git a/src/resources/usage.ts b/src/resources/usage.ts
@@ -1,7 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import * as Core from '@metronome/sdk/core';
 import { APIResource } from '@metronome/sdk/resource';
+import * as Core from '@metronome/sdk/core';
 import * as UsageAPI from '@metronome/sdk/resources/usage';
 import { CursorPage, type CursorPageParams } from '@metronome/sdk/pagination';
 

diff --git a/tests/stringifyQuery.test.ts b/tests/stringifyQuery.test.ts
@@ -1,8 +1,10 @@
-import { APIClient } from '@metronome/sdk/core';
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-const { stringifyQuery } = APIClient.prototype as any;
+import { Metronome } from '@metronome/sdk';
 
-describe('APIClient.stringifyQuery', () => {
+const { stringifyQuery } = Metronome.prototype as any;
+
+describe(stringifyQuery, () => {
   for (const [input, expected] of [
     [{ a: '1', b: 2, c: true }, 'a=1&b=2&c=true'],
     [{ a: null, b: false, c: undefined }, 'a=&b=false'],
@@ -18,9 +20,4 @@ describe('APIClient.stringifyQuery', () => {
       expect(stringifyQuery(input)).toEqual(expected);
     });
   }
-  for (const value of [[], {}, new Date()]) {
-    it(`${JSON.stringify(value)} -> <error>`, () => {
-      expect(() => stringifyQuery({ value })).toThrow(`Cannot stringify type ${typeof value}`);
-    });
-  }
 });
diff --git a/yarn.lock b/yarn.lock
@@ -2820,9 +2820,9 @@ npm-run-path@^5.1.0:
     path-key "^4.0.0"
 
 object-inspect@^1.13.1:
-  version "1.13.1"
-  resolved "https://registry.yarnpkg.com/object-inspect/-/object-inspect-1.13.1.tgz#b96c6109324ccfef6b12216a956ca4dc2ff94bc2"
-  integrity sha512-5qoj1RUiKOMsCCNLV1CBiPYE10sziTsnmNxkAI/rZhiD63CF7IqdFGC/XzjWjpSgLf0LxXX3bDFIh0E18f6UhQ==
+  version "1.13.2"
+  resolved "https://registry.yarnpkg.com/object-inspect/-/object-inspect-1.13.2.tgz#dea0088467fb991e67af4058147a24824a3043ff"
+  integrity sha512-IRZSRuzJiynemAXPYtPe5BoI/RESNYR7TYm50MC5Mqbd3Jmw5y790sErYw3V6SryFJD64b74qQQs9wn5Bg/k3g==
 
 once@^1.3.0:
   version "1.4.0"