@metronome/mcp 0.1.0-beta.11

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

@@ -0,0 +1,72 @@
+// 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.invoices',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/v1/customers/{customer_id}/invoices',
+  operationId: 'listInvoices-v1',
+};
+
+export const tool: Tool = {
+  name: 'list_customers_v1_invoices',
+  description:
+    'List all invoices for a given customer, optionally filtered by status, date range, and/or credit type.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      credit_type_id: {
+        type: 'string',
+        description: 'Only return invoices for the specified credit type',
+      },
+      ending_before: {
+        type: 'string',
+        description:
+          'RFC 3339 timestamp (exclusive). Invoices will only be returned for billing periods that end before this time.',
+        format: 'date-time',
+      },
+      limit: {
+        type: 'integer',
+        description: 'Max number of results that should be returned',
+      },
+      next_page: {
+        type: 'string',
+        description: 'Cursor that indicates where the next page of results should start.',
+      },
+      skip_zero_qty_line_items: {
+        type: 'boolean',
+        description: 'If set, all zero quantity line items will be filtered out of the response',
+      },
+      sort: {
+        type: 'string',
+        description: 'Invoice sort order by issued_at, e.g. date_asc or date_desc.  Defaults to date_asc.',
+        enum: ['date_asc', 'date_desc'],
+      },
+      starting_on: {
+        type: 'string',
+        description:
+          'RFC 3339 timestamp (inclusive). Invoices will only be returned for billing periods that start at or after this time.',
+        format: 'date-time',
+      },
+      status: {
+        type: 'string',
+        description: 'Invoice status, e.g. DRAFT, FINALIZED, or VOID',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.invoices.list(body);
+};
+
+export default { metadata, tool, handler };

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

@@ -0,0 +1,41 @@
+// 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.invoices',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/v1/customers/{customer_id}/invoices/{invoice_id}',
+  operationId: 'getInvoice-v1',
+};
+
+export const tool: Tool = {
+  name: 'retrieve_customers_v1_invoices',
+  description: 'Fetch a specific invoice for a given customer.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      invoice_id: {
+        type: 'string',
+      },
+      skip_zero_qty_line_items: {
+        type: 'boolean',
+        description: 'If set, all zero quantity line items will be filtered out of the response',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.invoices.retrieve(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/list-billable-metrics-v1-customers.ts

@@ -0,0 +1,51 @@
+// 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: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/v1/customers/{customer_id}/billable-metrics',
+  operationId: 'listBillableMetrics-v1',
+};
+
+export const tool: Tool = {
+  name: 'list_billable_metrics_v1_customers',
+  description: 'Get all billable metrics for a given customer.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      include_archived: {
+        type: 'boolean',
+        description: 'If true, the list of returned metrics will include archived metrics',
+      },
+      limit: {
+        type: 'integer',
+        description: 'Max number of results that should be returned',
+      },
+      next_page: {
+        type: 'string',
+        description: 'Cursor that indicates where the next page of results should start.',
+      },
+      on_current_plan: {
+        type: 'boolean',
+        description:
+          "If true, the list of metrics will be filtered to just ones that are on the customer's current plan",
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.listBillableMetrics(body);
+};
+
+export default { metadata, tool, handler };

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

@@ -0,0 +1,53 @@
+// 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: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/v1/customers/{customer_id}/costs',
+  operationId: 'getCosts-v1',
+};
+
+export const tool: Tool = {
+  name: 'list_costs_v1_customers',
+  description:
+    '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.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      ending_before: {
+        type: 'string',
+        description: 'RFC 3339 timestamp (exclusive)',
+        format: 'date-time',
+      },
+      starting_on: {
+        type: 'string',
+        description: 'RFC 3339 timestamp (inclusive)',
+        format: 'date-time',
+      },
+      limit: {
+        type: 'integer',
+        description: 'Max number of results that should be returned',
+      },
+      next_page: {
+        type: 'string',
+        description: 'Cursor that indicates where the next page of results should start.',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.listCosts(body);
+};
+
+export default { metadata, tool, handler };

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

