@metronome/mcp 0.1.0-beta.11

package/src/tools/v1/custom-fields/set-values-v1-custom-fields.ts

@@ -0,0 +1,61 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../';
+import Metronome from '@metronome/sdk';
+
+export const metadata: Metadata = {
+  resource: 'v1.custom_fields',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/customFields/setValues',
+  operationId: 'setCustomFields-v1',
+};
+
+export const tool: Tool = {
+  name: 'set_values_v1_custom_fields',
+  description:
+    '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.\n',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      custom_fields: {
+        type: 'object',
+      },
+      entity: {
+        type: 'string',
+        enum: [
+          'alert',
+          'billable_metric',
+          'charge',
+          'commit',
+          'contract_credit',
+          'contract_product',
+          'contract',
+          'credit_grant',
+          'customer_plan',
+          'customer',
+          'discount',
+          'invoice',
+          'plan',
+          'professional_service',
+          'product',
+          'rate_card',
+          'scheduled_charge',
+          'subscription',
+        ],
+      },
+      entity_id: {
+        type: 'string',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customFields.setValues(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/alerts/list-customers-v1-alerts.ts

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../../';
+import Metronome from '@metronome/sdk';
+
+export const metadata: Metadata = {
+  resource: 'v1.customers.alerts',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/customer-alerts/list',
+  operationId: 'listCustomerAlerts-v1',
+};
+
+export const tool: Tool = {
+  name: 'list_customers_v1_alerts',
+  description: 'Fetch all customer alert statuses and alert information for a customer',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+        description: 'The Metronome ID of the customer',
+      },
+      next_page: {
+        type: 'string',
+        description: 'Cursor that indicates where the next page of results should start.',
+      },
+      alert_statuses: {
+        type: 'array',
+        description: 'Optionally filter by alert status. If absent, only enabled alerts will be returned.',
+        items: {
+          type: 'string',
+          enum: ['ENABLED', 'DISABLED', 'ARCHIVED'],
+        },
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.alerts.list(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/alerts/reset-customers-v1-alerts.ts

@@ -0,0 +1,39 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../../';
+import Metronome from '@metronome/sdk';
+
+export const metadata: Metadata = {
+  resource: 'v1.customers.alerts',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/customer-alerts/reset',
+  operationId: 'resetCustomerAlerts-v1',
+};
+
+export const tool: Tool = {
+  name: 'reset_customers_v1_alerts',
+  description: 'Reset state for an alert by customer id and force re-evaluation',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      alert_id: {
+        type: 'string',
+        description: 'The Metronome ID of the alert',
+      },
+      customer_id: {
+        type: 'string',
+        description: 'The Metronome ID of the customer',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.alerts.reset(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/alerts/retrieve-customers-v1-alerts.ts

@@ -0,0 +1,45 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../../';
+import Metronome from '@metronome/sdk';
+
+export const metadata: Metadata = {
+  resource: 'v1.customers.alerts',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/customer-alerts/get',
+  operationId: 'getCustomerAlert-v1',
+};
+
+export const tool: Tool = {
+  name: 'retrieve_customers_v1_alerts',
+  description: 'Get the customer alert status and alert information for the specified customer and alert',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      alert_id: {
+        type: 'string',
+        description: 'The Metronome ID of the alert',
+      },
+      customer_id: {
+        type: 'string',
+        description: 'The Metronome ID of the customer',
+      },
+      plans_or_contracts: {
+        type: 'string',
+        description:
+          'When parallel alerts are enabled during migration, this flag denotes whether to fetch alerts for plans or contracts.',
+        enum: ['PLANS', 'CONTRACTS'],
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.alerts.retrieve(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/archive-v1-customers.ts

@@ -0,0 +1,34 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../';
+import Metronome from '@metronome/sdk';
+
+export const metadata: Metadata = {
+  resource: 'v1.customers',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/customers/archive',
+  operationId: 'archiveCustomer-v1',
+};
+
+export const tool: Tool = {
+  name: 'archive_v1_customers',
+  description: 'Archive a customer',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      id: {
+        type: 'string',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.archive(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/billing-config/create-customers-v1-billing-config.ts

@@ -0,0 +1,89 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../../';
+import Metronome from '@metronome/sdk';
+
+export const metadata: Metadata = {
+  resource: 'v1.customers.billing_config',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/customers/{customer_id}/billing-config/{billing_provider_type}',
+  operationId: 'setBillingConfigForCustomer-v1',
+};
+
+export const tool: Tool = {
+  name: 'create_customers_v1_billing_config',
+  description: 'Set the billing configuration for a given customer.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      billing_provider_type: {
+        type: 'string',
+        enum: [
+          'aws_marketplace',
+          'stripe',
+          'netsuite',
+          'custom',
+          'azure_marketplace',
+          'quickbooks_online',
+          'workday',
+          'gcp_marketplace',
+        ],
+      },
+      billing_provider_customer_id: {
+        type: 'string',
+        description:
+          "The customer ID in the billing provider's system. For Azure, this is the subscription ID.",
+      },
+      aws_product_code: {
+        type: 'string',
+      },
+      aws_region: {
+        type: 'string',
+        enum: [
+          '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: {
+        type: 'string',
+        enum: ['charge_automatically', 'send_invoice'],
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.billingConfig.create(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/billing-config/delete-customers-v1-billing-config.ts

@@ -0,0 +1,48 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../../';
+import Metronome from '@metronome/sdk';
+
+export const metadata: Metadata = {
+  resource: 'v1.customers.billing_config',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'delete',
+  httpPath: '/v1/customers/{customer_id}/billing-config/{billing_provider_type}',
+  operationId: 'deleteBillingConfigForCustomer-v1',
+};
+
+export const tool: Tool = {
+  name: 'delete_customers_v1_billing_config',
+  description:
+    'Delete the billing configuration for a given customer. Note: this is unsupported for Azure and AWS Marketplace customers.\n',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      billing_provider_type: {
+        type: 'string',
+        enum: [
+          'aws_marketplace',
+          'stripe',
+          'netsuite',
+          'custom',
+          'azure_marketplace',
+          'quickbooks_online',
+          'workday',
+          'gcp_marketplace',
+        ],
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.billingConfig.delete(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/billing-config/retrieve-customers-v1-billing-config.ts

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../../';
+import Metronome from '@metronome/sdk';
+
+export const metadata: Metadata = {
+  resource: 'v1.customers.billing_config',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/v1/customers/{customer_id}/billing-config/{billing_provider_type}',
+  operationId: 'getBillingConfig-v1',
+};
+
+export const tool: Tool = {
+  name: 'retrieve_customers_v1_billing_config',
+  description: 'Fetch the billing configuration for the given customer.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      billing_provider_type: {
+        type: 'string',
+        enum: [
+          'aws_marketplace',
+          'stripe',
+          'netsuite',
+          'custom',
+          'azure_marketplace',
+          'quickbooks_online',
+          'workday',
+          'gcp_marketplace',
+        ],
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.billingConfig.retrieve(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/commits/create-customers-v1-commits.ts

@@ -0,0 +1,251 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import type { Metadata } from '../../../';
+import Metronome from '@metronome/sdk';
+
+export const metadata: Metadata = {
+  resource: 'v1.customers.commits',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/contracts/customerCommits/create',
+  operationId: 'createCustomerCommit-v1',
+};
+
+export const tool: Tool = {
+  name: 'create_customers_v1_commits',
+  description: 'Create a new commit at the customer level.\n',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      access_schedule: {
+        type: 'object',
+        description:
+          'Schedule for distributing the commit to the customer. For "POSTPAID" commits only one schedule item is allowed and amount must match invoice_schedule total.',
+        properties: {
+          schedule_items: {
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                amount: {
+                  type: 'number',
+                },
+                ending_before: {
+                  type: 'string',
+                  description: 'RFC 3339 timestamp (exclusive)',
+                  format: 'date-time',
+                },
+                starting_at: {
+                  type: 'string',
+                  description: 'RFC 3339 timestamp (inclusive)',
+                  format: 'date-time',
+                },
+              },
+              required: ['amount', 'ending_before', 'starting_at'],
+            },
+          },
+          credit_type_id: {
+            type: 'string',
+            description: 'Defaults to USD (cents) if not passed',
+          },
+        },
+        required: ['schedule_items'],
+      },
+      customer_id: {
+        type: 'string',
+      },
+      priority: {
+        type: 'number',
+        description:
+          'If multiple credits or commits are applicable, the one with the lower priority will apply first.',
+      },
+      product_id: {
+        type: 'string',
+        description:
+          'ID of the fixed product associated with the commit. This is required because products are used to invoice the commit amount.',
+      },
+      type: {
+        type: 'string',
+        enum: ['PREPAID', 'POSTPAID'],
+      },
+      applicable_contract_ids: {
+        type: 'array',
+        description:
+          'Which contract the commit applies to. If not provided, the commit applies to all contracts.',
+        items: {
+          type: 'string',
+        },
+      },
+      applicable_product_ids: {
+        type: 'array',
+        description:
+          'Which products the commit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the commit applies to all products.',
+        items: {
+          type: 'string',
+        },
+      },
+      applicable_product_tags: {
+        type: 'array',
+        description:
+          'Which tags the commit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the commit applies to all products.',
+        items: {
+          type: 'string',
+        },
+      },
+      custom_fields: {
+        type: 'object',
+      },
+      description: {
+        type: 'string',
+        description: 'Used only in UI/API. It is not exposed to end customers.',
+      },
+      invoice_contract_id: {
+        type: 'string',
+        description:
+          'The contract that this commit will be billed on. This is required for "POSTPAID" commits and for "PREPAID" commits unless there is no invoice schedule above (i.e., the commit is \'free\').',
+      },
+      invoice_schedule: {
+        type: 'object',
+        description:
+          'Required for "POSTPAID" commits: the true up invoice will be generated at this time and only one schedule item is allowed; the total must match accesss_schedule amount. Optional for "PREPAID" commits: if not provided, this will be a "complimentary" commit with no invoice.',
+        properties: {
+          credit_type_id: {
+            type: 'string',
+            description: 'Defaults to USD (cents) if not passed.',
+          },
+          recurring_schedule: {
+            type: 'object',
+            description:
+              '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 quantity is inferred to be 1.',
+            properties: {
+              amount_distribution: {
+                type: 'string',
+                enum: ['DIVIDED', 'DIVIDED_ROUNDED', 'EACH'],
+              },
+              ending_before: {
+                type: 'string',
+                description: 'RFC 3339 timestamp (exclusive).',
+                format: 'date-time',
+              },
+              frequency: {
+                type: 'string',
+                enum: ['MONTHLY', 'QUARTERLY', 'SEMI_ANNUAL', 'ANNUAL'],
+              },
+              starting_at: {
+                type: 'string',
+                description: 'RFC 3339 timestamp (inclusive).',
+                format: 'date-time',
+              },
+              amount: {
+                type: 'number',
+                description:
+                  'Amount for the charge. Can be provided instead of unit_price and quantity. If amount is sent, the unit_price is assumed to be the amount and quantity is inferred to be 1.',
+              },
+              quantity: {
+                type: 'number',
+                description:
+                  'Quantity for the charge. Will be multiplied by unit_price to determine the amount and must be specified with unit_price. If specified amount cannot be provided.',
+              },
+              unit_price: {
+                type: 'number',
+                description:
+                  'Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified with quantity. If specified amount cannot be provided.',
+              },
+            },
+            required: ['amount_distribution', 'ending_before', 'frequency', 'starting_at'],
+          },
+          schedule_items: {
+            type: 'array',
+            description: 'Either provide amount or provide both unit_price and quantity.',
+            items: {
+              type: 'object',
+              properties: {
+                timestamp: {
+                  type: 'string',
+                  description: 'timestamp of the scheduled event',
+                  format: 'date-time',
+                },
+                amount: {
+                  type: 'number',
+                  description:
+                    'Amount for the charge. Can be provided instead of unit_price and quantity. If amount is sent, the unit_price is assumed to be the amount and quantity is inferred to be 1.',
+                },
+                quantity: {
+                  type: 'number',
+                  description:
+                    'Quantity for the charge. Will be multiplied by unit_price to determine the amount and must be specified with unit_price. If specified amount cannot be provided.',
+                },
+                unit_price: {
+                  type: 'number',
+                  description:
+                    'Unit price for the charge. Will be multiplied by quantity to determine the amount and must be specified with quantity. If specified amount cannot be provided.',
+                },
+              },
+              required: ['timestamp'],
+            },
+          },
+        },
+        required: [],
+      },
+      name: {
+        type: 'string',
+        description: 'displayed on invoices',
+      },
+      netsuite_sales_order_id: {
+        type: 'string',
+        description: "This field's availability is dependent on your client's configuration.",
+      },
+      rate_type: {
+        type: 'string',
+        enum: ['COMMIT_RATE', 'LIST_RATE'],
+      },
+      salesforce_opportunity_id: {
+        type: 'string',
+        description: "This field's availability is dependent on your client's configuration.",
+      },
+      specifiers: {
+        type: 'array',
+        description:
+          "List of filters that determine what kind of customer usage draws down a commit or credit. A customer's usage needs to meet the condition of at least one of the specifiers to contribute to a commit's or credit's drawdown. This field cannot be used together with `applicable_product_ids` or `applicable_product_tags`.",
+        items: {
+          type: 'object',
+          properties: {
+            presentation_group_values: {
+              type: 'object',
+            },
+            pricing_group_values: {
+              type: 'object',
+            },
+            product_id: {
+              type: 'string',
+              description: 'If provided, the specifier will only apply to the product with the specified ID.',
+            },
+            product_tags: {
+              type: 'array',
+              description:
+                'If provided, the specifier will only apply to products with all the specified tags.',
+              items: {
+                type: 'string',
+              },
+            },
+          },
+          required: [],
+        },
+      },
+      uniqueness_key: {
+        type: 'string',
+        description:
+          'Prevents the creation of duplicates. If a request to create a commit or credit is made with a uniqueness key that was previously used to create a commit or credit, a new record will not be created and the request will fail with a 409 error.',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.commits.create(body);
+};
+
+export default { metadata, tool, handler };