@robinmordasiewicz/f5xc-api-mcp 3.0.0

package/dist/tools/generated/billing/index.js

@@ -0,0 +1,759 @@
+/**
+ * Generated tool definitions for billing domain
+ * DO NOT EDIT - This file is auto-generated by scripts/generate.ts
+ */
+export const billingTools = [
+    {
+        toolName: "f5xc-api-billing-current-list",
+        method: "GET",
+        path: "/api/web/namespaces/system/usage_plans/current",
+        operation: "list",
+        domain: "billing",
+        resource: "current",
+        summary: "GET current usage plan.",
+        description: "Endpoint to GET current usage plan.",
+        pathParameters: [],
+        queryParameters: [],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/planLocalizedPlan",
+        },
+        requiredParams: [],
+        operationId: "ves.io.schema.usage.plan.CustomAPI.GetCurrentPlan",
+        tags: ["Other"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-current-usage-create",
+        method: "POST",
+        path: "/api/web/namespaces/{namespace}/current_usage",
+        operation: "create",
+        domain: "billing",
+        resource: "current-usage",
+        summary: "List current usage details.",
+        description: "List current usage details per tenant and namespace. Some usage have only sense in the system namespace and this selector has no effect on it.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace to be considered.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/usageListCurrentUsageReq",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/usageListCurrentUsageResp",
+        },
+        requiredParams: ["body", "namespace"],
+        operationId: "ves.io.schema.usage.CustomCalculatedUsageAPI.ListCurrentUsage",
+        tags: ["Other"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-custom-list-list",
+        method: "GET",
+        path: "/api/web/namespaces/system/usage_plans/custom_list",
+        operation: "list",
+        domain: "billing",
+        resource: "custom-list",
+        summary: "List Usage Plans.",
+        description: "Endpoint to GET usage plans.",
+        pathParameters: [],
+        queryParameters: [],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/planListUsagePlansRsp",
+        },
+        requiredParams: [],
+        operationId: "ves.io.schema.usage.plan.CustomAPI.ListUsagePlans",
+        tags: ["Other"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-hourly-usage-detail-create",
+        method: "POST",
+        path: "/api/web/namespaces/{namespace}/hourly_usage_details",
+        operation: "create",
+        domain: "billing",
+        resource: "hourly-usage-detail",
+        summary: "List hourly usage details.",
+        description: "List the usage divided by hour. The usage is hourly aggregated, from the start of UTC hour\nto the end of UTC hour. It is used to see the detailed breakdown of the usage received from ListUsageDetails.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/usageListHourlyUsageDetailsReq",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/usageListHourlyUsageDetailsResp",
+        },
+        requiredParams: ["body", "namespace"],
+        operationId: "ves.io.schema.usage.CustomAggregatedUsageAPI.ListHourlyUsageDetails",
+        tags: ["Other"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-invoice-pdf-list",
+        method: "GET",
+        path: "/api/web/namespaces/{namespace}/usage/invoice_pdf",
+        operation: "list",
+        domain: "billing",
+        resource: "invoice-pdf",
+        summary: "GetInvoicePdf.",
+        description: "Retrieve pdf for a paid invoice by its name.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace filter.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [
+            {
+                description: "Name of the invoice to be downloaded.",
+                in: "query",
+                name: "name",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/invoiceDownloadInvoicePdfRsp",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.usage.invoice.CustomAPI.DownloadInvoicePdf",
+        tags: ["Billing"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-limit-list",
+        method: "GET",
+        path: "/api/web/namespaces/{namespace}/quota/limits",
+        operation: "list",
+        domain: "billing",
+        resource: "limit",
+        summary: "Custom GET Quota Limits.",
+        description: "Custom endpoint to return quota limits.",
+        pathParameters: [
+            {
+                description: "Namespace\nThe namespace this item belongs to.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/quotaGetQuotaLimitsResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.quota.CustomAPI.CustomGetQuotaLimits",
+        tags: ["Billing"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-monthly-usage-create",
+        method: "POST",
+        path: "/api/web/namespaces/{namespace}/monthly_usage",
+        operation: "create",
+        domain: "billing",
+        resource: "monthly-usage",
+        summary: "List monthly usage details.",
+        description: "List monthly usage details per tenant and namespace. Some usage have only sense in the system namespace and this selector has no effect on it.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace to be considered.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/usageListMonthlyUsageReq",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/usageListMonthlyUsageResp",
+        },
+        requiredParams: ["body", "namespace"],
+        operationId: "ves.io.schema.usage.CustomCalculatedUsageAPI.ListMonthlyUsage",
+        tags: ["Other"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-payment-method-create",
+        method: "POST",
+        path: "/api/web/namespaces/{namespace}/billing/payment_methods",
+        operation: "create",
+        domain: "billing",
+        resource: "payment-method",
+        summary: "Create payment method specification.",
+        description: "Creates a new payment method with a specific role.",
+        pathParameters: [
+            {
+                description: "Namespace\nThis namespace specifies the namespace in which the payment method will be created.\nIf not provided, the default 'system' namespace will be used.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/payment_methodCreatePaymentMethodRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/payment_methodCreatePaymentMethodResponse",
+        },
+        requiredParams: ["body", "namespace"],
+        operationId: "ves.io.schema.billing.payment_method.CustomAPI.Create",
+        tags: ["Billing"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-payment-method-delete",
+        method: "DELETE",
+        path: "/api/web/namespaces/{namespace}/billing/payment_methods/{name}",
+        operation: "delete",
+        domain: "billing",
+        resource: "payment-method",
+        summary: "DELETE the specified payment method.",
+        description: "Remove the specified payment_method.",
+        pathParameters: [
+            {
+                description: "Name\nName of the payment method.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: "Namespace\nNamespace in which the configuration object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: null,
+        responseSchema: {},
+        requiredParams: ["name", "namespace"],
+        operationId: "ves.io.schema.billing.payment_method.CustomAPI.Delete",
+        tags: ["Billing"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-plan-transition-create",
+        method: "POST",
+        path: "/api/web/namespaces/{namespace}/billing/plan_transition",
+        operation: "create",
+        domain: "billing",
+        resource: "plan-transition",
+        summary: "InitiatePlanTransition.",
+        description: "API to create a plan transition request in db.",
+        pathParameters: [
+            {
+                description: "Namespace\nThis namespace is not used, all requests are stored under system namespace.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/plan_transitionInitiatePlanTransitionReq",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/plan_transitionInitiatePlanTransitionRsp",
+        },
+        requiredParams: ["body", "namespace"],
+        operationId: "ves.io.schema.billing.plan_transition.CustomAPI.InitiatePlanTransition",
+        tags: ["Billing"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-plan-transition-list",
+        method: "GET",
+        path: "/no_auth/namespaces/system/billing/plan_transition",
+        operation: "list",
+        domain: "billing",
+        resource: "plan-transition",
+        summary: "GetPlanTransition.",
+        description: "API to GET plan transition details by a plan transition request uid returned from InitiatePlanTransition.\nFor now this one returns only current State.",
+        pathParameters: [],
+        queryParameters: [
+            {
+                description: "ID of the plan transition request.",
+                in: "query",
+                name: "id",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/plan_transitionGetPlanTransitionRsp",
+        },
+        requiredParams: [],
+        operationId: "ves.io.schema.billing.plan_transition.CustomAPI.GetPlanTransition",
+        tags: ["Billing"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-primary-create",
+        method: "POST",
+        path: "/api/web/namespaces/{namespace}/billing/payment_method/{name}/primary",
+        operation: "create",
+        domain: "billing",
+        resource: "primary",
+        summary: "Make credit card primary.",
+        description: "Flags a payment method as primary. Nothing changes is the payment method is already primary, if the payment method is secondary then it becomes default and there will be no secondary.",
+        pathParameters: [
+            {
+                description: "Name\nThe name of the payment method object to be made primary.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: "Namespace\nThe namespace in which the payment method object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/payment_methodPaymentMethodPrimaryReq",
+        },
+        responseSchema: {},
+        requiredParams: ["body", "name", "namespace"],
+        operationId: "ves.io.schema.billing.payment_method.CustomAPI.MakePaymentMethodPrimary",
+        tags: ["Billing"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-quota-create",
+        method: "POST",
+        path: "/api/web/namespaces/{metadata.namespace}/quotas",
+        operation: "create",
+        domain: "billing",
+        resource: "quota",
+        summary: "Create Quota.",
+        description: "Create quota creates a given object from storage backend for metadata.namespace.",
+        pathParameters: [
+            {
+                description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
+                in: "path",
+                name: "metadata.namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/quotaCreateRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/quotaCreateResponse",
+        },
+        requiredParams: ["body", "metadata.namespace"],
+        operationId: "ves.io.schema.quota.API.Create",
+        tags: ["Other"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-quota-delete",
+        method: "DELETE",
+        path: "/api/web/namespaces/{namespace}/quotas/{name}",
+        operation: "delete",
+        domain: "billing",
+        resource: "quota",
+        summary: "DELETE Quota.",
+        description: "DELETE the specified quota.",
+        pathParameters: [
+            {
+                description: "Name\nName of the configuration object.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: "Namespace\nNamespace in which the configuration object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/quotaDeleteRequest",
+        },
+        responseSchema: {},
+        requiredParams: ["body", "name", "namespace"],
+        operationId: "ves.io.schema.quota.API.Delete",
+        tags: ["Other"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-quota-get",
+        method: "GET",
+        path: "/api/web/namespaces/{namespace}/quotas/{name}",
+        operation: "get",
+        domain: "billing",
+        resource: "quota",
+        summary: "GET Quota",
+        description: "GET quota reads a given object from storage backend for metadata.namespace.",
+        pathParameters: [
+            {
+                description: "Name\nThe name of the configuration object to be fetched.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: "Namespace\nThe namespace in which the configuration object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [
+            {
+                description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
+                in: "query",
+                name: "response_format",
+                required: false,
+                schema: {
+                    default: "GET_RSP_FORMAT_DEFAULT",
+                    enum: [
+                        "GET_RSP_FORMAT_DEFAULT",
+                        "GET_RSP_FORMAT_FOR_CREATE",
+                        "GET_RSP_FORMAT_FOR_REPLACE",
+                        "GET_RSP_FORMAT_STATUS",
+                        "GET_RSP_FORMAT_READ",
+                        "GET_RSP_FORMAT_REFERRING_OBJECTS",
+                        "GET_RSP_FORMAT_BROKEN_REFERENCES",
+                    ],
+                    type: "string",
+                },
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/quotaGetResponse",
+        },
+        requiredParams: ["name", "namespace"],
+        operationId: "ves.io.schema.quota.API.Get",
+        tags: ["Other"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-quota-list",
+        method: "GET",
+        path: "/api/web/namespaces/{namespace}/quotas",
+        operation: "list",
+        domain: "billing",
+        resource: "quota",
+        summary: "List Quota.",
+        description: "List the set of quota in a namespace.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace to scope the listing of quota.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [
+            {
+                description: "A LabelSelectorType expression that every item in list response will satisfy.",
+                in: "query",
+                name: "label_filter",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: 'X-example: ""\nExtra fields to return along with summary fields.',
+                in: "query",
+                name: "report_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+            },
+            {
+                description: 'X-example: ""\nExtra status fields to return along with summary fields.',
+                in: "query",
+                name: "report_status_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/quotaListResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.quota.API.List",
+        tags: ["Other"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-quota-update",
+        method: "PUT",
+        path: "/api/web/namespaces/{metadata.namespace}/quotas/{metadata.name}",
+        operation: "update",
+        domain: "billing",
+        resource: "quota",
+        summary: "Replace Quota.",
+        description: "Replace quota updates a given object from storage backend for metadata.namespace.",
+        pathParameters: [
+            {
+                description: "Name\nThe configuration object to be replaced will be looked up by name.",
+                in: "path",
+                name: "metadata.name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
+                in: "path",
+                name: "metadata.namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/quotaReplaceRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/quotaReplaceResponse",
+        },
+        requiredParams: ["body", "metadata.name", "metadata.namespace"],
+        operationId: "ves.io.schema.quota.API.Replace",
+        tags: ["Other"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-secondary-create",
+        method: "POST",
+        path: "/api/web/namespaces/{namespace}/billing/payment_method/{name}/secondary",
+        operation: "create",
+        domain: "billing",
+        resource: "secondary",
+        summary: "Make payment method secondary.",
+        description: "Flags a payment method as secondary. Nothing changes is the payment method is already secondary, if the payment method is primary then it becomes secondary and there will be no primary.",
+        pathParameters: [
+            {
+                description: "Name\nThe name of the payment method object to be made secondary.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: "Namespace\nThe namespace in which the payment method object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/payment_methodPaymentMethodSecondaryReq",
+        },
+        responseSchema: {},
+        requiredParams: ["body", "name", "namespace"],
+        operationId: "ves.io.schema.billing.payment_method.CustomAPI.MakePaymentMethodSecondary",
+        tags: ["Billing"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-swap-primary-create",
+        method: "POST",
+        path: "/api/web/namespaces/{namespace}/billing/payment_method/{name}/swap-primary",
+        operation: "create",
+        domain: "billing",
+        resource: "swap-primary",
+        summary: "Make payment method secondary.",
+        description: "Swaps payment method roles - the payment method used as a parameter will became primary, any other will become secondary. The `name` parameter is ignored.",
+        pathParameters: [
+            {
+                description: "Name\nThe name of the payment method object to be updated.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: "Namespace\nThe namespace in which the payment method object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/payment_methodPaymentMethodRoleSwapReq",
+        },
+        responseSchema: {},
+        requiredParams: ["body", "name", "namespace"],
+        operationId: "ves.io.schema.billing.payment_method.CustomAPI.SwapPaymentMethodRole",
+        tags: ["Billing"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-usage-detail-create",
+        method: "POST",
+        path: "/api/web/namespaces/{namespace}/usage_details",
+        operation: "create",
+        domain: "billing",
+        resource: "usage-detail",
+        summary: "List usage details.",
+        description: "List usage details per tenant and namespace. Some usage have only sense in the system namespace and this selector has no effect on it.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace to be considered.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/usageListUsageDetailsReq",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/usageListUsageDetailsResp",
+        },
+        requiredParams: ["body", "namespace"],
+        operationId: "ves.io.schema.usage.CustomAggregatedUsageAPI.ListUsageDetails",
+        tags: ["Other"],
+        sourceFile: "domains/billing.json",
+    },
+    {
+        toolName: "f5xc-api-billing-usage-list",
+        method: "GET",
+        path: "/api/web/namespaces/{namespace}/quota/usage",
+        operation: "list",
+        domain: "billing",
+        resource: "usage",
+        summary: "GET Quota Usage.",
+        description: "GET allows users to query limits and current usage of resources.",
+        pathParameters: [
+            {
+                description: "Namespace\nThe tenant this item belongs to.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/quotaGetResponseType",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.quota.CustomAPI.GetQuotaUsage",
+        tags: ["Billing"],
+        sourceFile: "domains/billing.json",
+    },
+];
+export default billingTools;
+//# sourceMappingURL=index.js.map