@metronome/sdk 0.1.0-alpha.0

package/src/resources/customers/customers.ts

@@ -0,0 +1,500 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import { isRequestOptions } from "../../core";
+import * as CustomersAPI from "./customers";
+import * as Shared from "../shared";
+import * as AlertsAPI from "./alerts";
+import * as BillingConfigAPI from "./billing-config";
+import * as InvoicesAPI from "./invoices";
+import * as PlansAPI from "./plans";
+
+export class Customers extends APIResource {
+  alerts: AlertsAPI.Alerts = new AlertsAPI.Alerts(this._client);
+  plans: PlansAPI.Plans = new PlansAPI.Plans(this._client);
+  invoices: InvoicesAPI.Invoices = new InvoicesAPI.Invoices(this._client);
+  billingConfig: BillingConfigAPI.BillingConfig = new BillingConfigAPI.BillingConfig(this._client);
+
+  /**
+   * Create a new customer
+   */
+  create(body: CustomerCreateParams, options?: Core.RequestOptions): Core.APIPromise<CustomerCreateResponse> {
+    return this._client.post('/customers', { body, ...options });
+  }
+
+  /**
+   * Get a customer by Metronome ID.
+   */
+  retrieve(customerId: string, options?: Core.RequestOptions): Core.APIPromise<CustomerRetrieveResponse> {
+    return this._client.get(`/customers/${customerId}`, options);
+  }
+
+  /**
+   * List all customers.
+   */
+  list(query?: CustomerListParams, options?: Core.RequestOptions): Core.APIPromise<CustomerListResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<CustomerListResponse>;
+  list(
+    query: CustomerListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomerListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/customers', { query, ...options });
+  }
+
+  /**
+   * Archive a customer
+   */
+  archive(
+    body: CustomerArchiveParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomerArchiveResponse> {
+    return this._client.post('/customers/archive', { body, ...options });
+  }
+
+  /**
+   * List all billable metrics.
+   */
+  listBillableMetrics(
+    customerId: string,
+    query?: CustomerListBillableMetricsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomerListBillableMetricsResponse>;
+  listBillableMetrics(
+    customerId: string,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomerListBillableMetricsResponse>;
+  listBillableMetrics(
+    customerId: string,
+    query: CustomerListBillableMetricsParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomerListBillableMetricsResponse> {
+    if (isRequestOptions(query)) {
+      return this.listBillableMetrics(customerId, {}, query);
+    }
+    return this._client.get(`/customers/${customerId}/billable-metrics`, { query, ...options });
+  }
+
+  /**
+   * Fetch daily pending costs for the specified customer, broken down by credit type
+   * and line items. Note: this is not supported for customers whose plan includes a
+   * UNIQUE-type billable metric.
+   */
+  listCosts(
+    customerId: string,
+    query: CustomerListCostsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomerListCostsResponse> {
+    return this._client.get(`/customers/${customerId}/costs`, { query, ...options });
+  }
+
+  /**
+   * Sets the ingest aliases for a customer. Ingest aliases can be used in the
+   * `customer_id` field when sending usage events to Metronome. This call is
+   * idempotent. It fully replaces the set of ingest aliases for the given customer.
+   */
+  setIngestAliases(
+    customerId: string,
+    body: CustomerSetIngestAliasesParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<void> {
+    return this._client.post(`/customers/${customerId}/setIngestAliases`, {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Updates the specified customer's name.
+   */
+  setName(
+    customerId: string,
+    body: CustomerSetNameParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomerSetNameResponse> {
+    return this._client.post(`/customers/${customerId}/setName`, { body, ...options });
+  }
+
+  /**
+   * Updates the specified customer's config.
+   */
+  updateConfig(
+    customerId: string,
+    body?: CustomerUpdateConfigParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<void>;
+  updateConfig(customerId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+  updateConfig(
+    customerId: string,
+    body: CustomerUpdateConfigParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<void> {
+    if (isRequestOptions(body)) {
+      return this.updateConfig(customerId, {}, body);
+    }
+    return this._client.post(`/customers/${customerId}/updateConfig`, {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}
+
+export interface Customer {
+  /**
+   * the Metronome ID of the customer
+   */
+  id: string;
+
+  /**
+   * (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+   * alias) that can be used in usage events
+   */
+  external_id: string;
+
+  /**
+   * aliases for this customer that can be used instead of the Metronome customer ID
+   * in usage events
+   */
+  ingest_aliases: Array<string>;
+
+  name: string;
+
+  custom_fields?: Record<string, string>;
+}
+
+export interface CustomerDetail {
+  /**
+   * the Metronome ID of the customer
+   */
+  id: string;
+
+  current_billable_status: CustomerDetail.CurrentBillableStatus;
+
+  custom_fields: Record<string, string>;
+
+  customer_config: CustomerDetail.CustomerConfig;
+
+  /**
+   * (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+   * alias) that can be used in usage events
+   */
+  external_id: string;
+
+  /**
+   * aliases for this customer that can be used instead of the Metronome customer ID
+   * in usage events
+   */
+  ingest_aliases: Array<string>;
+
+  name: string;
+}
+
+export namespace CustomerDetail {
+  export interface CurrentBillableStatus {
+    value: 'billable' | 'unbillable';
+
+    effective_at?: string | null;
+  }
+
+  export interface CustomerConfig {
+    /**
+     * The Salesforce account ID for the customer
+     */
+    salesforce_account_id: string | null;
+  }
+}
+
+export interface CustomerCreateResponse {
+  data: Customer;
+}
+
+export interface CustomerRetrieveResponse {
+  data: CustomerDetail;
+}
+
+export interface CustomerListResponse {
+  data: Array<CustomerDetail>;
+
+  next_page: string | null;
+}
+
+export interface CustomerArchiveResponse {
+  data: Shared.ID;
+}
+
+export interface CustomerListBillableMetricsResponse {
+  data: Array<CustomerListBillableMetricsResponse.Data>;
+
+  next_page: string | null;
+}
+
+export namespace CustomerListBillableMetricsResponse {
+  export interface Data {
+    id: string;
+
+    name: string;
+
+    group_by?: Array<string>;
+  }
+}
+
+export interface CustomerListCostsResponse {
+  data: Array<CustomerListCostsResponse.Data>;
+
+  next_page: string | null;
+}
+
+export namespace CustomerListCostsResponse {
+  export interface Data {
+    credit_types: Record<string, Data.CreditTypes>;
+
+    end_timestamp: string;
+
+    start_timestamp: string;
+  }
+
+  export namespace Data {
+    export interface CreditTypes {
+      cost?: number;
+
+      line_item_breakdown?: Array<CreditTypes.LineItemBreakdown>;
+
+      name?: string;
+    }
+
+    export namespace CreditTypes {
+      export interface LineItemBreakdown {
+        cost: number;
+
+        name: string;
+
+        group_key?: string;
+
+        group_value?: string | null;
+      }
+    }
+  }
+}
+
+export interface CustomerSetNameResponse {
+  data: Customer;
+}
+
+export interface CustomerCreateParams {
+  name: string;
+
+  billing_config?: CustomerCreateParams.BillingConfig;
+
+  custom_fields?: Record<string, string>;
+
+  /**
+   * (deprecated, use ingest_aliases instead) the first ID (Metronome ID or ingest
+   * alias) that can be used in usage events
+   */
+  external_id?: string;
+
+  /**
+   * Aliases that can be used to refer to this customer in usage events
+   */
+  ingest_aliases?: Array<string>;
+}
+
+export namespace CustomerCreateParams {
+  export interface BillingConfig {
+    billing_provider_customer_id: string;
+
+    billing_provider_type:
+      | 'aws_marketplace'
+      | 'stripe'
+      | 'netsuite'
+      | 'custom'
+      | 'azure_marketplace'
+      | 'quickbooks_online'
+      | 'workday'
+      | 'gcp_marketplace';
+
+    aws_product_code?: string;
+
+    aws_region?:
+      | 'af-south-1'
+      | 'ap-east-1'
+      | 'ap-northeast-1'
+      | 'ap-northeast-2'
+      | 'ap-northeast-3'
+      | 'ap-south-1'
+      | 'ap-southeast-1'
+      | 'ap-southeast-2'
+      | 'ca-central-1'
+      | 'cn-north-1'
+      | 'cn-northwest-1'
+      | 'eu-central-1'
+      | 'eu-north-1'
+      | 'eu-south-1'
+      | 'eu-west-1'
+      | 'eu-west-2'
+      | 'eu-west-3'
+      | 'me-south-1'
+      | 'sa-east-1'
+      | 'us-east-1'
+      | 'us-east-2'
+      | 'us-gov-east-1'
+      | 'us-gov-west-1'
+      | 'us-west-1'
+      | 'us-west-2';
+
+    stripe_collection_method?: 'charge_automatically' | 'send_invoice';
+  }
+}
+
+export interface CustomerListParams {
+  /**
+   * Filter the customer list by customer_id. Up to 100 ids can be provided.
+   */
+  customer_ids?: Array<string>;
+
+  /**
+   * Filter the customer list by ingest_alias
+   */
+  ingest_alias?: string;
+
+  /**
+   * Max number of results that should be returned
+   */
+  limit?: number;
+
+  /**
+   * Cursor that indicates where the next page of results should start.
+   */
+  next_page?: string;
+
+  /**
+   * Filter the customer list by only archived customers.
+   */
+  only_archived?: boolean;
+
+  /**
+   * Filter the customer list by salesforce_account_id. Up to 100 ids can be
+   * provided.
+   */
+  salesforce_account_ids?: Array<string>;
+}
+
+export interface CustomerArchiveParams {
+  id: string;
+}
+
+export interface CustomerListBillableMetricsParams {
+  /**
+   * Max number of results that should be returned
+   */
+  limit?: number;
+
+  /**
+   * Cursor that indicates where the next page of results should start.
+   */
+  next_page?: string;
+
+  /**
+   * If true, the list of metrics will be filtered to just ones that are on the
+   * customer's current plan
+   */
+  on_current_plan?: boolean;
+}
+
+export interface CustomerListCostsParams {
+  /**
+   * RFC 3339 timestamp (exclusive)
+   */
+  ending_before: string;
+
+  /**
+   * RFC 3339 timestamp (inclusive)
+   */
+  starting_on: string;
+
+  /**
+   * Max number of results that should be returned
+   */
+  limit?: number;
+
+  /**
+   * Cursor that indicates where the next page of results should start.
+   */
+  next_page?: string;
+}
+
+export interface CustomerSetIngestAliasesParams {
+  ingest_aliases: Array<string>;
+}
+
+export interface CustomerSetNameParams {
+  /**
+   * The new name for the customer
+   */
+  name: string;
+}
+
+export interface CustomerUpdateConfigParams {
+  /**
+   * Leave in draft or set to auto-advance on invoices sent to Stripe. Falls back to
+   * the client-level config if unset, which defaults to true if unset.
+   */
+  leave_stripe_invoices_in_draft?: boolean | null;
+
+  /**
+   * The Salesforce account ID for the customer
+   */
+  salesforce_account_id?: string | null;
+}
+
+export namespace Customers {
+  export import Customer = CustomersAPI.Customer;
+  export import CustomerDetail = CustomersAPI.CustomerDetail;
+  export import CustomerCreateResponse = CustomersAPI.CustomerCreateResponse;
+  export import CustomerRetrieveResponse = CustomersAPI.CustomerRetrieveResponse;
+  export import CustomerListResponse = CustomersAPI.CustomerListResponse;
+  export import CustomerArchiveResponse = CustomersAPI.CustomerArchiveResponse;
+  export import CustomerListBillableMetricsResponse = CustomersAPI.CustomerListBillableMetricsResponse;
+  export import CustomerListCostsResponse = CustomersAPI.CustomerListCostsResponse;
+  export import CustomerSetNameResponse = CustomersAPI.CustomerSetNameResponse;
+  export import CustomerCreateParams = CustomersAPI.CustomerCreateParams;
+  export import CustomerListParams = CustomersAPI.CustomerListParams;
+  export import CustomerArchiveParams = CustomersAPI.CustomerArchiveParams;
+  export import CustomerListBillableMetricsParams = CustomersAPI.CustomerListBillableMetricsParams;
+  export import CustomerListCostsParams = CustomersAPI.CustomerListCostsParams;
+  export import CustomerSetIngestAliasesParams = CustomersAPI.CustomerSetIngestAliasesParams;
+  export import CustomerSetNameParams = CustomersAPI.CustomerSetNameParams;
+  export import CustomerUpdateConfigParams = CustomersAPI.CustomerUpdateConfigParams;
+  export import Alerts = AlertsAPI.Alerts;
+  export import CustomerAlert = AlertsAPI.CustomerAlert;
+  export import AlertRetrieveResponse = AlertsAPI.AlertRetrieveResponse;
+  export import AlertListResponse = AlertsAPI.AlertListResponse;
+  export import AlertRetrieveParams = AlertsAPI.AlertRetrieveParams;
+  export import AlertListParams = AlertsAPI.AlertListParams;
+  export import AlertResetParams = AlertsAPI.AlertResetParams;
+  export import Plans = PlansAPI.Plans;
+  export import PlanListResponse = PlansAPI.PlanListResponse;
+  export import PlanAddResponse = PlansAPI.PlanAddResponse;
+  export import PlanEndResponse = PlansAPI.PlanEndResponse;
+  export import PlanListPriceAdjustmentsResponse = PlansAPI.PlanListPriceAdjustmentsResponse;
+  export import PlanListParams = PlansAPI.PlanListParams;
+  export import PlanAddParams = PlansAPI.PlanAddParams;
+  export import PlanEndParams = PlansAPI.PlanEndParams;
+  export import PlanListPriceAdjustmentsParams = PlansAPI.PlanListPriceAdjustmentsParams;
+  export import Invoices = InvoicesAPI.Invoices;
+  export import Invoice = InvoicesAPI.Invoice;
+  export import InvoiceRetrieveResponse = InvoicesAPI.InvoiceRetrieveResponse;
+  export import InvoiceListResponse = InvoicesAPI.InvoiceListResponse;
+  export import InvoiceAddChargeResponse = InvoicesAPI.InvoiceAddChargeResponse;
+  export import InvoiceRetrieveParams = InvoicesAPI.InvoiceRetrieveParams;
+  export import InvoiceListParams = InvoicesAPI.InvoiceListParams;
+  export import InvoiceAddChargeParams = InvoicesAPI.InvoiceAddChargeParams;
+  export import BillingConfig = BillingConfigAPI.BillingConfig;
+  export import BillingConfigRetrieveResponse = BillingConfigAPI.BillingConfigRetrieveResponse;
+  export import BillingConfigCreateParams = BillingConfigAPI.BillingConfigCreateParams;
+}

package/src/resources/customers/index.ts

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { BillingConfigRetrieveResponse, BillingConfigCreateParams, BillingConfig } from './billing-config';
+export {
+  Customer,
+  CustomerDetail,
+  CustomerCreateResponse,
+  CustomerRetrieveResponse,
+  CustomerListResponse,
+  CustomerArchiveResponse,
+  CustomerListBillableMetricsResponse,
+  CustomerListCostsResponse,
+  CustomerSetNameResponse,
+  CustomerCreateParams,
+  CustomerListParams,
+  CustomerArchiveParams,
+  CustomerListBillableMetricsParams,
+  CustomerListCostsParams,
+  CustomerSetIngestAliasesParams,
+  CustomerSetNameParams,
+  CustomerUpdateConfigParams,
+  Customers,
+} from './customers';
+export {
+  CustomerAlert,
+  AlertRetrieveResponse,
+  AlertListResponse,
+  AlertRetrieveParams,
+  AlertListParams,
+  AlertResetParams,
+  Alerts,
+} from './alerts';
+export {
+  Invoice,
+  InvoiceRetrieveResponse,
+  InvoiceListResponse,
+  InvoiceAddChargeResponse,
+  InvoiceRetrieveParams,
+  InvoiceListParams,
+  InvoiceAddChargeParams,
+  Invoices,
+} from './invoices';
+export {
+  PlanListResponse,
+  PlanAddResponse,
+  PlanEndResponse,
+  PlanListPriceAdjustmentsResponse,
+  PlanListParams,
+  PlanAddParams,
+  PlanEndParams,
+  PlanListPriceAdjustmentsParams,
+  Plans,
+} from './plans';