@metronome/sdk 0.1.0-alpha.0

package/src/resources/custom-fields.ts

@@ -0,0 +1,242 @@
+// 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 CustomFieldsAPI from "./custom-fields";
+
+export class CustomFields extends APIResource {
+  /**
+   * Add a key to the allow list for a given entity. There is a 100 character limit
+   * on custom field keys.
+   */
+  addKey(body: CustomFieldAddKeyParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.post('/customFields/addKey', {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Deletes one or more custom fields on an instance of a Metronome entity.
+   */
+  deleteValues(body: CustomFieldDeleteValuesParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.post('/customFields/deleteValues', {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * List all active custom field keys, optionally filtered by entity type.
+   */
+  listKeys(
+    params?: CustomFieldListKeysParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomFieldListKeysResponse>;
+  listKeys(options?: Core.RequestOptions): Core.APIPromise<CustomFieldListKeysResponse>;
+  listKeys(
+    params: CustomFieldListKeysParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CustomFieldListKeysResponse> {
+    if (isRequestOptions(params)) {
+      return this.listKeys({}, params);
+    }
+    const { next_page, ...body } = params;
+    return this._client.post('/customFields/listKeys', { query: { next_page }, body, ...options });
+  }
+
+  /**
+   * Remove a key from the allow list for a given entity.
+   */
+  removeKey(body: CustomFieldRemoveKeyParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.post('/customFields/removeKey', {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Sets one or more custom fields on an instance of a Metronome entity. If a
+   * key/value pair passed in this request matches one already set on the entity, its
+   * value will be overwritten. Any key/value pairs that exist on the entity that do
+   * not match those passed in this request will remain untouched. This endpoint is
+   * transactional and will update all key/value pairs or no key/value pairs. Partial
+   * updates are not supported. There is a 200 character limit on custom field
+   * values.
+   */
+  setValues(body: CustomFieldSetValuesParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.post('/customFields/setValues', {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}
+
+export interface CustomFieldListKeysResponse {
+  data: Array<CustomFieldListKeysResponse.Data>;
+
+  next_page: string | null;
+}
+
+export namespace CustomFieldListKeysResponse {
+  export interface Data {
+    enforce_uniqueness: boolean;
+
+    entity:
+      | 'alert'
+      | 'billable_metric'
+      | 'charge'
+      | 'commit'
+      | 'contract_credit'
+      | 'contract_product'
+      | 'contract'
+      | 'credit_grant'
+      | 'customer_plan'
+      | 'customer'
+      | 'invoice'
+      | 'plan'
+      | 'professional_service'
+      | 'product'
+      | 'rate_card'
+      | 'scheduled_charge';
+
+    key: string;
+  }
+}
+
+export interface CustomFieldAddKeyParams {
+  enforce_uniqueness: boolean;
+
+  entity:
+    | 'alert'
+    | 'billable_metric'
+    | 'charge'
+    | 'commit'
+    | 'contract_credit'
+    | 'contract_product'
+    | 'contract'
+    | 'credit_grant'
+    | 'customer_plan'
+    | 'customer'
+    | 'invoice'
+    | 'plan'
+    | 'professional_service'
+    | 'product'
+    | 'rate_card'
+    | 'scheduled_charge';
+
+  key: string;
+}
+
+export interface CustomFieldDeleteValuesParams {
+  entity:
+    | 'alert'
+    | 'billable_metric'
+    | 'charge'
+    | 'commit'
+    | 'contract_credit'
+    | 'contract_product'
+    | 'contract'
+    | 'credit_grant'
+    | 'customer_plan'
+    | 'customer'
+    | 'invoice'
+    | 'plan'
+    | 'professional_service'
+    | 'product'
+    | 'rate_card'
+    | 'scheduled_charge';
+
+  entity_id: string;
+
+  keys: Array<string>;
+}
+
+export interface CustomFieldListKeysParams {
+  /**
+   * Query param: Cursor that indicates where the next page of results should start.
+   */
+  next_page?: string;
+
+  /**
+   * Body param: Optional list of entity types to return keys for
+   */
+  entities?: Array<
+    | 'alert'
+    | 'billable_metric'
+    | 'charge'
+    | 'commit'
+    | 'contract_credit'
+    | 'contract_product'
+    | 'contract'
+    | 'credit_grant'
+    | 'customer_plan'
+    | 'customer'
+    | 'invoice'
+    | 'plan'
+    | 'professional_service'
+    | 'product'
+    | 'rate_card'
+    | 'scheduled_charge'
+  >;
+}
+
+export interface CustomFieldRemoveKeyParams {
+  entity:
+    | 'alert'
+    | 'billable_metric'
+    | 'charge'
+    | 'commit'
+    | 'contract_credit'
+    | 'contract_product'
+    | 'contract'
+    | 'credit_grant'
+    | 'customer_plan'
+    | 'customer'
+    | 'invoice'
+    | 'plan'
+    | 'professional_service'
+    | 'product'
+    | 'rate_card'
+    | 'scheduled_charge';
+
+  key: string;
+}
+
+export interface CustomFieldSetValuesParams {
+  custom_fields: Record<string, string>;
+
+  entity:
+    | 'alert'
+    | 'billable_metric'
+    | 'charge'
+    | 'commit'
+    | 'contract_credit'
+    | 'contract_product'
+    | 'contract'
+    | 'credit_grant'
+    | 'customer_plan'
+    | 'customer'
+    | 'invoice'
+    | 'plan'
+    | 'professional_service'
+    | 'product'
+    | 'rate_card'
+    | 'scheduled_charge';
+
+  entity_id: string;
+}
+
+export namespace CustomFields {
+  export import CustomFieldListKeysResponse = CustomFieldsAPI.CustomFieldListKeysResponse;
+  export import CustomFieldAddKeyParams = CustomFieldsAPI.CustomFieldAddKeyParams;
+  export import CustomFieldDeleteValuesParams = CustomFieldsAPI.CustomFieldDeleteValuesParams;
+  export import CustomFieldListKeysParams = CustomFieldsAPI.CustomFieldListKeysParams;
+  export import CustomFieldRemoveKeyParams = CustomFieldsAPI.CustomFieldRemoveKeyParams;
+  export import CustomFieldSetValuesParams = CustomFieldsAPI.CustomFieldSetValuesParams;
+}

package/src/resources/customers/alerts.ts

@@ -0,0 +1,214 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as AlertsAPI from "./alerts";
+import * as Shared from "../shared";
+
+export class Alerts extends APIResource {
+  /**
+   * Get the customer alert status and alert information for the specified customer
+   * and alert
+   */
+  retrieve(body: AlertRetrieveParams, options?: Core.RequestOptions): Core.APIPromise<AlertRetrieveResponse> {
+    return this._client.post('/customer-alerts/get', { body, ...options });
+  }
+
+  /**
+   * Fetch all customer alert statuses and alert information for a customer
+   */
+  list(params: AlertListParams, options?: Core.RequestOptions): Core.APIPromise<AlertListResponse> {
+    const { next_page, ...body } = params;
+    return this._client.post('/customer-alerts/list', { query: { next_page }, body, ...options });
+  }
+
+  /**
+   * Reset state for an alert by customer id and force re-evaluation
+   */
+  reset(body: AlertResetParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.post('/customer-alerts/reset', {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}
+
+export interface CustomerAlert {
+  alert: CustomerAlert.Alert;
+
+  /**
+   * The status of the customer alert. If the alert is archived, null will be
+   * returned.
+   */
+  customer_status: 'ok' | 'in_alarm' | 'evaluating' | null;
+
+  /**
+   * If present, indicates the reason the alert was triggered.
+   */
+  triggered_by?: string | null;
+}
+
+export namespace CustomerAlert {
+  export interface Alert {
+    /**
+     * the Metronome ID of the alert
+     */
+    id: string;
+
+    /**
+     * Name of the alert
+     */
+    name: string;
+
+    /**
+     * Status of the alert
+     */
+    status: 'enabled' | 'archived' | 'disabled';
+
+    /**
+     * Threshold value of the alert policy
+     */
+    threshold: number;
+
+    /**
+     * Type of the alert
+     */
+    type:
+      | 'low_credit_balance_reached'
+      | 'spend_threshold_reached'
+      | 'monthly_invoice_total_spend_threshold_reached'
+      | 'low_remaining_days_in_plan_reached'
+      | 'low_remaining_credit_percentage_reached'
+      | 'usage_threshold_reached'
+      | 'low_remaining_days_for_commit_segment_reached'
+      | 'low_remaining_commit_balance_reached'
+      | 'low_remaining_commit_percentage_reached'
+      | 'low_remaining_days_for_contract_credit_segment_reached'
+      | 'low_remaining_contract_credit_balance_reached'
+      | 'low_remaining_contract_credit_percentage_reached'
+      | 'invoice_total_reached';
+
+    /**
+     * Timestamp for when the alert was last updated
+     */
+    updated_at: string;
+
+    credit_type?: Shared.CreditType | null;
+
+    /**
+     * A list of custom field filters for alert types that support advanced filtering
+     */
+    custom_field_filters?: Array<Alert.CustomFieldFilter>;
+
+    /**
+     * Scopes alert evaluation to a specific presentation group key on individual line
+     * items. Only present for spend alerts.
+     */
+    group_key_filter?: Alert.GroupKeyFilter;
+
+    /**
+     * Only supported for invoice_total_reached alerts. A list of invoice types to
+     * evaluate.
+     */
+    invoice_types_filter?: Array<string>;
+
+    /**
+     * Prevents the creation of duplicates. If a request to create a record is made
+     * with a previously used uniqueness key, a new record will not be created and the
+     * request will fail with a 409 error.
+     */
+    uniqueness_key?: string;
+  }
+
+  export namespace Alert {
+    export interface CustomFieldFilter {
+      entity: 'Contract' | 'Commit' | 'ContractCredit';
+
+      key: string;
+
+      value: string;
+    }
+
+    /**
+     * Scopes alert evaluation to a specific presentation group key on individual line
+     * items. Only present for spend alerts.
+     */
+    export interface GroupKeyFilter {
+      key: string;
+
+      value: string;
+    }
+  }
+}
+
+export interface AlertRetrieveResponse {
+  data: CustomerAlert;
+}
+
+export interface AlertListResponse {
+  data: Array<CustomerAlert>;
+
+  next_page: string | null;
+}
+
+export interface AlertRetrieveParams {
+  /**
+   * The Metronome ID of the alert
+   */
+  alert_id: string;
+
+  /**
+   * The Metronome ID of the customer
+   */
+  customer_id: string;
+}
+
+export interface AlertListParams {
+  /**
+   * Body param: The Metronome ID of the customer
+   */
+  customer_id: string;
+
+  /**
+   * Query param: Cursor that indicates where the next page of results should start.
+   */
+  next_page?: string;
+
+  /**
+   * Body param: Optionally filter by alert status. If absent, only enabled alerts
+   * will be returned.
+   */
+  alert_statuses?: Array<
+    | 'enabled'
+    | 'disabled'
+    | 'archived'
+    | 'ENABLED'
+    | 'DISABLED'
+    | 'ARCHIVED'
+    | 'Enabled'
+    | 'Disabled'
+    | 'Archived'
+  >;
+}
+
+export interface AlertResetParams {
+  /**
+   * The Metronome ID of the alert
+   */
+  alert_id: string;
+
+  /**
+   * The Metronome ID of the customer
+   */
+  customer_id: string;
+}
+
+export namespace 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;
+}

package/src/resources/customers/billing-config.ts

@@ -0,0 +1,183 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from "../../core";
+import { APIResource } from "../../resource";
+import * as BillingConfigAPI from "./billing-config";
+
+export class BillingConfig extends APIResource {
+  /**
+   * Set the billing configuration for a given customer.
+   */
+  create(
+    customerId: string,
+    billingProviderType:
+      | 'aws_marketplace'
+      | 'stripe'
+      | 'netsuite'
+      | 'custom'
+      | 'azure_marketplace'
+      | 'quickbooks_online'
+      | 'workday'
+      | 'gcp_marketplace',
+    body: BillingConfigCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<void> {
+    return this._client.post(`/customers/${customerId}/billing-config/${billingProviderType}`, {
+      body,
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Fetch the billing configuration for the given customer.
+   */
+  retrieve(
+    customerId: string,
+    billingProviderType:
+      | 'aws_marketplace'
+      | 'stripe'
+      | 'netsuite'
+      | 'custom'
+      | 'azure_marketplace'
+      | 'quickbooks_online'
+      | 'workday'
+      | 'gcp_marketplace',
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<BillingConfigRetrieveResponse> {
+    return this._client.get(`/customers/${customerId}/billing-config/${billingProviderType}`, options);
+  }
+
+  /**
+   * Delete the billing configuration for a given customer. Note: this is unsupported
+   * for Azure and AWS Marketplace customers.
+   */
+  delete(
+    customerId: string,
+    billingProviderType:
+      | 'aws_marketplace'
+      | 'stripe'
+      | 'netsuite'
+      | 'custom'
+      | 'azure_marketplace'
+      | 'quickbooks_online'
+      | 'workday'
+      | 'gcp_marketplace',
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<void> {
+    return this._client.delete(`/customers/${customerId}/billing-config/${billingProviderType}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+}
+
+export interface BillingConfigRetrieveResponse {
+  data: BillingConfigRetrieveResponse.Data;
+}
+
+export namespace BillingConfigRetrieveResponse {
+  export interface Data {
+    /**
+     * Contract expiration date for the customer. The expected format is RFC 3339 and
+     * can be retrieved from AWS's GetEntitlements API. (See
+     * https://docs.aws.amazon.com/marketplaceentitlement/latest/APIReference/API_GetEntitlements.html.)
+     */
+    aws_expiration_date?: string;
+
+    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';
+
+    /**
+     * Subscription term start/end date for the customer. The expected format is RFC
+     * 3339 and can be retrieved from Azure's Get Subscription API. (See
+     * https://learn.microsoft.com/en-us/partner-center/marketplace/partner-center-portal/pc-saas-fulfillment-subscription-api#get-subscription.)
+     */
+    azure_expiration_date?: string;
+
+    azure_plan_id?: string;
+
+    /**
+     * Subscription term start/end date for the customer. The expected format is RFC
+     * 3339 and can be retrieved from Azure's Get Subscription API. (See
+     * https://learn.microsoft.com/en-us/partner-center/marketplace/partner-center-portal/pc-saas-fulfillment-subscription-api#get-subscription.)
+     */
+    azure_start_date?: string;
+
+    azure_subscription_status?: 'Subscribed' | 'Unsubscribed' | 'Suspended' | 'PendingFulfillmentStart';
+
+    billing_provider_customer_id?: string;
+
+    stripe_collection_method?: 'charge_automatically' | 'send_invoice';
+  }
+}
+
+export interface BillingConfigCreateParams {
+  /**
+   * The customer ID in the billing provider's system. For Azure, this is the
+   * subscription ID.
+   */
+  billing_provider_customer_id: string;
+
+  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 namespace BillingConfig {
+  export import BillingConfigRetrieveResponse = BillingConfigAPI.BillingConfigRetrieveResponse;
+  export import BillingConfigCreateParams = BillingConfigAPI.BillingConfigCreateParams;
+}