@metronome/mcp 0.1.0-beta.11

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

@@ -0,0 +1,74 @@
+// 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/list',
+  operationId: 'listCustomerCommits-v1',
+};
+
+export const tool: Tool = {
+  name: 'list_customers_v1_commits',
+  description: 'List commits.\n',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      commit_id: {
+        type: 'string',
+      },
+      covering_date: {
+        type: 'string',
+        description: 'Include only commits that have access schedules that "cover" the provided date',
+        format: 'date-time',
+      },
+      effective_before: {
+        type: 'string',
+        description: 'Include only commits that have any access before the provided date (exclusive)',
+        format: 'date-time',
+      },
+      include_archived: {
+        type: 'boolean',
+        description: 'Include archived commits and commits from archived contracts.',
+      },
+      include_balance: {
+        type: 'boolean',
+        description:
+          'Include the balance in the response. Setting this flag may cause the query to be slower.',
+      },
+      include_contract_commits: {
+        type: 'boolean',
+        description: 'Include commits on the contract level.',
+      },
+      include_ledgers: {
+        type: 'boolean',
+        description:
+          'Include commit ledgers in the response. Setting this flag may cause the query to be slower.',
+      },
+      next_page: {
+        type: 'string',
+        description: 'The next page token from a previous response.',
+      },
+      starting_at: {
+        type: 'string',
+        description: 'Include only commits that have any access on or after the provided date',
+        format: 'date-time',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.commits.list(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/commits/update-end-date-customers-v1-commits.ts

@@ -0,0 +1,52 @@
+// 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/updateEndDate',
+  operationId: 'updateCommitEndDate-v1',
+};
+
+export const tool: Tool = {
+  name: 'update_end_date_customers_v1_commits',
+  description:
+    'Pull forward the end date of a prepaid commit. Use the "edit a commit" endpoint to extend the end date of a prepaid commit, or to make other edits to the commit.\n',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      commit_id: {
+        type: 'string',
+        description: 'ID of the commit to update. Only supports "PREPAID" commits.',
+      },
+      customer_id: {
+        type: 'string',
+        description: 'ID of the customer whose commit is to be updated',
+      },
+      access_ending_before: {
+        type: 'string',
+        description:
+          'RFC 3339 timestamp indicating when access to the commit will end and it will no longer be possible to draw it down (exclusive). If not provided, the access will not be updated.',
+        format: 'date-time',
+      },
+      invoices_ending_before: {
+        type: 'string',
+        description:
+          'RFC 3339 timestamp indicating when the commit will stop being invoiced (exclusive). If not provided, the invoice schedule will not be updated.',
+        format: 'date-time',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.commits.updateEndDate(body);
+};
+
+export default { metadata, tool, handler };

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

@@ -0,0 +1,143 @@
+// 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',
+  operationId: 'createCustomer-v1',
+};
+
+export const tool: Tool = {
+  name: 'create_v1_customers',
+  description: 'Create a new customer',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      name: {
+        type: 'string',
+        description: 'This will be truncated to 160 characters if the provided name is longer.',
+      },
+      billing_config: {
+        type: 'object',
+        properties: {
+          billing_provider_customer_id: {
+            type: 'string',
+          },
+          billing_provider_type: {
+            type: 'string',
+            enum: [
+              'aws_marketplace',
+              'stripe',
+              'netsuite',
+              'custom',
+              'azure_marketplace',
+              'quickbooks_online',
+              'workday',
+              'gcp_marketplace',
+            ],
+          },
+          aws_is_subscription_product: {
+            type: 'boolean',
+            description: 'True if the aws_product_code is a SAAS subscription product, false otherwise.',
+          },
+          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'],
+          },
+        },
+        required: ['billing_provider_customer_id', 'billing_provider_type'],
+      },
+      custom_fields: {
+        type: 'object',
+      },
+      customer_billing_provider_configurations: {
+        type: 'array',
+        items: {
+          type: 'object',
+          properties: {
+            billing_provider: {
+              type: 'string',
+              description: 'The billing provider set for this configuration.',
+              enum: ['aws_marketplace', 'azure_marketplace', 'gcp_marketplace', 'stripe', 'netsuite'],
+            },
+            configuration: {
+              type: 'object',
+              description:
+                'Configuration for the billing provider. The structure of this object is specific to the billing provider and delivery provider combination. Defaults to an empty object, however, for most billing provider + delivery method combinations, it will not be a valid configuration.',
+            },
+            delivery_method: {
+              type: 'string',
+              description:
+                'The method to use for delivering invoices to this customer. If not provided, the `delivery_method_id` must be provided.',
+              enum: ['direct_to_billing_provider', 'aws_sqs', 'tackle', 'aws_sns'],
+            },
+            delivery_method_id: {
+              type: 'string',
+              description:
+                'ID of the delivery method to use for this customer. If not provided, the `delivery_method` must be provided.',
+            },
+          },
+          required: ['billing_provider'],
+        },
+      },
+      external_id: {
+        type: 'string',
+        description:
+          '(deprecated, use ingest_aliases instead) an alias that can be used to refer to this customer in usage events',
+      },
+      ingest_aliases: {
+        type: 'array',
+        description: 'Aliases that can be used to refer to this customer in usage events',
+        items: {
+          type: 'string',
+        },
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.create(body);
+};
+
+export default { metadata, tool, handler };

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

@@ -0,0 +1,156 @@
+// 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.credits',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/contracts/customerCredits/create',
+  operationId: 'createCustomerCredit-v1',
+};
+
+export const tool: Tool = {
+  name: 'create_customers_v1_credits',
+  description: 'Create a new credit at the customer level.\n',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      access_schedule: {
+        type: 'object',
+        description: 'Schedule for distributing the credit to the customer.',
+        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',
+      },
+      applicable_contract_ids: {
+        type: 'array',
+        description:
+          'Which contract the credit applies to. If not provided, the credit applies to all contracts.',
+        items: {
+          type: 'string',
+        },
+      },
+      applicable_product_ids: {
+        type: 'array',
+        description:
+          'Which products the credit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the credit applies to all products.',
+        items: {
+          type: 'string',
+        },
+      },
+      applicable_product_tags: {
+        type: 'array',
+        description:
+          'Which tags the credit applies to. If both applicable_product_ids and applicable_product_tags are not provided, the credit 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.',
+      },
+      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.credits.create(body);
+};
+
+export default { metadata, tool, handler };

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

@@ -0,0 +1,74 @@
+// 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.credits',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/contracts/customerCredits/list',
+  operationId: 'listCustomerCredits-v1',
+};
+
+export const tool: Tool = {
+  name: 'list_customers_v1_credits',
+  description: 'List credits.\n',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      covering_date: {
+        type: 'string',
+        description: 'Return only credits that have access schedules that "cover" the provided date',
+        format: 'date-time',
+      },
+      credit_id: {
+        type: 'string',
+      },
+      effective_before: {
+        type: 'string',
+        description: 'Include only credits that have any access before the provided date (exclusive)',
+        format: 'date-time',
+      },
+      include_archived: {
+        type: 'boolean',
+        description: 'Include archived credits and credits from archived contracts.',
+      },
+      include_balance: {
+        type: 'boolean',
+        description:
+          'Include the balance in the response. Setting this flag may cause the query to be slower.',
+      },
+      include_contract_credits: {
+        type: 'boolean',
+        description: 'Include credits on the contract level.',
+      },
+      include_ledgers: {
+        type: 'boolean',
+        description:
+          'Include credit ledgers in the response. Setting this flag may cause the query to be slower.',
+      },
+      next_page: {
+        type: 'string',
+        description: 'The next page token from a previous response.',
+      },
+      starting_at: {
+        type: 'string',
+        description: 'Include only credits that have any access on or after the provided date',
+        format: 'date-time',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.credits.list(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/credits/update-end-date-customers-v1-credits.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.credits',
+  operation: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/contracts/customerCredits/updateEndDate',
+  operationId: 'updateCreditEndDate-v1',
+};
+
+export const tool: Tool = {
+  name: 'update_end_date_customers_v1_credits',
+  description:
+    'Pull forward the end date of a credit. Use the "edit a credit" endpoint to extend the end date of a credit, or to make other edits to the credit.\n',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      access_ending_before: {
+        type: 'string',
+        description:
+          'RFC 3339 timestamp indicating when access to the credit will end and it will no longer be possible to draw it down (exclusive).',
+        format: 'date-time',
+      },
+      credit_id: {
+        type: 'string',
+        description: 'ID of the commit to update',
+      },
+      customer_id: {
+        type: 'string',
+        description: 'ID of the customer whose credit is to be updated',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.credits.updateEndDate(body);
+};
+
+export default { metadata, tool, handler };

package/src/tools/v1/customers/invoices/add-charge-customers-v1-invoices.ts

@@ -0,0 +1,59 @@
+// 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: 'write',
+  tags: [],
+  httpMethod: 'post',
+  httpPath: '/v1/customers/{customer_id}/addCharge',
+  operationId: 'addOneTimeCharge-v1',
+};
+
+export const tool: Tool = {
+  name: 'add_charge_customers_v1_invoices',
+  description: 'Add a one time charge to the specified invoice',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      charge_id: {
+        type: 'string',
+        description:
+          'The Metronome ID of the charge to add to the invoice. Note that the charge must be on a product that is not on the current plan, and the product must have only fixed charges.',
+      },
+      customer_plan_id: {
+        type: 'string',
+        description: 'The Metronome ID of the customer plan to add the charge to.',
+      },
+      description: {
+        type: 'string',
+      },
+      invoice_start_timestamp: {
+        type: 'string',
+        description: 'The start_timestamp of the invoice to add the charge to.',
+        format: 'date-time',
+      },
+      price: {
+        type: 'number',
+        description:
+          'The price of the charge. This price will match the currency on the invoice, e.g. USD cents.',
+      },
+      quantity: {
+        type: 'number',
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.invoices.addCharge(body);
+};
+
+export default { metadata, tool, handler };

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

@@ -0,0 +1,78 @@
+// 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/breakdowns',
+  operationId: 'listBreakdownInvoices-v1',
+};
+
+export const tool: Tool = {
+  name: 'list_breakdowns_customers_v1_invoices',
+  description:
+    'List daily or hourly invoice breakdowns for a given customer, optionally filtered by status, date range, and/or credit type.\nImportant considerations:\n- If we receive backdated usage after an invoice has been finalized, the backdated usage will be included in the response and usage numbers may differ.',
+  inputSchema: {
+    type: 'object',
+    properties: {
+      customer_id: {
+        type: 'string',
+      },
+      ending_before: {
+        type: 'string',
+        description:
+          'RFC 3339 timestamp. Breakdowns will only be returned for time windows that end on or before this time.',
+        format: 'date-time',
+      },
+      starting_on: {
+        type: 'string',
+        description:
+          'RFC 3339 timestamp. Breakdowns will only be returned for time windows that start on or after this time.',
+        format: 'date-time',
+      },
+      credit_type_id: {
+        type: 'string',
+        description: 'Only return invoices for the specified credit type',
+      },
+      limit: {
+        type: 'integer',
+        description:
+          'Max number of results that should be returned. For daily breakdowns, the response can return up to 35 days worth of breakdowns. For hourly breakdowns, the response can return up to 24 hours. If there are more results, a cursor to the next page is 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'],
+      },
+      status: {
+        type: 'string',
+        description: 'Invoice status, e.g. DRAFT or FINALIZED',
+      },
+      window_size: {
+        type: 'string',
+        description: 'The granularity of the breakdowns to return. Defaults to day.',
+        enum: ['HOUR', 'DAY'],
+      },
+    },
+  },
+};
+
+export const handler = (client: Metronome, args: Record<string, unknown> | undefined) => {
+  const body = args as any;
+  return client.v1.customers.invoices.listBreakdowns(body);
+};
+
+export default { metadata, tool, handler };