@@ -0,0 +1,62 @@
+// 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: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/v1/customers',
+  operationId: 'listCustomers-v1',
+};
+
+export const tool: Tool = {
+  name: 'list_v1_customers',
+  description: 'List all customers.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_ids: {
+        type: 'array',
+        description: 'Filter the customer list by customer_id.  Up to 100 ids can be provided.',
+        items: {
+          type: 'string',
+        },
+      },
+      ingest_alias: {
+        type: 'string',
+        description: 'Filter the customer list by ingest_alias',
+      },
+      limit: {
+        type: 'integer',
+        description: 'Max number of results that should be returned',
+      },
+      next_page: {
+        type: 'string',
+        description: 'Cursor that indicates where the next page of results should start.',
+      },
+      only_archived: {
+        type: 'boolean',
+        description:
+          'Filter the customer list to only return archived customers. By default, only active customers are returned.',
+      },
+      salesforce_account_ids: {
+        type: 'array',
+        description: 'Filter the customer list by salesforce_account_id.  Up to 100 ids can be provided.',
+        items: {
+          type: 'string',
+        },
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.list(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/named-schedules/retrieve-customers-v1-named-schedules.ts

@@ -0,0 +1,46 @@
+// 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.named_schedules',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/customers/getNamedSchedule',
+  operationId: 'getCustomerNamedSchedule-v1',
+};
+
+export const tool: Tool = {
+  name: 'retrieve_customers_v1_named_schedules',
+  description:
+    "Get a named schedule for the given customer. This endpoint's availability is dependent on your client's configuration.",
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+        description: 'ID of the customer whose named schedule is to be retrieved',
+      },
+      schedule_name: {
+        type: 'string',
+        description: 'The identifier for the schedule to be retrieved',
+      },
+      covering_date: {
+        type: 'string',
+        description:
+          'If provided, at most one schedule segment will be returned (the one that covers this date). If not provided, all segments will be returned.',
+        format: 'date-time',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.namedSchedules.retrieve(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/named-schedules/update-customers-v1-named-schedules.ts

@@ -0,0 +1,53 @@
+// 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.named_schedules',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/customers/updateNamedSchedule',
+  operationId: 'updateCustomerNamedSchedule-v1',
+};
+
+export const tool: Tool = {
+  name: 'update_customers_v1_named_schedules',
+  description:
+    "Update a named schedule for the given customer. This endpoint's availability is dependent on your client's configuration.",
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+        description: 'ID of the customer whose named schedule is to be updated',
+      },
+      schedule_name: {
+        type: 'string',
+        description: 'The identifier for the schedule to be updated',
+      },
+      starting_at: {
+        type: 'string',
+        format: 'date-time',
+      },
+      value: {
+        type: 'object',
+        description:
+          'The value to set for the named schedule. The structure of this object is specific to the named schedule.',
+      },
+      ending_before: {
+        type: 'string',
+        format: 'date-time',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.namedSchedules.update(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/plans/add-customers-v1-plans.ts

@@ -0,0 +1,138 @@
+// 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.plans',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/customers/{customer_id}/plans/add',
+  operationId: 'addPlanToCustomer-v1',
+};
+
+export const tool: Tool = {
+  name: 'add_customers_v1_plans',
+  description:
+    'Associate an existing customer with a plan for a specified date range.  See the [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments) for details on the price adjustments.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      plan_id: {
+        type: 'string',
+      },
+      starting_on: {
+        type: 'string',
+        description:
+          'RFC 3339 timestamp for when the plan becomes active for this customer. Must be at 0:00 UTC (midnight).',
+        format: 'date-time',
+      },
+      ending_before: {
+        type: 'string',
+        description:
+          'RFC 3339 timestamp for when the plan ends (exclusive) for this customer. Must be at 0:00 UTC (midnight).',
+        format: 'date-time',
+      },
+      net_payment_terms_days: {
+        type: 'number',
+        description: 'Number of days after issuance of invoice after which the invoice is due (e.g. Net 30).',
+      },
+      overage_rate_adjustments: {
+        type: 'array',
+        description:
+          'An optional list of overage rates that override the rates of the original plan configuration. These new rates will apply to all pricing ramps.',
+        items: {
+          type: 'object',
+          properties: {
+            custom_credit_type_id: {
+              type: 'string',
+            },
+            fiat_currency_credit_type_id: {
+              type: 'string',
+            },
+            to_fiat_conversion_factor: {
+              type: 'number',
+              description: 'The overage cost in fiat currency for each credit of the custom credit type.',
+            },
+          },
+          required: ['custom_credit_type_id', 'fiat_currency_credit_type_id', 'to_fiat_conversion_factor'],
+        },
+      },
+      price_adjustments: {
+        type: 'array',
+        description:
+          'A list of price adjustments can be applied on top of the pricing in the plans. See the [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments) for details.',
+        items: {
+          type: 'object',
+          properties: {
+            adjustment_type: {
+              type: 'string',
+              enum: ['percentage', 'fixed', 'override', 'quantity'],
+            },
+            charge_id: {
+              type: 'string',
+            },
+            start_period: {
+              type: 'number',
+              description:
+                'Used in price ramps.  Indicates how many billing periods pass before the charge applies.',
+            },
+            quantity: {
+              type: 'number',
+              description: 'the overridden quantity for a fixed charge',
+            },
+            tier: {
+              type: 'number',
+              description: 'Used in pricing tiers.  Indicates at what metric value the price applies.',
+            },
+            value: {
+              type: 'number',
+              description:
+                'The amount of change to a price. Percentage and fixed adjustments can be positive or negative. Percentage-based adjustments should be decimals, e.g. -0.05 for a 5% discount.',
+            },
+          },
+          required: ['adjustment_type', 'charge_id', 'start_period'],
+        },
+      },
+      trial_spec: {
+        type: 'object',
+        description:
+          "A custom trial can be set for the customer's plan. See the [trial configuration documentation](https://docs.metronome.com/provisioning/configure-trials/) for details.",
+        properties: {
+          length_in_days: {
+            type: 'number',
+            description: 'Length of the trial period in days.',
+          },
+          spending_cap: {
+            type: 'object',
+            properties: {
+              amount: {
+                type: 'number',
+                description:
+                  'The credit amount in the given denomination based on the credit type, e.g. US cents.',
+              },
+              credit_type_id: {
+                type: 'string',
+                description: 'The credit type ID for the spending cap.',
+              },
+            },
+            required: ['amount', 'credit_type_id'],
+          },
+        },
+        required: ['length_in_days'],
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.plans.add(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/plans/end-customers-v1-plans.ts

@@ -0,0 +1,53 @@
+// 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.plans',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/customers/{customer_id}/plans/{customer_plan_id}/end',
+  operationId: 'endCustomerPlan-v1',
+};
+
+export const tool: Tool = {
+  name: 'end_customers_v1_plans',
+  description: "Change the end date of a customer's plan.",
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      customer_plan_id: {
+        type: 'string',
+      },
+      ending_before: {
+        type: 'string',
+        description:
+          'RFC 3339 timestamp for when the plan ends (exclusive) for this customer. Must be at 0:00 UTC (midnight). If not provided, the plan end date will be cleared.',
+        format: 'date-time',
+      },
+      void_invoices: {
+        type: 'boolean',
+        description:
+          'If true, plan end date can be before the last finalized invoice date. Any invoices generated after the plan end date will be voided.',
+      },
+      void_stripe_invoices: {
+        type: 'boolean',
+        description:
+          'Only applicable when void_invoices is set to true. If true, for every invoice that is voided we will also attempt to void/delete the stripe invoice (if any). Stripe invoices will be voided if finalized or deleted if still in draft state.',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.plans.end(body);
+};
+
+export default { metadata, tool, handler };

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

@@ -0,0 +1,42 @@
+// 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.plans',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/v1/customers/{customer_id}/plans',
+  operationId: 'listCustomerPlans-v1',
+};
+
+export const tool: Tool = {
+  name: 'list_customers_v1_plans',
+  description: "List the given customer's plans in reverse-chronological order.",
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      limit: {
+        type: 'integer',
+        description: 'Max number of results that should be returned',
+      },
+      next_page: {
+        type: 'string',
+        description: 'Cursor that indicates where the next page of results should start.',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.plans.list(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/plans/list-price-adjustments-customers-v1-plans.ts

@@ -0,0 +1,46 @@
+// 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.plans',
+  operation: 'read',
+  tags: [],
+  httpMethod: 'get',
+  httpPath: '/v1/customers/{customer_id}/plans/{customer_plan_id}/priceAdjustments',
+  operationId: 'getPlanPriceAdjustments-v1',
+};
+
+export const tool: Tool = {
+  name: 'list_price_adjustments_customers_v1_plans',
+  description:
+    'Lists a customer plans adjustments. See the [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments) for details.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      customer_plan_id: {
+        type: 'string',
+      },
+      limit: {
+        type: 'integer',
+        description: 'Max number of results that should be returned',
+      },
+      next_page: {
+        type: 'string',
+        description: 'Cursor that indicates where the next page of results should start.',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.plans.listPriceAdjustments(body);
+};
+
+export default { metadata, tool, handler };