diff --git a/docs/package.json b/docs/package.json index 41d272278..5d365acfd 100644 --- a/docs/package.json +++ b/docs/package.json @@ -9,9 +9,9 @@ "update-contributors": "node scripts/update-contributors.js" }, "devDependencies": { - "@shikijs/vitepress-twoslash": "^1.26.1", + "@shikijs/vitepress-twoslash": "^1.29.1", "openapi-metadata": "workspace:*", - "vite": "^6.0.7", - "vitepress": "1.5.0" + "vite": "^6.0.11", + "vitepress": "1.6.3" } } diff --git a/package.json b/package.json index d38d5b3f8..292b59332 100644 --- a/package.json +++ b/package.json @@ -21,15 +21,15 @@ "devDependencies": { "@biomejs/biome": "^1.9.4", "@changesets/changelog-github": "^0.5.0", - "@changesets/cli": "^2.27.11", - "@playwright/test": "^1.49.1", + "@changesets/cli": "^2.27.12", + "@playwright/test": "^1.50.0", "@size-limit/preset-small-lib": "^11.1.6", - "@types/node": "^22.10.5", + "@types/node": "^22.10.10", "del-cli": "^5.1.0", "prettier": "^3.4.2", "size-limit": "^11.1.6", - "turbo": "^2.3.3", - "typescript": "^5.7.2", + "turbo": "^2.3.4", + "typescript": "^5.7.3", "vitest": "^2.1.8" }, "size-limit": [ diff --git a/packages/openapi-fetch/examples/nextjs/package.json b/packages/openapi-fetch/examples/nextjs/package.json index 08a8c05ab..fa5c65a88 100644 --- a/packages/openapi-fetch/examples/nextjs/package.json +++ b/packages/openapi-fetch/examples/nextjs/package.json @@ -15,6 +15,6 @@ "@types/react": "^18.3.18", "@types/react-dom": "^18.3.5", "openapi-typescript": "workspace:^", - "typescript": "^5.7.2" + "typescript": "^5.7.3" } } diff --git a/packages/openapi-fetch/examples/sveltekit/package.json b/packages/openapi-fetch/examples/sveltekit/package.json index 2cf6e1230..39bcf0085 100644 --- a/packages/openapi-fetch/examples/sveltekit/package.json +++ b/packages/openapi-fetch/examples/sveltekit/package.json @@ -13,13 +13,13 @@ }, "devDependencies": { "@sveltejs/adapter-auto": "^3.3.1", - "@sveltejs/kit": "^2.15.1", + "@sveltejs/kit": "^2.16.1", "@sveltejs/vite-plugin-svelte": "^5.0.3", "openapi-typescript": "workspace:^", - "svelte": "^5.16.1", + "svelte": "^5.19.3", "svelte-check": "^3.8.6", "tslib": "^2.8.1", - "typescript": "^5.7.2", - "vite": "^6.0.7" + "typescript": "^5.7.3", + "vite": "^6.0.11" } } diff --git a/packages/openapi-fetch/examples/vue-3/package.json b/packages/openapi-fetch/examples/vue-3/package.json index 3ff0ba205..425d5bb4a 100644 --- a/packages/openapi-fetch/examples/vue-3/package.json +++ b/packages/openapi-fetch/examples/vue-3/package.json @@ -19,8 +19,8 @@ "@vitejs/plugin-vue": "^5.2.1", "@vue/tsconfig": "^0.5.1", "openapi-typescript": "workspace:^", - "typescript": "^5.7.2", - "vite": "^6.0.7", + "typescript": "^5.7.3", + "vite": "^6.0.11", "vue-tsc": "^2.2.0" } } diff --git a/packages/openapi-fetch/package.json b/packages/openapi-fetch/package.json index 48c39c7cb..d777bd2f7 100644 --- a/packages/openapi-fetch/package.json +++ b/packages/openapi-fetch/package.json @@ -79,10 +79,10 @@ "node-forge": "^1.3.1", "openapi-typescript": "workspace:^", "openapi-typescript-codegen": "^0.25.0", - "openapi-typescript-fetch": "^2.0.0", + "openapi-typescript-fetch": "^2.1.0", "superagent": "^10.1.1", - "typescript": "^5.7.2", + "typescript": "^5.7.3", "undici": "^6.21.1", - "vite": "^6.0.7" + "vite": "^6.0.11" } } diff --git a/packages/openapi-react-query/package.json b/packages/openapi-react-query/package.json index 32b96371b..8f7f2b248 100644 --- a/packages/openapi-react-query/package.json +++ b/packages/openapi-react-query/package.json @@ -65,8 +65,8 @@ "openapi-typescript-helpers": "workspace:^" }, "devDependencies": { - "@tanstack/react-query": "^5.62.14", - "@testing-library/react": "^16.1.0", + "@tanstack/react-query": "^5.64.2", + "@testing-library/react": "^16.2.0", "@types/react": "18.3.1", "@vitejs/plugin-react": "^4.3.4", "del-cli": "^5.1.0", diff --git a/packages/openapi-typescript-helpers/package.json b/packages/openapi-typescript-helpers/package.json index 8a2e30f9b..65014b9cd 100644 --- a/packages/openapi-typescript-helpers/package.json +++ b/packages/openapi-typescript-helpers/package.json @@ -45,6 +45,6 @@ "test": "tsc --noEmit" }, "devDependencies": { - "typescript": "^5.7.2" + "typescript": "^5.7.3" } } diff --git a/packages/openapi-typescript/examples/digital-ocean-api.ts b/packages/openapi-typescript/examples/digital-ocean-api.ts index 85f6ac19a..e484f567b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api.ts +++ b/packages/openapi-typescript/examples/digital-ocean-api.ts @@ -3921,6 +3921,31 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/load_balancers/{lb_id}/cache": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete a Global Load Balancer CDN Cache + * @description To delete a Global load balancer CDN cache, send a DELETE request to + * `/v2/load_balancers/$LOAD_BALANCER_ID/cache`. + * + * A successful request will receive a 204 status code with no body in response. + * This indicates that the request was processed successfully. + * + */ + delete: operations["loadBalancers_delete_cache"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/load_balancers/{lb_id}/droplets": { parameters: { query?: never; @@ -4875,6 +4900,126 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/monitoring/metrics/droplet_autoscale/current_instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Droplet Autoscale Pool Current Size + * @description To retrieve the current size for a given Droplet Autoscale Pool, send a GET request to `/v2/monitoring/metrics/droplet_autoscale/current_instances`. + */ + get: operations["monitoring_get_droplet_autoscale_current_instances"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/droplet_autoscale/target_instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Droplet Autoscale Pool Target Size + * @description To retrieve the target size for a given Droplet Autoscale Pool, send a GET request to `/v2/monitoring/metrics/droplet_autoscale/target_instances`. + */ + get: operations["monitoring_get_droplet_autoscale_target_instances"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/droplet_autoscale/current_cpu_utilization": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Droplet Autoscale Pool Current Average CPU utilization + * @description To retrieve the current average CPU utilization for a given Droplet Autoscale Pool, send a GET request to `/v2/monitoring/metrics/droplet_autoscale/current_cpu_utilization`. + */ + get: operations["monitoring_get_droplet_autoscale_current_cpu_utilization.yml"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/droplet_autoscale/target_cpu_utilization": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Droplet Autoscale Pool Target Average CPU utilization + * @description To retrieve the target average CPU utilization for a given Droplet Autoscale Pool, send a GET request to `/v2/monitoring/metrics/droplet_autoscale/target_cpu_utilization`. + */ + get: operations["monitoring_get_droplet_autoscale_target_cpu_utilization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/droplet_autoscale/current_memory_utilization": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Droplet Autoscale Pool Current Average Memory utilization + * @description To retrieve the current average memory utilization for a given Droplet Autoscale Pool, send a GET request to `/v2/monitoring/metrics/droplet_autoscale/current_memory_utilization`. + */ + get: operations["monitoring_get_droplet_autoscale_current_memory_utilization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/droplet_autoscale/target_memory_utilization": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Droplet Autoscale Pool Target Average Memory utilization + * @description To retrieve the target average memory utilization for a given Droplet Autoscale Pool, send a GET request to `/v2/monitoring/metrics/droplet_autoscale/target_memory_utilization`. + */ + get: operations["monitoring_get_droplet_autoscale_target_memory_utilization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/monitoring/sinks/destinations": { parameters: { query?: never; @@ -6443,313 +6588,789 @@ export interface paths { patch?: never; trace?: never; }; -} -export type webhooks = Record; -export interface components { - schemas: { - error: { - /** - * @description A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found." - * @example not_found - */ - id: string; - /** - * @description A message providing additional information about the error, including details to help resolve it when possible. - * @example The resource you were accessing could not be found. - */ - message: string; - /** - * @description Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue. - * @example 4d9d8375-3c56-4925-a3e7-eb137fed17e9 - */ - request_id?: string; - }; - oneClicks: { - /** - * slug - * @description The slug identifier for the 1-Click application. - * @example monitoring - */ - slug: string; - /** - * type - * @description The type of the 1-Click application. - * @example kubernetes - */ - type: string; - }; - oneClicks_create: { - /** - * addon_slugs - * @description An array of 1-Click Application slugs to be installed to the Kubernetes cluster. - * @default [] - * @example [ - * "kube-state-metrics", - * "loki" - * ] - */ - addon_slugs: string[]; - /** - * cluster_uuid - * @description A unique ID for the Kubernetes cluster to which the 1-Click Applications will be installed. - * @example 50a994b6-c303-438f-9495-7e896cfe6b08 - */ - cluster_uuid: string; - }; - account: { - /** - * @description The total number of Droplets current user or team may have active at one time. - * @example 25 - */ - droplet_limit: number; - /** - * @description The total number of Floating IPs the current user or team may have. - * @example 5 - */ - floating_ip_limit: number; - /** - * @description The email address used by the current user to register for DigitalOcean. - * @example sammy@digitalocean.com - */ - email: string; - /** - * @description The display name for the current user. - * @example Sammy the Shark - */ - name?: string; - /** - * @description The unique universal identifier for the current user. - * @example b6fr89dbf6d9156cace5f3c78dc9851d957381ef - */ - uuid: string; - /** - * @description If true, the user has verified their account via email. False otherwise. - * @default false - * @example true - */ - email_verified: boolean; - /** - * @description This value is one of "active", "warning" or "locked". - * @default active - * @example active - * @enum {string} - */ - status: "active" | "warning" | "locked"; - /** - * @description A human-readable message giving more details about the status of the account. - * @example - */ - status_message: string; - /** @description When authorized in a team context, includes information about the current team. */ - team?: { - /** - * @description The unique universal identifier for the current team. - * @example 5df3e3004a17e242b7c20ca6c9fc25b701a47ece - */ - uuid?: string; - /** - * @description The name for the current team. - * @example My Team - */ - name?: string; - }; + "/v2/gen-ai/agents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** - * @description A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet. - * @example 512189 + * List Agents + * @description To list all agents, send a GET request to `/v2/gen-ai/agents`. */ - ssh_key_id: number; + get: operations["genai_list_agents"]; + put?: never; /** - * @description A unique identifier that differentiates this key from other keys using a format that SSH recognizes. The fingerprint is created when the key is added to your account. - * @example 3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa + * Create an Agent + * @description To create a new agent, send a POST request to `/v2/gen-ai/agents`. The response body contains a JSON object with the newly created agent object. */ - ssh_key_fingerprint: string; + post: operations["genai_create_agent"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{agent_uuid}/api_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** - * @description A human-readable display name for this key, used to easily identify the SSH keys when they are displayed. - * @example My SSH Public Key + * List Agent API Keys + * @description To list all agent API keys, send a GET request to `/v2/gen-ai/agents/{agent_uuid}/api_keys`. */ - ssh_key_name: string; - sshKeys: { - id?: components["schemas"]["ssh_key_id"]; - fingerprint?: components["schemas"]["ssh_key_fingerprint"]; - /** - * @description The entire public key string that was uploaded. Embedded into the root user's `authorized_keys` file if you include this key during Droplet creation. - * @example ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example - */ - public_key: string; - name: components["schemas"]["ssh_key_name"]; + get: operations["genai_list_agent_api_keys"]; + put?: never; + /** + * Create an Agent API Key + * @description To create an agent API key, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/api_keys`. + */ + post: operations["genai_create_agent_api_key"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - link_to_last_page: { - /** - * @description URI of the last page of the results. - * @example https://api.digitalocean.com/v2/images?page=2 - */ - last?: string; + get?: never; + /** + * Update API Key for an Agent + * @description To update an agent API key, send a PUT request to `/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}`. + */ + put: operations["genai_update_agent_api_key"]; + post?: never; + /** + * Delete API Key for an Agent + * @description To delete an API key for an agent, send a DELETE request to `/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}`. + */ + delete: operations["genai_delete_agent_api_key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - link_to_next_page: { - /** - * @description URI of the next page of the results. - * @example https://api.digitalocean.com/v2/images?page=2 - */ - next?: string; + get?: never; + /** + * Regenerate API Key for an Agent + * @description To regenerate an agent API key, send a PUT request to `/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate`. + */ + put: operations["genai_regenerate_agent_api_key"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{agent_uuid}/functions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - forward_links: components["schemas"]["link_to_last_page"] & components["schemas"]["link_to_next_page"]; - link_to_first_page: { - /** - * @description URI of the first page of the results. - * @example https://api.digitalocean.com/v2/images?page=1 - */ - first?: string; + get?: never; + put?: never; + /** + * Add Function Route to an Agent + * @description To create a function route for an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/functions`. + */ + post: operations["genai_attach_agent_function"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - link_to_prev_page: { - /** - * @description URI of the previous page of the results. - * @example https://api.digitalocean.com/v2/images?page=1 - */ - prev?: string; + get?: never; + /** + * Update Function Route for an Agent + * @description To update the function route, send a PUT request to `/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}`. + */ + put: operations["genai_update_agent_function"]; + post?: never; + /** + * Delete Function Route for an Agent + * @description To delete a function route from an agent, send a DELETE request to `/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}`. + */ + delete: operations["genai_detach_agent_function"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - backward_links: components["schemas"]["link_to_first_page"] & components["schemas"]["link_to_prev_page"]; - page_links: { - /** @example { - * "pages": { - * "first": "https://api.digitalocean.com/v2/account/keys?page=1", - * "prev": "https://api.digitalocean.com/v2/account/keys?page=2" - * } - * } */ - pages?: components["schemas"]["forward_links"] | components["schemas"]["backward_links"] | unknown; + get?: never; + put?: never; + /** + * Attach Knowledge Base to an Agent + * @description To attach a knowledge base to an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}` + */ + post: operations["genai_attach_knowledge_base"]; + /** + * Detach Knowledge Base from an Agent + * @description To detach a knowledge base from an agent, send a DELETE request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}`. + */ + delete: operations["genai_detach_knowledge_base"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - pagination: { - links?: components["schemas"]["page_links"]; + get?: never; + /** + * Update Agent Route for an Agent + * @description To update an agent route for an agent, send a PUT request to `/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}`. + */ + put: operations["genai_update_attached_agent"]; + /** + * Add Agent Route to an Agent + * @description To add an agent route to an agent, send a POST request to `/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}`. + */ + post: operations["genai_attach_agent"]; + /** + * Delete Agent Route for an Agent + * @description To delete an agent route from a parent agent, send a DELETE request to `/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}`. + */ + delete: operations["genai_detach_agent"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @description Information about the response itself. */ - meta_properties: { - /** - * @description Number of objects returned by the request. - * @example 1 - */ - total?: number; + /** + * Retrieve an Existing Agent + * @description To retrieve details of an agent, GET request to `/v2/gen-ai/agents/{uuid}`. The response body is a JSON object containing the agent. + */ + get: operations["genai_get_agent"]; + /** + * Update an Agent + * @description To update an agent, send a PUT request to `/v2/gen-ai/agents/{uuid}`. The response body is a JSON object containing the agent. + */ + put: operations["genai_update_agent"]; + post?: never; + /** + * Delete an Agent + * @description To delete an agent, send a DELETE request to `/v2/gen-ai/agents/{uuid}`. + */ + delete: operations["genai_delete_agent"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{uuid}/child_agents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - meta: { - meta: components["schemas"]["meta_properties"] & unknown; + /** + * View Agent Routes + * @description To view agent routes for an agent, send a GET requtest to `/v2/gen-ai/agents/{uuid}/child_agents`. + */ + get: operations["genai_get_agent_children"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{uuid}/deployment_visibility": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - region: { - /** - * @description The display name of the region. This will be a full name that is used in the control panel and other interfaces. - * @example New York 3 - */ - name: string; - /** - * @description A human-readable string that is used as a unique identifier for each region. - * @example nyc3 - */ - slug: string; - /** - * @description This attribute is set to an array which contains features available in this region - * @example [ - * "private_networking", - * "backups", - * "ipv6", - * "metadata", - * "install_agent", - * "storage", - * "image_transfer" - * ] - */ - features: unknown; - /** - * @description This is a boolean value that represents whether new Droplets can be created in this region. - * @example true - */ - available: boolean; - /** - * @description This attribute is set to an array which contains the identifying slugs for the sizes available in this region. - * @example [ - * "s-1vcpu-1gb", - * "s-1vcpu-2gb", - * "s-1vcpu-3gb", - * "s-2vcpu-2gb", - * "s-3vcpu-1gb", - * "s-2vcpu-4gb", - * "s-4vcpu-8gb", - * "s-6vcpu-16gb", - * "s-8vcpu-32gb", - * "s-12vcpu-48gb", - * "s-16vcpu-64gb", - * "s-20vcpu-96gb", - * "s-24vcpu-128gb", - * "s-32vcpu-192g" - * ] - */ - sizes: unknown; + get?: never; + /** + * Check Agent Status + * @description Check whether an agent is public or private. To get the agent status, send a PUT request to `/v2/gen-ai/agents/{uuid}/deployment_visibility`. + */ + put: operations["genai_update_agent_deployment_visibility"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/indexing_jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - action: { + /** + * List Indexing Jobs for a Knowledge Base + * @description To list all indexing jobs for a knowledge base, send a GET request to `/v2/gen-ai/indexing_jobs`. + */ + get: operations["genai_list_indexing_jobs"]; + put?: never; + /** + * Start Indexing Job for a Knowledge Base + * @description To start an indexing job for a knowledge base, send a POST request to `/v2/gen-ai/indexing_jobs`. + */ + post: operations["genai_create_indexing_job"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Data Sources for Indexing Job for a Knowledge Base + * @description To list all datasources for an indexing job, send a GET request to `/v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources`. + */ + get: operations["genai_list_indexing_job_data_sources"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/indexing_jobs/{uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Status of Indexing Job for a Knowledge Base + * @description To get status of an indexing Job for a knowledge base, send a GET request to `/v2/gen-ai/indexing_jobs/{uuid}`. + */ + get: operations["genai_get_indexing_job"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/indexing_jobs/{uuid}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Cancel Indexing Job for a Knowledge Base + * @description To cancel an indexing job for a knowledge base, send a PUT request to `/v2/gen-ai/indexing_jobs/{uuid}/cancel`. + */ + put: operations["genai_cancel_indexing_job"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/knowledge_bases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Knowledge Bases + * @description To attach a knowledge base to an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}`. + */ + get: operations["genai_list_knowledge_bases"]; + put?: never; + /** + * Create a Knowledge Base + * @description To create a knowledge base, send a POST request to `/v2/gen-ai/knowledge_bases`. + */ + post: operations["genai_create_knowledge_base"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Data Sources for a Knowledge Base + * @description To list all data sources for a knowledge base, send a GET request to `/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources`. + */ + get: operations["genai_list_knowledge_base_data_sources"]; + put?: never; + /** + * Add Data Source to a Knowledge Base + * @description To add a data source to a knowledge base, send a POST request to `/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources`. + */ + post: operations["genai_create_knowledge_base_data_source"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete a Data Source from a Knowledge Base + * @description To delete a data source from a knowledge base, send a DELETE request to `/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}`. + */ + delete: operations["genai_delete_knowledge_base_data_source"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/knowledge_bases/{uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Information About an Existing Knowledge Base + * @description To retrive information about an existing knowledge base, send a GET request to `/v2/gen-ai/knowledge_bases/{uuid}`. + */ + get: operations["genai_get_knowledge_base"]; + /** + * Update a Knowledge Base + * @description To update a knowledge base, send a PUT request to `/v2/gen-ai/knowledge_bases/{uuid}`. + */ + put: operations["genai_update_knowledge_base"]; + post?: never; + /** + * Delete a Knowledge Base + * @description To delete a knowledge base, send a DELETE request to `/v2/gen-ai/knowledge_bases/{uuid}`. + */ + delete: operations["genai_delete_knowledge_base"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/models": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Available Models + * @description To list all models, send a GET request to `/v2/gen-ai/models`. + */ + get: operations["genai_list_models"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/regions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Datacenter Regions + * @description To list all datacenter regions, send a GET request to `/v2/gen-ai/regions`. + */ + get: operations["genai_list_datacenter_regions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: { + error: { /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 + * @description A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found." + * @example not_found */ - id?: number; + id: string; /** - * @description The current status of the action. This can be "in-progress", "completed", or "errored". - * @default in-progress - * @example completed - * @enum {string} + * @description A message providing additional information about the error, including details to help resolve it when possible. + * @example The resource you were accessing could not be found. */ - status: "in-progress" | "completed" | "errored"; + message: string; /** - * @description This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. - * @example create + * @description Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue. + * @example 4d9d8375-3c56-4925-a3e7-eb137fed17e9 */ - type?: string; + request_id?: string; + }; + oneClicks: { /** - * Format: date-time - * @description A time value given in ISO8601 combined date and time format that represents when the action was initiated. - * @example 2020-11-14T16:29:21Z + * slug + * @description The slug identifier for the 1-Click application. + * @example monitoring */ - started_at?: string; + slug: string; /** - * Format: date-time - * @description A time value given in ISO8601 combined date and time format that represents when the action was completed. - * @example 2020-11-14T16:30:06Z + * type + * @description The type of the 1-Click application. + * @example kubernetes */ - completed_at?: string | null; + type: string; + }; + oneClicks_create: { /** - * @description A unique identifier for the resource that the action is associated with. - * @example 3164444 + * addon_slugs + * @description An array of 1-Click Application slugs to be installed to the Kubernetes cluster. + * @default [] + * @example [ + * "kube-state-metrics", + * "loki" + * ] */ - resource_id?: number | null; + addon_slugs: string[]; /** - * @description The type of resource that the action is associated with. - * @example droplet + * cluster_uuid + * @description A unique ID for the Kubernetes cluster to which the 1-Click Applications will be installed. + * @example 50a994b6-c303-438f-9495-7e896cfe6b08 */ - resource_type?: string; - region?: components["schemas"]["region"]; + cluster_uuid: string; + }; + account: { /** - * @description A human-readable string that is used as a unique identifier for each region. - * @example nyc3 + * @description The total number of Droplets current user or team may have active at one time. + * @example 25 */ - region_slug?: string | null; - }; - apps_deployment_job: { + droplet_limit: number; /** - * The name of this job - * @example migrate-db + * @description The total number of Floating IPs the current user or team may have. + * @example 5 */ - name?: string; + floating_ip_limit: number; /** - * The commit hash of the repository that was used to build this job - * @example 54d4a727f457231062439895000d45437c7bb405 + * @description The email address used by the current user to register for DigitalOcean. + * @example sammy@digitalocean.com */ - source_commit_hash?: string; - }; - apps_deployment_functions: { + email: string; /** - * The name of this functions component - * @example my-functions-component + * @description The display name for the current user. + * @example Sammy the Shark */ name?: string; /** - * @description The commit hash of the repository that was used to build this functions component. - * @example 54d4a727f457231062439895000d45437c7bb405 + * @description The unique universal identifier for the current user. + * @example b6fr89dbf6d9156cace5f3c78dc9851d957381ef + */ + uuid: string; + /** + * @description If true, the user has verified their account via email. False otherwise. + * @default false + * @example true + */ + email_verified: boolean; + /** + * @description This value is one of "active", "warning" or "locked". + * @default active + * @example active + * @enum {string} + */ + status: "active" | "warning" | "locked"; + /** + * @description A human-readable message giving more details about the status of the account. + * @example + */ + status_message: string; + /** @description When authorized in a team context, includes information about the current team. */ + team?: { + /** + * @description The unique universal identifier for the current team. + * @example 5df3e3004a17e242b7c20ca6c9fc25b701a47ece + */ + uuid?: string; + /** + * @description The name for the current team. + * @example My Team + */ + name?: string; + }; + }; + /** + * @description A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet. + * @example 512189 + */ + ssh_key_id: number; + /** + * @description A unique identifier that differentiates this key from other keys using a format that SSH recognizes. The fingerprint is created when the key is added to your account. + * @example 3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa + */ + ssh_key_fingerprint: string; + /** + * @description A human-readable display name for this key, used to easily identify the SSH keys when they are displayed. + * @example My SSH Public Key + */ + ssh_key_name: string; + sshKeys: { + id?: components["schemas"]["ssh_key_id"]; + fingerprint?: components["schemas"]["ssh_key_fingerprint"]; + /** + * @description The entire public key string that was uploaded. Embedded into the root user's `authorized_keys` file if you include this key during Droplet creation. + * @example ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example + */ + public_key: string; + name: components["schemas"]["ssh_key_name"]; + }; + link_to_last_page: { + /** + * @description URI of the last page of the results. + * @example https://api.digitalocean.com/v2/images?page=2 + */ + last?: string; + }; + link_to_next_page: { + /** + * @description URI of the next page of the results. + * @example https://api.digitalocean.com/v2/images?page=2 + */ + next?: string; + }; + forward_links: components["schemas"]["link_to_last_page"] & components["schemas"]["link_to_next_page"]; + link_to_first_page: { + /** + * @description URI of the first page of the results. + * @example https://api.digitalocean.com/v2/images?page=1 + */ + first?: string; + }; + link_to_prev_page: { + /** + * @description URI of the previous page of the results. + * @example https://api.digitalocean.com/v2/images?page=1 + */ + prev?: string; + }; + backward_links: components["schemas"]["link_to_first_page"] & components["schemas"]["link_to_prev_page"]; + page_links: { + /** @example { + * "pages": { + * "first": "https://api.digitalocean.com/v2/account/keys?page=1", + * "prev": "https://api.digitalocean.com/v2/account/keys?page=2" + * } + * } */ + pages?: components["schemas"]["forward_links"] | components["schemas"]["backward_links"] | unknown; + }; + pagination: { + links?: components["schemas"]["page_links"]; + }; + /** @description Information about the response itself. */ + meta_properties: { + /** + * @description Number of objects returned by the request. + * @example 1 + */ + total?: number; + }; + meta: { + meta: components["schemas"]["meta_properties"] & unknown; + }; + region: { + /** + * @description The display name of the region. This will be a full name that is used in the control panel and other interfaces. + * @example New York 3 + */ + name: string; + /** + * @description A human-readable string that is used as a unique identifier for each region. + * @example nyc3 + */ + slug: string; + /** + * @description This attribute is set to an array which contains features available in this region + * @example [ + * "private_networking", + * "backups", + * "ipv6", + * "metadata", + * "install_agent", + * "storage", + * "image_transfer" + * ] + */ + features: unknown; + /** + * @description This is a boolean value that represents whether new Droplets can be created in this region. + * @example true + */ + available: boolean; + /** + * @description This attribute is set to an array which contains the identifying slugs for the sizes available in this region. + * @example [ + * "s-1vcpu-1gb", + * "s-1vcpu-2gb", + * "s-1vcpu-3gb", + * "s-2vcpu-2gb", + * "s-3vcpu-1gb", + * "s-2vcpu-4gb", + * "s-4vcpu-8gb", + * "s-6vcpu-16gb", + * "s-8vcpu-32gb", + * "s-12vcpu-48gb", + * "s-16vcpu-64gb", + * "s-20vcpu-96gb", + * "s-24vcpu-128gb", + * "s-32vcpu-192g" + * ] + */ + sizes: unknown; + }; + action: { + /** + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 + */ + id?: number; + /** + * @description The current status of the action. This can be "in-progress", "completed", or "errored". + * @default in-progress + * @example completed + * @enum {string} + */ + status: "in-progress" | "completed" | "errored"; + /** + * @description This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action. + * @example create + */ + type?: string; + /** + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the action was initiated. + * @example 2020-11-14T16:29:21Z + */ + started_at?: string; + /** + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the action was completed. + * @example 2020-11-14T16:30:06Z + */ + completed_at?: string | null; + /** + * @description A unique identifier for the resource that the action is associated with. + * @example 3164444 + */ + resource_id?: number | null; + /** + * @description The type of resource that the action is associated with. + * @example droplet + */ + resource_type?: string; + region?: components["schemas"]["region"]; + /** + * @description A human-readable string that is used as a unique identifier for each region. + * @example nyc3 + */ + region_slug?: string | null; + }; + apps_deployment_job: { + /** + * The name of this job + * @example migrate-db + */ + name?: string; + /** + * The commit hash of the repository that was used to build this job + * @example 54d4a727f457231062439895000d45437c7bb405 + */ + source_commit_hash?: string; + }; + apps_deployment_functions: { + /** + * The name of this functions component + * @example my-functions-component + */ + name?: string; + /** + * @description The commit hash of the repository that was used to build this functions component. + * @example 54d4a727f457231062439895000d45437c7bb405 */ source_commit_hash?: string; /** @@ -7636,6 +8257,11 @@ export interface components { * @example true */ archive?: boolean; + /** + * @description A custom offline page to display when maintenance mode is enabled or the app is archived. + * @example https://example.com/offline.html + */ + offline_page_url?: string; }; /** * AppSpec @@ -13402,31 +14028,87 @@ export interface components { */ allow: string[]; }; - load_balancer_base: { + /** @description An object specifying domain configurations for a Global load balancer. */ + domains: { /** - * Format: uuid - * @description A unique ID that can be used to identify and reference a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description FQDN to associate with a Global load balancer. + * @example example.com */ - readonly id?: string; + name?: string; /** - * @description A human-readable name for a load balancer instance. - * @example example-lb-01 + * @description A boolean value indicating if the domain is already managed by DigitalOcean. If true, all A and AAAA records required to enable Global load balancers will be automatically added. + * @example true */ - name?: string; + is_managed?: boolean; /** - * @description The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The ID of the TLS certificate used for SSL termination. + * @example 892071a0-bb95-49bc-8021-3afd67a210bf */ - project_id?: string; + certificate_id?: string; + }; + /** @description An object specifying forwarding configurations for a Global load balancer. */ + glb_settings: { /** - * @description An attribute containing the public-facing IP address of the load balancer. - * @example 104.131.186.241 + * @description The protocol used for forwarding traffic from the load balancer to the target backends. The possible values are `http`, `https` and `http2`. + * @example http + * @enum {string} */ - readonly ip?: string; + target_protocol?: "http" | "https" | "http2"; /** - * @description How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions. - * @default 1 + * @description An integer representing the port on the target backends which the load balancer will forward traffic to. + * @example 80 + */ + target_port?: number; + /** @description An object specifying CDN configurations for a Global load balancer. */ + cdn?: { + /** + * @description A boolean flag to enable CDN caching. + * @example true + */ + is_enabled?: boolean; + }; + /** + * @description A map of region string to an integer priority value indicating preference for which regional target a Global load balancer will forward traffic to. A lower value indicates a higher priority. + * @example { + * "nyc1": 1, + * "fra1": 2, + * "sgp1": 3 + * } + */ + region_priorities?: { + [key: string]: number; + }; + /** + * @description An integer value as a percentage to indicate failure threshold to decide how the regional priorities will take effect. A value of `50` would indicate that the Global load balancer will choose a lower priority region to forward traffic to once this failure threshold has been reached for the higher priority region. + * @example 50 + */ + failover_threshold?: number; + }; + load_balancer_base: { + /** + * Format: uuid + * @description A unique ID that can be used to identify and reference a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + readonly id?: string; + /** + * @description A human-readable name for a load balancer instance. + * @example example-lb-01 + */ + name?: string; + /** + * @description The ID of the project that the load balancer is associated with. If no ID is provided at creation, the load balancer associates with the user's default project. If an invalid project ID is provided, the load balancer will not be created. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + project_id?: string; + /** + * @description An attribute containing the public-facing IP address of the load balancer. + * @example 104.131.186.241 + */ + readonly ip?: string; + /** + * @description How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions. + * @default 1 * @example 3 */ size_unit: number; @@ -13518,6 +14200,17 @@ export interface components { * @enum {string} */ type: "REGIONAL" | "REGIONAL_NETWORK" | "GLOBAL"; + /** @description An array of objects specifying the domain configurations for a Global load balancer. */ + domains?: components["schemas"]["domains"][]; + glb_settings?: components["schemas"]["glb_settings"]; + /** + * @description An array containing the UUIDs of the Regional load balancers to be used as target backends for a Global load balancer. + * @example [ + * "7dbf91fe-cbdb-48dc-8290-c3a181554905", + * "996fa239-fac3-42a2-b9a1-9fa822268b7a" + * ] + */ + target_load_balancer_ids?: string[]; }; load_balancer: components["schemas"]["load_balancer_base"] & { region?: unknown & components["schemas"]["region"]; @@ -13603,7 +14296,7 @@ export interface components { * @example v1/insights/droplet/cpu * @enum {string} */ - type: "v1/insights/droplet/load_1" | "v1/insights/droplet/load_5" | "v1/insights/droplet/load_15" | "v1/insights/droplet/memory_utilization_percent" | "v1/insights/droplet/disk_utilization_percent" | "v1/insights/droplet/cpu" | "v1/insights/droplet/disk_read" | "v1/insights/droplet/disk_write" | "v1/insights/droplet/public_outbound_bandwidth" | "v1/insights/droplet/public_inbound_bandwidth" | "v1/insights/droplet/private_outbound_bandwidth" | "v1/insights/droplet/private_inbound_bandwidth" | "v1/insights/lbaas/avg_cpu_utilization_percent" | "v1/insights/lbaas/connection_utilization_percent" | "v1/insights/lbaas/droplet_health" | "v1/insights/lbaas/tls_connections_per_second_utilization_percent" | "v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx" | "v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx" | "v1/insights/lbaas/increase_in_http_error_rate_count_5xx" | "v1/insights/lbaas/increase_in_http_error_rate_count_4xx" | "v1/insights/lbaas/high_http_request_response_time" | "v1/insights/lbaas/high_http_request_response_time_50p" | "v1/insights/lbaas/high_http_request_response_time_95p" | "v1/insights/lbaas/high_http_request_response_time_99p" | "v1/dbaas/alerts/load_15_alerts" | "v1/dbaas/alerts/memory_utilization_alerts" | "v1/dbaas/alerts/disk_utilization_alerts" | "v1/dbaas/alerts/cpu_alerts"; + type: "v1/insights/droplet/load_1" | "v1/insights/droplet/load_5" | "v1/insights/droplet/load_15" | "v1/insights/droplet/memory_utilization_percent" | "v1/insights/droplet/disk_utilization_percent" | "v1/insights/droplet/cpu" | "v1/insights/droplet/disk_read" | "v1/insights/droplet/disk_write" | "v1/insights/droplet/public_outbound_bandwidth" | "v1/insights/droplet/public_inbound_bandwidth" | "v1/insights/droplet/private_outbound_bandwidth" | "v1/insights/droplet/private_inbound_bandwidth" | "v1/insights/lbaas/avg_cpu_utilization_percent" | "v1/insights/lbaas/connection_utilization_percent" | "v1/insights/lbaas/droplet_health" | "v1/insights/lbaas/tls_connections_per_second_utilization_percent" | "v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx" | "v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx" | "v1/insights/lbaas/increase_in_http_error_rate_count_5xx" | "v1/insights/lbaas/increase_in_http_error_rate_count_4xx" | "v1/insights/lbaas/high_http_request_response_time" | "v1/insights/lbaas/high_http_request_response_time_50p" | "v1/insights/lbaas/high_http_request_response_time_95p" | "v1/insights/lbaas/high_http_request_response_time_99p" | "v1/dbaas/alerts/load_15_alerts" | "v1/dbaas/alerts/memory_utilization_alerts" | "v1/dbaas/alerts/disk_utilization_alerts" | "v1/dbaas/alerts/cpu_alerts" | "v1/droplet/autoscale_alerts/current_instances" | "v1/droplet/autoscale_alerts/target_instances" | "v1/droplet/autoscale_alerts/current_cpu_utilization" | "v1/droplet/autoscale_alerts/target_cpu_utilization" | "v1/droplet/autoscale_alerts/current_memory_utilization" | "v1/droplet/autoscale_alerts/target_memory_utilization" | "v1/droplet/autoscale_alerts/scale_up" | "v1/droplet/autoscale_alerts/scale_down"; /** @example 78b3da62-27e5-49ba-ac70-5db0b5935c64 */ uuid: string; /** @@ -13643,7 +14336,7 @@ export interface components { * @example v1/insights/droplet/cpu * @enum {string} */ - type: "v1/insights/droplet/load_1" | "v1/insights/droplet/load_5" | "v1/insights/droplet/load_15" | "v1/insights/droplet/memory_utilization_percent" | "v1/insights/droplet/disk_utilization_percent" | "v1/insights/droplet/cpu" | "v1/insights/droplet/disk_read" | "v1/insights/droplet/disk_write" | "v1/insights/droplet/public_outbound_bandwidth" | "v1/insights/droplet/public_inbound_bandwidth" | "v1/insights/droplet/private_outbound_bandwidth" | "v1/insights/droplet/private_inbound_bandwidth" | "v1/insights/lbaas/avg_cpu_utilization_percent" | "v1/insights/lbaas/connection_utilization_percent" | "v1/insights/lbaas/droplet_health" | "v1/insights/lbaas/tls_connections_per_second_utilization_percent" | "v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx" | "v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx" | "v1/insights/lbaas/increase_in_http_error_rate_count_5xx" | "v1/insights/lbaas/increase_in_http_error_rate_count_4xx" | "v1/insights/lbaas/high_http_request_response_time" | "v1/insights/lbaas/high_http_request_response_time_50p" | "v1/insights/lbaas/high_http_request_response_time_95p" | "v1/insights/lbaas/high_http_request_response_time_99p" | "v1/dbaas/alerts/load_15_alerts" | "v1/dbaas/alerts/memory_utilization_alerts" | "v1/dbaas/alerts/disk_utilization_alerts" | "v1/dbaas/alerts/cpu_alerts"; + type: "v1/insights/droplet/load_1" | "v1/insights/droplet/load_5" | "v1/insights/droplet/load_15" | "v1/insights/droplet/memory_utilization_percent" | "v1/insights/droplet/disk_utilization_percent" | "v1/insights/droplet/cpu" | "v1/insights/droplet/disk_read" | "v1/insights/droplet/disk_write" | "v1/insights/droplet/public_outbound_bandwidth" | "v1/insights/droplet/public_inbound_bandwidth" | "v1/insights/droplet/private_outbound_bandwidth" | "v1/insights/droplet/private_inbound_bandwidth" | "v1/insights/lbaas/avg_cpu_utilization_percent" | "v1/insights/lbaas/connection_utilization_percent" | "v1/insights/lbaas/droplet_health" | "v1/insights/lbaas/tls_connections_per_second_utilization_percent" | "v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx" | "v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx" | "v1/insights/lbaas/increase_in_http_error_rate_count_5xx" | "v1/insights/lbaas/increase_in_http_error_rate_count_4xx" | "v1/insights/lbaas/high_http_request_response_time" | "v1/insights/lbaas/high_http_request_response_time_50p" | "v1/insights/lbaas/high_http_request_response_time_95p" | "v1/insights/lbaas/high_http_request_response_time_99p" | "v1/dbaas/alerts/load_15_alerts" | "v1/dbaas/alerts/memory_utilization_alerts" | "v1/dbaas/alerts/disk_utilization_alerts" | "v1/dbaas/alerts/cpu_alerts" | "v1/droplet/autoscale_alerts/current_instances" | "v1/droplet/autoscale_alerts/target_instances" | "v1/droplet/autoscale_alerts/current_cpu_utilization" | "v1/droplet/autoscale_alerts/target_cpu_utilization" | "v1/droplet/autoscale_alerts/current_memory_utilization" | "v1/droplet/autoscale_alerts/target_memory_utilization" | "v1/droplet/autoscale_alerts/scale_up" | "v1/droplet/autoscale_alerts/scale_down"; /** * Format: float * @example 80 @@ -14907,729 +15600,1614 @@ export interface components { period?: "2m" | "3m" | "5m" | "10m" | "15m" | "30m" | "1h"; }; alert: components["schemas"]["alert_base"] & components["schemas"]["alert_updatable"]; - }; - responses: { - /** @description Unexpected error */ - unexpected_error: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; + /** @description A Chatbot */ + apiChatbot: { + /** @example "example string" */ + button_background_color?: string; + /** @example "example string" */ + logo?: string; + /** + * @description Name of chatbot + * @example "example name" + */ + name?: string; + /** @example "example string" */ + primary_color?: string; + /** @example "example string" */ + secondary_color?: string; + /** @example "example string" */ + starting_message?: string; }; - /** @description A JSON object with a key of `1_clicks`. */ - oneClicks_all: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - "1_clicks"?: components["schemas"]["oneClicks"][]; - }; - }; + /** @description Agent Chatbot Identifier */ + apiAgentChatbotIdentifier: { + /** + * @description Agent chatbot identifier + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + agent_chatbot_identifier?: string; }; - /** @description Unauthorized */ - unauthorized: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; + /** + * @default STATUS_UNKNOWN + * @example STATUS_UNKNOWN + * @enum {string} + */ + apiDeploymentStatus: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | "STATUS_RUNNING" | "STATUS_FAILED" | "STATUS_WAITING_FOR_UNDEPLOYMENT" | "STATUS_UNDEPLOYING" | "STATUS_UNDEPLOYMENT_FAILED" | "STATUS_DELETED"; + /** + * @description - VISIBILITY_UNKNOWN: The status of the deployment is unknown + * - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests + * - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state + * - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet + * - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys + * @default VISIBILITY_UNKNOWN + * @example VISIBILITY_UNKNOWN + * @enum {string} + */ + apiDeploymentVisibility: "VISIBILITY_UNKNOWN" | "VISIBILITY_DISABLED" | "VISIBILITY_PLAYGROUND" | "VISIBILITY_PUBLIC" | "VISIBILITY_PRIVATE"; + /** @description Description of deployment */ + apiDeployment: { + /** + * Format: date-time + * @description Creation date / time + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** + * @description Name + * @example "example name" + */ + name?: string; + status?: components["schemas"]["apiDeploymentStatus"]; + /** + * Format: date-time + * @description Last modified + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Access your deployed agent here + * @example "example string" + */ + url?: string; + /** + * @description Unique id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid?: string; + visibility?: components["schemas"]["apiDeploymentVisibility"]; }; - /** @description API Rate limit exceeded */ - too_many_requests: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; + /** @description Agreement Description */ + apiAgreement: { + /** @example "example string" */ + description?: string; + /** @example "example name" */ + name?: string; + /** @example "example string" */ + url?: string; + /** @example "123e4567-e89b-12d3-a456-426614174000" */ + uuid?: string; }; - /** @description Server error. */ - server_error: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; + /** + * @default MODEL_PROVIDER_DIGITALOCEAN + * @example MODEL_PROVIDER_DIGITALOCEAN + * @enum {string} + */ + apiModelProvider: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC"; + /** @description Version Information about a Model */ + apiModelVersion: { + /** + * Format: int64 + * @description Major version number + * @example 123 + */ + major?: number; + /** + * Format: int64 + * @description Minor version number + * @example 123 + */ + minor?: number; + /** + * Format: int64 + * @description Patch version number + * @example 123 + */ + patch?: number; }; - /** @description The response will verify that a job has been successfully created to install a 1-Click. The - * post-installation lifecycle of a 1-Click application can not be managed via the DigitalOcean - * API. For additional details specific to the 1-Click, find and view its - * [DigitalOcean Marketplace](https://marketplace.digitalocean.com) page. - * */ - oneClicks_create: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - /** - * @description A message about the result of the request. - * @example Successfully kicked off addon job. - */ - message?: string; - }; - }; + /** @description Description of a Model */ + apiModel: { + agreement?: components["schemas"]["apiAgreement"]; + /** + * Format: date-time + * @description Creation date / time + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** + * @description Internally used name + * @example "example name" + */ + inference_name?: string; + /** + * @description Internally used version + * @example "example string" + */ + inference_version?: string; + /** + * @description True if it is a foundational model provided by do + * @example true + */ + is_foundational?: boolean; + /** @description Additional meta data */ + metadata?: Record; + /** + * @description Name of the model + * @example "example name" + */ + name?: string; + /** + * @description Unique id of the model, this model is based on + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + parent_uuid?: string; + provider?: components["schemas"]["apiModelProvider"]; + /** + * Format: date-time + * @description Last modified + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Model has been fully uploaded + * @example true + */ + upload_complete?: boolean; + /** + * @description Download url + * @example "example string" + */ + url?: string; + /** + * @description Unique id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid?: string; + version?: components["schemas"]["apiModelVersion"]; }; - /** @description A JSON object keyed on account with an excerpt of the current user account data. */ - account: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - account?: components["schemas"]["account"]; - }; - }; + /** + * @default BATCH_JOB_PHASE_UNKNOWN + * @example BATCH_JOB_PHASE_UNKNOWN + * @enum {string} + */ + apiBatchJobPhase: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | "BATCH_JOB_PHASE_SUCCEEDED" | "BATCH_JOB_PHASE_FAILED" | "BATCH_JOB_PHASE_ERROR"; + /** @description IndexingJob description */ + apiIndexingJob: { + /** + * Format: int64 + * @description Number of datasources indexed completed + * @example 123 + */ + completed_datasources?: number; + /** + * Format: date-time + * @description Creation date / time + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** @example [ + * "example string" + * ] */ + data_source_uuids?: string[]; + /** + * Format: date-time + * @example 2023-01-01T00:00:00Z + */ + finished_at?: string; + /** + * @description Knowledge base id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + knowledge_base_uuid?: string; + phase?: components["schemas"]["apiBatchJobPhase"]; + /** + * Format: date-time + * @example 2023-01-01T00:00:00Z + */ + started_at?: string; + /** + * Format: int64 + * @description Number of tokens + * @example 123 + */ + tokens?: number; + /** + * Format: int64 + * @description Number of datasources being indexed + * @example 123 + */ + total_datasources?: number; + /** + * Format: date-time + * @description Last modified + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Unique id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid?: string; }; - /** @description A JSON object with the key set to `ssh_keys`. The value is an array of `ssh_key` objects, each of which contains the standard `ssh_key` attributes. */ - sshKeys_all: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - ssh_keys?: components["schemas"]["sshKeys"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; - }; - /** @description The response body will be a JSON object with a key set to `ssh_key`. */ - sshKeys_new: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - ssh_key?: components["schemas"]["sshKeys"]; - }; - }; + /** @description Knowledgebase Description */ + apiKnowledgeBase: { + /** + * Format: date-time + * @description Time when the knowledge base was added to the agent + * @example 2023-01-01T00:00:00Z + */ + added_to_agent_at?: string; + /** + * Format: date-time + * @description Creation date / time + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** @example "123e4567-e89b-12d3-a456-426614174000" */ + database_id?: string; + /** @example "123e4567-e89b-12d3-a456-426614174000" */ + embedding_model_uuid?: string; + /** + * @description Whether the knowledge base is public or not + * @example true + */ + is_public?: boolean; + last_indexing_job?: components["schemas"]["apiIndexingJob"]; + /** + * @description Name of knowledge base + * @example "example name" + */ + name?: string; + /** @example "123e4567-e89b-12d3-a456-426614174000" */ + project_id?: string; + /** + * @description Region code + * @example "example string" + */ + region?: string; + /** + * @description Tags to organize related resources + * @example [ + * "example string" + * ] + */ + tags?: string[]; + /** + * Format: date-time + * @description Last modified + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * Format: int64 + * @description Id of user that created the knowledge base + * @example "12345" + */ + user_id?: string; + /** + * @description Unique id for knowledge base + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid?: string; }; - /** @description A JSON object with the key set to `ssh_key`. The value is an `ssh_key` object containing the standard `ssh_key` attributes. */ - sshKeys_existing: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - ssh_key?: components["schemas"]["sshKeys"]; - }; - }; + /** @description Represents an AgentTemplate entity */ + apiAgentTemplate: { + /** + * Format: date-time + * @description The agent template's creation date + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** + * @description Description of the agent template + * @example "example string" + */ + description?: string; + /** + * @description Instructions for the agent template + * @example "example string" + */ + instruction?: string; + /** + * Format: int64 + * @description The 'k' value for the agent template + * @example 123 + */ + k?: number; + /** @description List of knowledge bases associated with the agent template */ + knowledge_bases?: components["schemas"]["apiKnowledgeBase"][]; + /** + * Format: int64 + * @description The max_tokens setting for the agent template + * @example 123 + */ + max_tokens?: number; + model?: components["schemas"]["apiModel"]; + /** + * @description Name of the agent template + * @example "example name" + */ + name?: string; + /** + * Format: float + * @description The temperature setting for the agent template + * @example 123 + */ + temperature?: number; + /** + * Format: float + * @description The top_p setting for the agent template + * @example 123 + */ + top_p?: number; + /** + * Format: date-time + * @description The agent template's last updated date + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Unique id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid?: string; }; - /** @description The resource was not found. */ - not_found: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; + /** @description A GenAI Agent's configuration */ + apiAgentPublic: { + chatbot?: components["schemas"]["apiChatbot"]; + /** @description Chatbot identifiers */ + chatbot_identifiers?: components["schemas"]["apiAgentChatbotIdentifier"][]; + /** + * Format: date-time + * @description Creation date / time + * @example 2021-01-01T00:00:00Z + */ + created_at?: string; + deployment?: components["schemas"]["apiDeployment"]; + /** + * @description Description of agent + * @example This is a chatbot that can help you with your questions. + */ + description?: string; + /** + * @description Instructions to the agent on how to use the route + * @example if talking about the weather use this route + */ + if_case?: string; + /** + * @description Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. + * @example Hello, how can I help you? + */ + instruction?: string; + /** + * Format: int64 + * @description How many results should be considered from an attached knowledge base + * @example 5 + */ + k?: number; + /** + * Format: int64 + * @description Specifies the maximum number of tokens the model can process in a single input or output, set as a number between 1 and 512. This determines the length of each response. + * @example 100 + */ + max_tokens?: number; + model?: components["schemas"]["apiModel"]; + /** + * @description Agent name + * @example My Agent + */ + name?: string; + /** + * @description The DigitalOcean project ID associated with the agent + * @example 12345678-1234-1234-1234-123456789012 + */ + project_id?: string; + /** + * @description Region code + * @example "tor1" + */ + region?: string; + /** + * Format: date-time + * @description Creation of route date / time + * @example 2021-01-01T00:00:00Z + */ + route_created_at?: string; + /** + * Format: uint64 + * @description Id of user that created the route + * @example 12345678 + */ + route_created_by?: string; + /** + * @description Route name + * @example Route Name + */ + route_name?: string; + /** + * @description Route uuid + * @example "12345678-1234-1234-1234-123456789012" + */ + route_uuid?: string; + /** + * @description A set of abitrary tags to organize your agent + * @example [ + * "example string" + * ] + */ + tags?: string[]; + /** + * Format: float + * @description Controls the model’s creativity, specified as a number between 0 and 1. Lower values produce more predictable and conservative responses, while higher values encourage creativity and variation. + * @example 0.5 + */ + temperature?: number; + template?: components["schemas"]["apiAgentTemplate"]; + /** + * Format: float + * @description Defines the cumulative probability threshold for word selection, specified as a number between 0 and 1. Higher values allow for more diverse outputs, while lower values ensure focused and coherent responses. + * @example 0.9 + */ + top_p?: number; + /** + * Format: date-time + * @description Last modified + * @example 2021-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Access your agent under this url + * @example https://example.com/agent + */ + url?: string; + /** + * Format: uint64 + * @description Id of user that created the agent + * @example 12345678 + */ + user_id?: string; + /** + * @description Unique agent id + * @example "12345678-1234-1234-1234-123456789012" + */ + uuid?: string; }; - /** @description The action was successful and the response body is empty. */ - no_content: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content?: never; + /** @description Information about how to reach other pages */ + apiPages: { + /** + * @description First page + * @example "example string" + */ + first?: string; + /** + * @description Last page + * @example "example string" + */ + last?: string; + /** + * @description Next page + * @example "example string" + */ + next?: string; + /** + * @description Previous page + * @example "example string" + */ + previous?: string; }; - /** @description The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard action attributes */ - actions: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - actions?: components["schemas"]["action"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + /** @description Links to other pages */ + apiLinks: { + pages?: components["schemas"]["apiPages"]; }; - /** @description The result will be a JSON object with an action key. This will be set to an action object containing the standard action attributes. */ - action: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - action?: components["schemas"]["action"]; - }; - }; + /** @description Meta information about the data set */ + apiMeta: { + /** + * Format: int64 + * @description The current page + * @example 123 + */ + page?: number; + /** + * Format: int64 + * @description Total number of pages + * @example 123 + */ + pages?: number; + /** + * Format: int64 + * @description Total amount of items over all pages + * @example 123 + */ + total?: number; }; - /** @description A JSON object with a `apps` key. This is list of object `apps`. */ - list_apps: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_response"]; - }; + /** @description List of Agents */ + apiListAgentsOutputPublic: { + /** @description Agents */ + agents?: components["schemas"]["apiAgentPublic"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; }; - /** @description A JSON or YAML of a `spec` object. */ - new_app: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["app_response"]; - }; + /** @description Parameters for Agent Creation */ + apiCreateAgentInputPublic: { + /** + * @description A text description of the agent, not used in inference + * @example "My Agent Description" + */ + description?: string; + /** + * @description Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. + * @example "You are an agent who thinks deeply about the world" + */ + instruction?: string; + /** + * @description Ids of the knowledge base(s) to attach to the agent + * @example [ + * "example string" + * ] + */ + knowledge_base_uuid?: string[]; + /** + * @description Identifier for the foundation model. + * @example "12345678-1234-1234-1234-123456789012" + */ + model_uuid?: string; + /** + * @description Agent name + * @example "My Agent" + */ + name?: string; + /** + * @description The id of the DigitalOcean project this agent will belong to + * @example "12345678-1234-1234-1234-123456789012" + */ + project_id?: string; + /** + * @description The DigitalOcean region to deploy your agent in + * @example "tor1" + */ + region?: string; + /** + * @description Agent tag to organize related resources + * @example [ + * "example string" + * ] + */ + tags?: string[]; }; - /** @description A JSON with key `app` */ - apps_get: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["app_response"]; - }; + /** @description Anthropic API Key Info */ + apiAnthropicAPIKeyInfo: { + /** + * Format: date-time + * @description Key creation date + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** + * Format: uint64 + * @description Created by user id from DO + * @example "12345" + */ + created_by?: string; + /** + * Format: date-time + * @description Key deleted date + * @example 2023-01-01T00:00:00Z + */ + deleted_at?: string; + /** + * @description Name + * @example "example name" + */ + name?: string; + /** + * Format: date-time + * @description Key last updated date + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Uuid + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid?: string; }; - /** @description A JSON object of the updated `app` */ - update_app: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["app_response"]; - }; + /** @description Agent API Key Info */ + apiAgentAPIKeyInfo: { + /** + * Format: date-time + * @description Creation date + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** + * Format: uint64 + * @description Created by + * @example "12345" + */ + created_by?: string; + /** + * Format: date-time + * @description Deleted date + * @example 2023-01-01T00:00:00Z + */ + deleted_at?: string; + /** + * @description Name + * @example "example name" + */ + name?: string; + /** @example "example string" */ + secret_key?: string; + /** + * @description Uuid + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid?: string; }; - /** @description the ID of the app deleted. */ - delete_app: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_delete_app_response"]; - }; + /** @description Agent API Key */ + apiAgentAPIKey: { + /** + * @description Api key + * @example "example string" + */ + api_key?: string; }; - /** @description A JSON object with a `deployment` key. */ - new_app_deployment: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_deployment_response"]; - }; + /** @description An Agent */ + apiAgent: { + anthropic_api_key?: components["schemas"]["apiAnthropicAPIKeyInfo"]; + /** @description Api key infos */ + api_key_infos?: components["schemas"]["apiAgentAPIKeyInfo"][]; + /** @description Api keys */ + api_keys?: components["schemas"]["apiAgentAPIKey"][]; + chatbot?: components["schemas"]["apiChatbot"]; + /** @description Chatbot identifiers */ + chatbot_identifiers?: components["schemas"]["apiAgentChatbotIdentifier"][]; + /** @description Child agents */ + child_agents?: components["schemas"]["apiAgent"][]; + /** + * Format: date-time + * @description Creation date / time + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + deployment?: components["schemas"]["apiDeployment"]; + /** + * @description Description of agent + * @example "example string" + */ + description?: string; + functions?: components["schemas"]["apiAgentFunction"][]; + /** @description The guardrails the agent is attached to */ + guardrails?: components["schemas"]["apiAgentGuardrail"][]; + /** @example "example string" */ + if_case?: string; + /** + * @description Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. + * @example "example string" + */ + instruction?: string; + /** + * Format: int64 + * @example 123 + */ + k?: number; + /** @description Knowledge bases */ + knowledge_bases?: components["schemas"]["apiKnowledgeBase"][]; + /** + * Format: int64 + * @example 123 + */ + max_tokens?: number; + model?: components["schemas"]["apiModel"]; + /** + * @description Agent name + * @example "example name" + */ + name?: string; + /** @description Parent agents */ + parent_agents?: components["schemas"]["apiAgent"][]; + /** @example "123e4567-e89b-12d3-a456-426614174000" */ + project_id?: string; + /** + * @description Region code + * @example "example string" + */ + region?: string; + /** + * Format: date-time + * @description Creation of route date / time + * @example 2023-01-01T00:00:00Z + */ + route_created_at?: string; + /** + * Format: uint64 + * @example "12345" + */ + route_created_by?: string; + /** + * @description Route name + * @example "example name" + */ + route_name?: string; + /** @example "123e4567-e89b-12d3-a456-426614174000" */ + route_uuid?: string; + /** + * @description Agent tag to organize related resources + * @example [ + * "example string" + * ] + */ + tags?: string[]; + /** + * Format: float + * @example 123 + */ + temperature?: number; + template?: components["schemas"]["apiAgentTemplate"]; + /** + * Format: float + * @example 123 + */ + top_p?: number; + /** + * Format: date-time + * @description Last modified + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Access your agent under this url + * @example "example string" + */ + url?: string; + /** + * Format: uint64 + * @description Id of user that created the agent + * @example "12345" + */ + user_id?: string; + /** + * @description Unique agent id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid?: string; }; - /** @description A JSON object with urls that point to archived logs */ - list_logs: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_get_logs_response"]; - }; + /** @description Description missing */ + apiAgentFunction: { + /** + * @description Api key + * @example "example string" + */ + api_key?: string; + /** + * Format: date-time + * @description Creation date / time + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** + * @description Agent description + * @example "example string" + */ + description?: string; + /** @example "example name" */ + faas_name?: string; + /** @example "example name" */ + faas_namespace?: string; + input_schema?: Record; + /** + * @description Name + * @example "example name" + */ + name?: string; + output_schema?: Record; + /** + * Format: date-time + * @description Last modified + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Download your agent here + * @example "example string" + */ + url?: string; + /** + * @description Unique id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid?: string; }; - /** @description A JSON object with a websocket URL that allows sending/receiving console input and output. */ - get_exec: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_get_exec_response"]; - }; + /** + * @default GUARDRAIL_TYPE_UNKNOWN + * @example GUARDRAIL_TYPE_UNKNOWN + * @enum {string} + */ + apiGuardrailType: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"; + /** @description A Agent Guardrail */ + apiAgentGuardrail: { + /** @example "123e4567-e89b-12d3-a456-426614174000" */ + agent_uuid?: string; + /** + * Format: date-time + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** @example "example string" */ + default_response?: string; + /** @example "example string" */ + description?: string; + /** @example "123e4567-e89b-12d3-a456-426614174000" */ + guardrail_uuid?: string; + /** @example true */ + is_attached?: boolean; + /** @example true */ + is_default?: boolean; + metadata?: Record; + /** @example "example name" */ + name?: string; + /** + * Format: int32 + * @example 123 + */ + priority?: number; + type?: components["schemas"]["apiGuardrailType"]; + /** + * Format: date-time + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** @example "123e4567-e89b-12d3-a456-426614174000" */ + uuid?: string; }; - /** @description A JSON object with a `deployments` key. This will be a list of all app deployments */ - existing_deployments: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_deployments_response"]; - }; + /** @description Information about a newly created Agent */ + apiCreateAgentOutput: { + agent?: components["schemas"]["apiAgent"]; }; - /** @description A JSON of the requested deployment */ - list_deployment: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_deployment_response"]; - }; + apiListAgentAPIKeysOutput: { + /** @description Api key infos */ + api_key_infos?: components["schemas"]["apiAgentAPIKeyInfo"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; }; - /** @description A JSON the `deployment` that was just cancelled. */ - cancel_deployment: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_deployment_response"]; - }; + apiCreateAgentAPIKeyInputPublic: { + /** + * @description Agent id + * @example "12345678-1234-1234-1234-123456789012" + */ + agent_uuid?: string; + /** + * @description A human friendly name to identify the key + * @example Production Key + */ + name?: string; }; - /** @description A JSON with key `instance_sizes` */ - list_instance: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_list_instance_sizes_response"]; - }; + apiCreateAgentAPIKeyOutput: { + api_key_info?: components["schemas"]["apiAgentAPIKeyInfo"]; }; - /** @description A JSON with key `instance_size` */ - get_instance: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_get_instance_size_response"]; - }; + apiUpdateAgentAPIKeyInputPublic: { + /** + * @description Agent id + * @example "12345678-1234-1234-1234-123456789012" + */ + agent_uuid?: string; + /** + * @description Api key id + * @example "12345678-1234-1234-1234-123456789012" + */ + api_key_uuid?: string; + /** + * @description Name + * @example "Production Key" + */ + name?: string; }; - /** @description A JSON object with key `regions` */ - list_regions: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_list_regions_response"]; - }; + apiUpdateAgentAPIKeyOutput: { + api_key_info?: components["schemas"]["apiAgentAPIKeyInfo"]; }; - /** @description A JSON object. */ - propose_app: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["app_propose_response"]; - }; + apiDeleteAgentAPIKeyOutput: { + api_key_info?: components["schemas"]["apiAgentAPIKeyInfo"]; }; - /** @description A JSON object with a `alerts` key. This is list of object `alerts`. */ - list_alerts: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_list_alerts_response"]; - }; + apiRegenerateAgentAPIKeyOutput: { + api_key_info?: components["schemas"]["apiAgentAPIKeyInfo"]; }; - /** @description A JSON object with an `alert` key. This is an object of type `alert`. */ - assign_alert_destinations: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["apps_alert_response"]; - }; + /** @description Information for a agent function link */ + apiLinkAgentFunctionInputPublic: { + /** + * @description Agent id + * @example "12345678-1234-1234-1234-123456789012" + */ + agent_uuid?: string; + /** + * @description Function description + * @example "My Function Description" + */ + description?: string; + /** + * @description The name of the function in the DigitalOcean functions platform + * @example "my-function" + */ + faas_name?: string; + /** + * @description The namespace of the function in the DigitalOcean functions platform + * @example "default" + */ + faas_namespace?: string; + /** + * @description Function name + * @example "My Function" + */ + function_name?: string; + /** @description Describe the input schema for the function so the agent may call it */ + input_schema?: Record; + /** @description Describe the output schema for the function so the agent handle its response */ + output_schema?: Record; }; - /** @description A JSON object with the validation results. */ - apps_validate_rollback: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - /** @description Indicates whether the app can be rolled back to the specified deployment. */ - valid?: boolean; - error?: unknown & components["schemas"]["app_rollback_validation_condition"]; - /** @description Contains a list of warnings that may cause the rollback to run under unideal circumstances. */ - warnings?: components["schemas"]["app_rollback_validation_condition"][]; - }; - }; + /** @description Information about a newly function linked agent */ + apiLinkAgentFunctionOutput: { + agent?: components["schemas"]["apiAgent"]; }; - /** @description A JSON object with a `app_bandwidth_usage` key */ - get_metrics_bandwidth_usage: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["app_metrics_bandwidth_usage"]; - }; + /** @description Information about updating an agent function */ + apiUpdateAgentFunctionInputPublic: { + /** + * @description Agent id + * @example "12345678-1234-1234-1234-123456789012" + */ + agent_uuid?: string; + /** + * @description Funciton description + * @example "My Function Description" + */ + description?: string; + /** + * @description The name of the function in the DigitalOcean functions platform + * @example "my-function" + */ + faas_name?: string; + /** + * @description The namespace of the function in the DigitalOcean functions platform + * @example "default" + */ + faas_namespace?: string; + /** + * @description Function name + * @example "My Function" + */ + function_name?: string; + /** + * @description Function id + * @example "12345678-1234-1234-1234-123456789012" + */ + function_uuid?: string; + /** @description Describe the input schema for the function so the agent may call it */ + input_schema?: Record; + /** @description Describe the output schema for the function so the agent handle its response */ + output_schema?: Record; }; - /** @description A JSON object with a `app_bandwidth_usage` key */ - list_metrics_bandwidth_usage: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["app_metrics_bandwidth_usage"]; - }; + /** @description The updated agent */ + apiUpdateAgentFunctionOutput: { + agent?: components["schemas"]["apiAgent"]; }; - /** @description The result will be a JSON object with an `endpoints` key. This will be set to an array of endpoint objects, each of which will contain the standard CDN endpoint attributes. */ - all_cdn_endpoints: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - endpoints?: components["schemas"]["cdn_endpoint"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + /** @description Information about a newly unlinked agent */ + apiUnlinkAgentFunctionOutput: { + agent?: components["schemas"]["apiAgent"]; }; - /** @description The response will be a JSON object with an `endpoint` key. This will be set to an object containing the standard CDN endpoint attributes. */ - existing_endpoint: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - endpoint?: components["schemas"]["cdn_endpoint"]; - }; - }; + /** @description Information about a linked knowledge base */ + apiLinkKnowledgeBaseOutput: { + agent?: components["schemas"]["apiAgent"]; }; - /** @description The result will be a JSON object with a `certificates` key. This will be set to an array of certificate objects, each of which will contain the standard certificate attributes. */ - all_certificates: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - certificates?: components["schemas"]["certificate"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + /** @description Informatinon about a unlinked knowledge base */ + apiUnlinkKnowledgeBaseOutput: { + agent?: components["schemas"]["apiAgent"]; }; - /** @description The response will be a JSON object with a key called `certificate`. The value of this will be an object that contains the standard attributes associated with a certificate. - * When using Let's Encrypt, the initial value of the certificate's `state` attribute will be `pending`. When the certificate has been successfully issued by Let's Encrypt, this will transition to `verified` and be ready for use. */ - new_certificate: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - certificate?: components["schemas"]["certificate"]; - }; - }; + /** @description Information about updating the linkage of an agent */ + apiUpdateLinkedAgentInputPublic: { + /** + * @description Routed agent id + * @example "12345678-1234-1234-1234-123456789012" + */ + child_agent_uuid?: string; + /** + * @description Describes the case in which the child agent should be used + * @example "use this to get weather information" + */ + if_case?: string; + /** + * @description A unique identifier for the parent agent. + * @example "12345678-1234-1234-1234-123456789012" + */ + parent_agent_uuid?: string; + /** + * @description Route name + * @example "weather_route" + */ + route_name?: string; + /** + * @description Unique id of linkage + * @example "12345678-1234-1234-1234-123456789012" + */ + uuid?: string; }; - /** @description The response will be a JSON object with a `certificate` key. This will be set to an object containing the standard certificate attributes. */ - existing_certificate: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - certificate?: components["schemas"]["certificate"]; - }; - }; + /** @description Information about an updated linkage */ + apiUpdateLinkedAgentOutput: { + /** + * @description Routed agent id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + child_agent_uuid?: string; + /** + * @description A unique identifier for the parent agent. + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + parent_agent_uuid?: string; + /** + * @description Unique id of linkage + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid?: string; }; - /** @description The response will be a JSON object that contains the following attributes */ - balance: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["balance"]; - }; + /** @description Information for linking an agent */ + apiLinkAgentInputPublic: { + /** + * @description Routed agent id + * @example "12345678-1234-1234-1234-123456789012" + */ + child_agent_uuid?: string; + /** @example "use this to get weather information" */ + if_case?: string; + /** + * @description A unique identifier for the parent agent. + * @example "12345678-1234-1234-1234-123456789012" + */ + parent_agent_uuid?: string; + /** + * @description Name of route + * @example "weather_route" + */ + route_name?: string; }; - /** @description The response will be a JSON object that contains the following attributes */ - billing_history: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - billing_history?: components["schemas"]["billing_history"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta_optional_total"]; - }; + /** @description Information about a newly linked agent */ + apiLinkAgentOutput: { + /** + * @description Routed agent id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + child_agent_uuid?: string; + /** + * @description A unique identifier for the parent agent. + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + parent_agent_uuid?: string; }; - /** @description The response will be a JSON object contains that contains a list of invoices under the `invoices` key, and the invoice preview under the `invoice_preview` key. - * Each element contains the invoice summary attributes. */ - invoices: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - invoices?: components["schemas"]["invoice_preview"][]; - invoice_preview?: components["schemas"]["invoice_preview"]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + /** @description Information about a removed linkage */ + apiUnlinkAgentOutput: { + /** + * @description Routed agent id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + child_agent_uuid?: string; + /** + * @description Pagent agent id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + parent_agent_uuid?: string; }; - /** @description The response will be a JSON object with a key called `invoice_items`. This will be set to an array of invoice item objects. */ - invoice: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - invoice_items?: components["schemas"]["invoice_item"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + /** @description One Agent */ + apiGetAgentOutputPublic: { + agent?: components["schemas"]["apiAgentPublic"]; }; - /** @description The response will be a CSV file. */ - invoice_csv: { - headers: { - "content-disposition": components["headers"]["content-disposition"]; - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "text/csv": string; - }; + /** @description Data to modify an existing Agent */ + apiUpdateAgentInputPublic: { + /** + * @description Agent description + * @example "My Agent Description" + */ + description?: string; + /** + * @description Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. + * @example "You are an agent who thinks deeply about the world" + */ + instruction?: string; + /** + * Format: int64 + * @description How many results should be considered from an attached knowledge base + * @example 5 + */ + k?: number; + /** + * Format: int64 + * @description Specifies the maximum number of tokens the model can process in a single input or output, set as a number between 1 and 512. This determines the length of each response. + * @example 100 + */ + max_tokens?: number; + /** + * @description Identifier for the foundation model. + * @example "12345678-1234-1234-1234-123456789012" + */ + model_uuid?: string; + /** + * @description Agent name + * @example "My New Agent Name" + */ + name?: string; + /** + * @description The id of the DigitalOcean project this agent will belong to + * @example "12345678-1234-1234-1234-123456789012" + */ + project_id?: string; + /** + * @description A set of abitrary tags to organize your agent + * @example [ + * "example string" + * ] + */ + tags?: string[]; + /** + * Format: float + * @description Controls the model’s creativity, specified as a number between 0 and 1. Lower values produce more predictable and conservative responses, while higher values encourage creativity and variation. + * @example 0.7 + */ + temperature?: number; + /** + * Format: float + * @description Defines the cumulative probability threshold for word selection, specified as a number between 0 and 1. Higher values allow for more diverse outputs, while lower values ensure focused and coherent responses. + * @example 0.9 + */ + top_p?: number; + /** + * @description Unique agent id + * @example "12345678-1234-1234-1234-123456789012" + */ + uuid?: string; }; - /** @description The response will be a PDF file. */ - invoice_pdf: { - headers: { - "content-disposition": components["headers"]["content-disposition"]; - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/pdf": string; - }; + /** @description Information about an updated agent */ + apiUpdateAgentOutput: { + agent?: components["schemas"]["apiAgent"]; }; - /** @description To retrieve a summary for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/summary`. */ - invoice_summary: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["invoice_summary"]; - }; + /** @description Info about a deleted agent */ + apiDeleteAgentOutput: { + agent?: components["schemas"]["apiAgent"]; }; - /** @description A JSON string with a key of `options`. */ - options: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["options"]; - }; + /** @description Child list for an agent */ + apiGetChildrenOutput: { + /** @description Child agents */ + children?: components["schemas"]["apiAgent"][]; }; - /** @description A JSON object with a key of `databases`. */ - database_clusters: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - databases?: components["schemas"]["database_cluster"][]; - }; - }; + /** @description UpdateAgentDeploymentVisibilityInputPublic description */ + apiUpdateAgentDeploymentVisibilityInputPublic: { + /** + * @description Unique id + * @example "12345678-1234-1234-1234-123456789012" + */ + uuid?: string; + visibility?: components["schemas"]["apiDeploymentVisibility"]; }; - /** @description A JSON object with a key of `database`. */ - database_cluster: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - database: components["schemas"]["database_cluster"]; - }; - }; + /** @description UpdateAgentDeploymentVisbilityOutput description */ + apiUpdateAgentDeploymentVisbilityOutput: { + agent?: components["schemas"]["apiAgent"]; }; - /** @description A JSON object with a key of `config`. */ - database_config: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - config: components["schemas"]["mysql_advanced_config"] | components["schemas"]["postgres_advanced_config"] | components["schemas"]["redis_advanced_config"] | components["schemas"]["kafka_advanced_config"] | components["schemas"]["opensearch_advanced_config"] | components["schemas"]["mongo_advanced_config"]; - }; - }; + /** @description Indexing jobs */ + apiListKnowledgeBaseIndexingJobsOutput: { + /** @description The indexing jobs */ + jobs?: components["schemas"]["apiIndexingJob"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; }; - /** @description A JSON object with a key of `ca`. */ - ca: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - ca: components["schemas"]["ca"]; - }; - }; + /** @description StartKnowledgeBaseIndexingJobInputPublic description */ + apiStartKnowledgeBaseIndexingJobInputPublic: { + /** + * @description List of data source ids to index, if none are provided, all data sources will be indexed + * @example [ + * "example string" + * ] + */ + data_source_uuids?: string[]; + /** + * @description Knowledge base id + * @example "12345678-1234-1234-1234-123456789012" + */ + knowledge_base_uuid?: string; }; - /** @description A JSON object. */ - online_migration: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["online_migration"]; - }; + /** @description StartKnowledgeBaseIndexingJobOutput description */ + apiStartKnowledgeBaseIndexingJobOutput: { + job?: components["schemas"]["apiIndexingJob"]; }; - /** @description The does not indicate the success or failure of any operation, just that the request has been accepted for processing. */ - accepted: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content?: never; + apiIndexedDataSource: { + /** + * Format: date-time + * @description Timestamp when data source completed indexing + * @example 2023-01-01T00:00:00Z + */ + completed_at?: string; + /** + * @description Uuid of the indexed data source + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + data_source_uuid?: string; + /** + * Format: uint64 + * @description Total count of files that have been indexed + * @example "12345" + */ + indexed_file_count?: string; + /** + * Format: date-time + * @description Timestamp when data source started indexing + * @example 2023-01-01T00:00:00Z + */ + started_at?: string; + /** + * Format: uint64 + * @description Total size of files in data source in bytes + * @example "12345" + */ + total_bytes?: string; + /** + * Format: uint64 + * @description Total size of files in data source in bytes that have been indexed + * @example "12345" + */ + total_bytes_indexed?: string; + /** + * Format: uint64 + * @description Total file count in the data source + * @example "12345" + */ + total_file_count?: string; }; - /** @description A JSON object with a key of `rules`. */ - firewall_rules: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - rules?: components["schemas"]["firewall_rule"][]; - }; - }; + apiListIndexingJobDataSourcesOutput: { + indexed_data_sources?: components["schemas"]["apiIndexedDataSource"][]; }; - /** @description A JSON object with a key of `database_backups`. */ - database_backups: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - backups: components["schemas"]["backup"][]; - }; - }; + /** @description GetKnowledgeBaseIndexingJobOutput description */ + apiGetKnowledgeBaseIndexingJobOutput: { + job?: components["schemas"]["apiIndexingJob"]; }; - /** @description A JSON object with a key of `replicas`. */ - database_replicas: { + /** @description CancelKnowledgeBaseIndexingJobInputPublic description */ + apiCancelKnowledgeBaseIndexingJobInputPublic: { + /** + * @description A unique identifier for an indexing job. + * @example "12345678-1234-1234-1234-123456789012" + */ + uuid?: string; + }; + /** @description CancelKnowledgeBaseIndexingJobOutput description */ + apiCancelKnowledgeBaseIndexingJobOutput: { + job?: components["schemas"]["apiIndexingJob"]; + }; + /** @description List of knowledge bases */ + apiListKnowledgeBasesOutput: { + /** @description The knowledge bases */ + knowledge_bases?: components["schemas"]["apiKnowledgeBase"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; + }; + /** @description File to upload as data source for knowledge base. */ + apiFileUploadDataSource: { + /** + * @description The original file name + * @example "example name" + */ + original_file_name?: string; + /** + * Format: uint64 + * @description The size of the file in bytes + * @example "12345" + */ + size_in_bytes?: string; + /** + * @description The object key the file was stored as + * @example "example string" + */ + stored_object_key?: string; + }; + /** @description Spaces Bucket Data Source */ + apiSpacesDataSource: { + /** + * @description Spaces bucket name + * @example "example name" + */ + bucket_name?: string; + /** @example "example string" */ + item_path?: string; + /** + * @description Region of bucket + * @example "example string" + */ + region?: string; + }; + apiKBDataSource: { + /** + * @description Deprecated, moved to data_source_details + * @example "example name" + */ + bucket_name?: string; + /** + * @description Deprecated, moved to data_source_details + * @example "example string" + */ + bucket_region?: string; + file_upload_data_source?: components["schemas"]["apiFileUploadDataSource"]; + /** @example "example string" */ + item_path?: string; + spaces_data_source?: components["schemas"]["apiSpacesDataSource"]; + }; + /** @description Data to create a new knowledge base. */ + apiCreateKnowledgeBaseInputPublic: { + /** + * @description Identifier of the DigitalOcean OpenSearch database this knowledge base will use, optional. + * If not provided, we create a new database for the knowledge base in + * the same region as the knowledge base. + * @example "12345678-1234-1234-1234-123456789012" + */ + database_id?: string; + /** @description The data sources to use for this knowledge base. See [Organize Data Sources](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#spaces-buckets) for more information on data sources best practices. */ + datasources?: components["schemas"]["apiKBDataSource"][]; + /** + * @description Identifier for the [embedding model](https://docs.digitalocean.com/products/genai-platform/details/models/#embedding-models). + * @example "12345678-1234-1234-1234-123456789012" + */ + embedding_model_uuid?: string; + /** + * @description Name of the knowledge base. + * @example "My Knowledge Base" + */ + name?: string; + /** + * @description Identifier of the DigitalOcean project this knowledge base will belong to. + * @example "12345678-1234-1234-1234-123456789012" + */ + project_id?: string; + /** + * @description The datacenter region to deploy the knowledge base in. + * @example "tor1" + */ + region?: string; + /** + * @description Tags to organize your knowledge base. + * @example [ + * "example string" + * ] + */ + tags?: string[]; + /** + * @description The VPC to deploy the knowledge base database in + * @example "12345678-1234-1234-1234-123456789012" + */ + vpc_uuid?: string; + }; + /** @description Information about a newly created knowledge base */ + apiCreateKnowledgeBaseOutput: { + knowledge_base?: components["schemas"]["apiKnowledgeBase"]; + }; + /** @description Data Source configuration for Knowledge Bases */ + apiKnowledgeBaseDataSource: { + /** + * @description Name of storage bucket - Deprecated, moved to data_source_details + * @example "example name" + */ + bucket_name?: string; + /** + * Format: date-time + * @description Creation date / time + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + file_upload_data_source?: components["schemas"]["apiFileUploadDataSource"]; + /** + * @description Path of folder or object in bucket - Deprecated, moved to data_source_details + * @example "example string" + */ + item_path?: string; + last_indexing_job?: components["schemas"]["apiIndexingJob"]; + /** + * @description Region code - Deprecated, moved to data_source_details + * @example "example string" + */ + region?: string; + spaces_data_source?: components["schemas"]["apiSpacesDataSource"]; + /** + * Format: date-time + * @description Last modified + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Unique id of knowledge base + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid?: string; + }; + /** @description A list of knowledge base data sources */ + apiListKnowledgeBaseDataSourcesOutput: { + /** @description The data sources */ + knowledge_base_data_sources?: components["schemas"]["apiKnowledgeBaseDataSource"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; + }; + /** @description Data to create a knowledge base data source */ + apiCreateKnowledgeBaseDataSourceInputPublic: { + file_upload_data_source?: components["schemas"]["apiFileUploadDataSource"]; + /** + * @description Knowledge base id + * @example "12345678-1234-1234-1234-123456789012" + */ + knowledge_base_uuid?: string; + spaces_data_source?: components["schemas"]["apiSpacesDataSource"]; + }; + /** @description Information about a newly created knowldege base data source */ + apiCreateKnowledgeBaseDataSourceOutput: { + knowledge_base_data_source?: components["schemas"]["apiKnowledgeBaseDataSource"]; + }; + /** @description Information about a newly deleted knowledge base data source */ + apiDeleteKnowledgeBaseDataSourceOutput: { + /** + * @description Data source id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + data_source_uuid?: string; + /** + * @description Knowledge base id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + knowledge_base_uuid?: string; + }; + /** + * @default CREATING + * @example CREATING + * @enum {string} + */ + dbaasClusterStatus: "CREATING" | "ONLINE" | "POWEROFF" | "REBUILDING" | "REBALANCING" | "DECOMMISSIONED" | "FORKING" | "MIGRATING" | "RESIZING" | "RESTORING" | "POWERING_ON" | "UNHEALTHY"; + /** @description The knowledge base */ + apiGetKnowledgeBaseOutput: { + database_status?: components["schemas"]["dbaasClusterStatus"]; + knowledge_base?: components["schemas"]["apiKnowledgeBase"]; + }; + /** @description Information about updating a knowledge base */ + apiUpdateKnowledgeBaseInputPublic: { + /** + * @description The id of the DigitalOcean database this knowledge base will use, optiona. + * @example "12345678-1234-1234-1234-123456789012" + */ + database_id?: string; + /** + * @description Identifier for the foundation model. + * @example "12345678-1234-1234-1234-123456789012" + */ + embedding_model_uuid?: string; + /** + * @description Knowledge base name + * @example "My Knowledge Base" + */ + name?: string; + /** + * @description The id of the DigitalOcean project this knowledge base will belong to + * @example "12345678-1234-1234-1234-123456789012" + */ + project_id?: string; + /** + * @description Tags to organize your knowledge base. + * @example [ + * "example string" + * ] + */ + tags?: string[]; + /** + * @description Knowledge base id + * @example "12345678-1234-1234-1234-123456789012" + */ + uuid?: string; + }; + /** @description Information about an updated knowledge base */ + apiUpdateKnowledgeBaseOutput: { + knowledge_base?: components["schemas"]["apiKnowledgeBase"]; + }; + /** @description Information about a deleted knowledge base */ + apiDeleteKnowledgeBaseOutput: { + /** + * @description The id of the deleted knowledge base + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid?: string; + }; + /** @description A machine learning model stored on the GenAI platform */ + apiModelPublic: { + agreement?: components["schemas"]["apiAgreement"]; + /** + * Format: date-time + * @description Creation date / time + * @example 2021-01-01T00:00:00Z + */ + created_at?: string; + /** + * @description True if it is a foundational model provided by do + * @example true + */ + is_foundational?: boolean; + /** + * @description Name of the model + * @example Llama 3.3 (70b) + */ + name?: string; + /** + * @description Unique id of the model, this model is based on + * @example "12345678-1234-1234-1234-123456789012" + */ + parent_uuid?: string; + /** + * Format: date-time + * @description Last modified + * @example 2021-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Model has been fully uploaded + * @example true + */ + upload_complete?: boolean; + /** + * @description Download url + * @example https://example.com/model.zip + */ + url?: string; + /** + * @description Unique id + * @example "12345678-1234-1234-1234-123456789012" + */ + uuid?: string; + version?: components["schemas"]["apiModelVersion"]; + }; + /** @description A list of models */ + apiListModelsOutputPublic: { + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; + /** @description The models */ + models?: components["schemas"]["apiModelPublic"][]; + }; + /** @description Description for a specific Region */ + genaiapiRegion: { + /** + * @description Url for inference server + * @example "example string" + */ + inference_url?: string; + /** + * @description Region code + * @example "example string" + */ + region?: string; + /** + * @description This datacenter is capable of running batch jobs + * @example true + */ + serves_batch?: boolean; + /** + * @description This datacenter is capable of serving inference + * @example true + */ + serves_inference?: boolean; + /** + * @description The url for the inference streaming server + * @example "example string" + */ + stream_inference_url?: string; + }; + /** @description Region Codes */ + apiListRegionsOutput: { + /** @description Region code */ + regions?: components["schemas"]["genaiapiRegion"][]; + }; + }; + responses: { + /** @description Unexpected error */ + unexpected_error: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15637,13 +17215,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - replicas?: components["schemas"]["database_replica"][]; - }; + "application/json": components["schemas"]["error"]; }; }; - /** @description A JSON object with a key of `replica`. */ - database_replica: { + /** @description A JSON object with a key of `1_clicks`. */ + oneClicks_all: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15652,12 +17228,12 @@ export interface components { }; content: { "application/json": { - replica?: components["schemas"]["database_replica"]; + "1_clicks"?: components["schemas"]["oneClicks"][]; }; }; }; - /** @description A JSON object with a key of `events`. */ - events_logs: { + /** @description Unauthorized */ + unauthorized: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15665,13 +17241,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - events?: components["schemas"]["events_logs"][]; - }; + "application/json": components["schemas"]["error"]; }; }; - /** @description A JSON object with a key of `users`. */ - users: { + /** @description API Rate limit exceeded */ + too_many_requests: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15679,13 +17253,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - users?: components["schemas"]["database_user"][]; - }; + "application/json": components["schemas"]["error"]; }; }; - /** @description A JSON object with a key of `user`. */ - user: { + /** @description Server error. */ + server_error: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15693,13 +17265,15 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - user: components["schemas"]["database_user"]; - }; + "application/json": components["schemas"]["error"]; }; }; - /** @description A JSON object with a key of `databases`. */ - databases: { + /** @description The response will verify that a job has been successfully created to install a 1-Click. The + * post-installation lifecycle of a 1-Click application can not be managed via the DigitalOcean + * API. For additional details specific to the 1-Click, find and view its + * [DigitalOcean Marketplace](https://marketplace.digitalocean.com) page. + * */ + oneClicks_create: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15708,12 +17282,16 @@ export interface components { }; content: { "application/json": { - dbs?: components["schemas"]["database"][]; + /** + * @description A message about the result of the request. + * @example Successfully kicked off addon job. + */ + message?: string; }; }; }; - /** @description A JSON object with a key of `db`. */ - database: { + /** @description A JSON object keyed on account with an excerpt of the current user account data. */ + account: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15722,12 +17300,12 @@ export interface components { }; content: { "application/json": { - db: components["schemas"]["database"]; + account?: components["schemas"]["account"]; }; }; }; - /** @description A JSON object with a key of `pools`. */ - connection_pools: { + /** @description A JSON object with the key set to `ssh_keys`. The value is an array of `ssh_key` objects, each of which contains the standard `ssh_key` attributes. */ + sshKeys_all: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15735,11 +17313,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["connection_pools"]; + "application/json": { + ssh_keys?: components["schemas"]["sshKeys"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description A JSON object with a key of `pool`. */ - connection_pool: { + /** @description The response body will be a JSON object with a key set to `ssh_key`. */ + sshKeys_new: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15748,12 +17328,12 @@ export interface components { }; content: { "application/json": { - pool: components["schemas"]["connection_pool"]; + ssh_key?: components["schemas"]["sshKeys"]; }; }; }; - /** @description A JSON string with a key of `eviction_policy`. */ - eviction_policy_response: { + /** @description A JSON object with the key set to `ssh_key`. The value is an `ssh_key` object containing the standard `ssh_key` attributes. */ + sshKeys_existing: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15762,12 +17342,12 @@ export interface components { }; content: { "application/json": { - eviction_policy: components["schemas"]["eviction_policy_model"]; + ssh_key?: components["schemas"]["sshKeys"]; }; }; }; - /** @description A JSON string with a key of `sql_mode`. */ - sql_mode: { + /** @description The resource was not found. */ + not_found: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15775,25 +17355,21 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["sql_mode"]; + "application/json": components["schemas"]["error"]; }; }; - /** @description A JSON object with a key of `topics`. */ - kafka_topics: { + /** @description The action was successful and the response body is empty. */ + no_content: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; "ratelimit-reset": components["headers"]["ratelimit-reset"]; [name: string]: unknown; }; - content: { - "application/json": { - topics?: components["schemas"]["kafka_topic"][]; - }; - }; + content?: never; }; - /** @description A JSON object with a key of `topic`. */ - kafka_topic: { + /** @description The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard action attributes */ + actions: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15802,12 +17378,12 @@ export interface components { }; content: { "application/json": { - topic?: components["schemas"]["kafka_topic_verbose"]; - }; + actions?: components["schemas"]["action"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description A JSON object with a key of `sinks`. */ - logsinks: { + /** @description The result will be a JSON object with an action key. This will be set to an action object containing the standard action attributes. */ + action: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15816,12 +17392,12 @@ export interface components { }; content: { "application/json": { - sinks?: components["schemas"]["logsink_verbose"][]; + action?: components["schemas"]["action"]; }; }; }; - /** @description A JSON object with a key of `sink`. */ - logsink: { + /** @description A JSON object with a `apps` key. This is list of object `apps`. */ + list_apps: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15829,13 +17405,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - sink?: components["schemas"]["logsink_verbose"]; - }; + "application/json": components["schemas"]["apps_response"]; }; }; - /** @description A JSON object with a key of `credentials`. */ - database_metrics_auth: { + /** @description A JSON or YAML of a `spec` object. */ + new_app: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15843,13 +17417,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - credentials?: components["schemas"]["database_metrics_credentials"]; - }; + "application/json": components["schemas"]["app_response"]; }; }; - /** @description A JSON object with a key of `indexes`. */ - opensearch_indexes: { + /** @description A JSON with key `app` */ + apps_get: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15857,13 +17429,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - indexes?: components["schemas"]["opensearch_index"][]; - }; + "application/json": components["schemas"]["app_response"]; }; }; - /** @description The response will be a JSON object with a key called `domains`. The value of this will be an array of Domain objects, each of which contain the standard domain attributes. */ - all_domains_response: { + /** @description A JSON object of the updated `app` */ + update_app: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15871,14 +17441,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - /** @description Array of volumes. */ - domains: components["schemas"]["domain"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["app_response"]; }; }; - /** @description The response will be a JSON object with a key called `domain`. The value of this will be an object that contains the standard attributes associated with a domain. */ - create_domain_response: { + /** @description the ID of the app deleted. */ + delete_app: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15886,13 +17453,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - domain?: components["schemas"]["domain"]; - }; + "application/json": components["schemas"]["apps_delete_app_response"]; }; }; - /** @description The response will be a JSON object with a key called `domain`. The value of this will be an object that contains the standard attributes defined for a domain. */ - existing_domain: { + /** @description A JSON object with a `deployment` key. */ + new_app_deployment: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15900,13 +17465,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - domain?: components["schemas"]["domain"]; - }; + "application/json": components["schemas"]["apps_deployment_response"]; }; }; - /** @description The response will be a JSON object with a key called `domain_records`. The value of this will be an array of domain record objects, each of which contains the standard domain record attributes. For attributes that are not used by a specific record type, a value of `null` will be returned. For instance, all records other than SRV will have `null` for the `weight` and `port` attributes. */ - all_domain_records_response: { + /** @description A JSON object with urls that point to archived logs */ + list_logs: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15914,13 +17477,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - domain_records?: components["schemas"]["domain_record"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["apps_get_logs_response"]; }; }; - /** @description The response body will be a JSON object with a key called `domain_record`. The value of this will be an object representing the new record. Attributes that are not applicable for the record type will be set to `null`. An `id` attribute is generated for each record as part of the object. */ - created_domain_record: { + /** @description A JSON object with a websocket URL that allows sending/receiving console input and output. */ + get_exec: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15928,13 +17489,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - domain_record?: components["schemas"]["domain_record"]; - }; + "application/json": components["schemas"]["apps_get_exec_response"]; }; }; - /** @description The response will be a JSON object with a key called `domain_record`. The value of this will be a domain record object which contains the standard domain record attributes. */ - domain_record: { + /** @description A JSON object with a `deployments` key. This will be a list of all app deployments */ + existing_deployments: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15942,13 +17501,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - domain_record?: components["schemas"]["domain_record"]; - }; + "application/json": components["schemas"]["apps_deployments_response"]; }; }; - /** @description A JSON object with a key of `droplets`. */ - all_droplets: { + /** @description A JSON of the requested deployment */ + list_deployment: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15956,13 +17513,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - droplets?: components["schemas"]["droplet"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["apps_deployment_response"]; }; }; - /** @description Accepted */ - droplet_create: { + /** @description A JSON the `deployment` that was just cancelled. */ + cancel_deployment: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -15970,34 +17525,23 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - droplet: components["schemas"]["droplet"]; - links: { - actions?: components["schemas"]["action_link"][]; - }; - } | { - droplets: components["schemas"]["droplet"][]; - links: { - actions?: components["schemas"]["action_link"][]; - }; - }; + "application/json": components["schemas"]["apps_deployment_response"]; }; }; - /** @description The action was successful and the response body is empty. This response has content-type set. */ - no_content_with_content_type: { + /** @description A JSON with key `instance_sizes` */ + list_instance: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; "ratelimit-reset": components["headers"]["ratelimit-reset"]; - "content-type": components["headers"]["content-type"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["apps_list_instance_sizes_response"]; + }; }; - /** @description The response will be a JSON object with a key called `droplet`. This will be - * set to a JSON object that contains the standard Droplet attributes. - * */ - existing_droplet: { + /** @description A JSON with key `instance_size` */ + get_instance: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16005,13 +17549,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - droplet?: components["schemas"]["droplet"]; - }; + "application/json": components["schemas"]["apps_get_instance_size_response"]; }; }; - /** @description A JSON object with an `backups` key. */ - all_droplet_backups: { + /** @description A JSON object with key `regions` */ + list_regions: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16019,15 +17561,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - backups?: components["schemas"]["droplet_snapshot"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["apps_list_regions_response"]; }; }; - /** @description The response will be a JSON object with a key called `policy`. This will be - * set to a JSON object that contains the standard Droplet backup policy attributes. - * */ - droplet_backup_policy: { + /** @description A JSON object. */ + propose_app: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16035,13 +17573,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - policy?: components["schemas"]["droplet_backup_policy_record"]; - }; + "application/json": components["schemas"]["app_propose_response"]; }; }; - /** @description A JSON object with a `policies` key set to a map. The keys are Droplet IDs and the values are objects containing the backup policy information for each Droplet. */ - all_droplet_backup_policies: { + /** @description A JSON object with a `alerts` key. This is list of object `alerts`. */ + list_alerts: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16049,18 +17585,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - /** @description A map where the keys are the Droplet IDs and the values are - * objects containing the backup policy information for each Droplet. - * */ - policies?: { - [key: string]: components["schemas"]["droplet_backup_policy_record"]; - }; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["apps_list_alerts_response"]; }; }; - /** @description A JSON object with an `supported_policies` key set to an array of objects describing each supported backup policy. */ - droplets_supported_backup_policies: { + /** @description A JSON object with an `alert` key. This is an object of type `alert`. */ + assign_alert_destinations: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16068,13 +17597,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - supported_policies?: components["schemas"]["supported_droplet_backup_policy"][]; - }; + "application/json": components["schemas"]["apps_alert_response"]; }; }; - /** @description A JSON object with an `snapshots` key. */ - all_droplet_snapshots: { + /** @description A JSON object with the validation results. */ + apps_validate_rollback: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16083,12 +17610,16 @@ export interface components { }; content: { "application/json": { - snapshots?: components["schemas"]["droplet_snapshot"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + /** @description Indicates whether the app can be rolled back to the specified deployment. */ + valid?: boolean; + error?: unknown & components["schemas"]["app_rollback_validation_condition"]; + /** @description Contains a list of warnings that may cause the rollback to run under unideal circumstances. */ + warnings?: components["schemas"]["app_rollback_validation_condition"][]; + }; }; }; - /** @description A JSON object with an `actions` key. */ - all_droplet_actions: { + /** @description A JSON object with a `app_bandwidth_usage` key */ + get_metrics_bandwidth_usage: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16096,13 +17627,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - actions?: components["schemas"]["action"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["app_metrics_bandwidth_usage"]; }; }; - /** @description The response will be a JSON object with a key called `action`. */ - droplet_action: { + /** @description A JSON object with a `app_bandwidth_usage` key */ + list_metrics_bandwidth_usage: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16110,13 +17639,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - action?: components["schemas"]["action"]; - }; + "application/json": components["schemas"]["app_metrics_bandwidth_usage"]; }; }; - /** @description The response will be a JSON object with a key called `actions`. */ - droplet_actions_response: { + /** @description The result will be a JSON object with an `endpoints` key. This will be set to an array of endpoint objects, each of which will contain the standard CDN endpoint attributes. */ + all_cdn_endpoints: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16125,12 +17652,12 @@ export interface components { }; content: { "application/json": { - actions?: components["schemas"]["action"][]; - }; + endpoints?: components["schemas"]["cdn_endpoint"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description A JSON object that has a key called `kernels`. */ - all_kernels: { + /** @description The response will be a JSON object with an `endpoint` key. This will be set to an object containing the standard CDN endpoint attributes. */ + existing_endpoint: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16139,12 +17666,12 @@ export interface components { }; content: { "application/json": { - kernels?: components["schemas"]["kernel"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + endpoint?: components["schemas"]["cdn_endpoint"]; + }; }; }; - /** @description A JSON object that has a key called `firewalls`. */ - all_firewalls: { + /** @description The result will be a JSON object with a `certificates` key. This will be set to an array of certificate objects, each of which will contain the standard certificate attributes. */ + all_certificates: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16153,12 +17680,13 @@ export interface components { }; content: { "application/json": { - firewalls?: components["schemas"]["firewall"][]; + certificates?: components["schemas"]["certificate"][]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description A JSON object with an `droplets` key. */ - neighbor_droplets: { + /** @description The response will be a JSON object with a key called `certificate`. The value of this will be an object that contains the standard attributes associated with a certificate. + * When using Let's Encrypt, the initial value of the certificate's `state` attribute will be `pending`. When the certificate has been successfully issued by Let's Encrypt, this will transition to `verified` and be ready for use. */ + new_certificate: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16167,12 +17695,12 @@ export interface components { }; content: { "application/json": { - droplets?: components["schemas"]["droplet"][]; + certificate?: components["schemas"]["certificate"]; }; }; }; - /** @description A JSON object containing `snapshots`, `volumes`, and `volume_snapshots` keys. */ - associated_resources_list: { + /** @description The response will be a JSON object with a `certificate` key. This will be set to an object containing the standard certificate attributes. */ + existing_certificate: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16181,16 +17709,12 @@ export interface components { }; content: { "application/json": { - reserved_ips?: components["schemas"]["associated_resource"][]; - floating_ips?: components["schemas"]["associated_resource"][]; - snapshots?: components["schemas"]["associated_resource"][]; - volumes?: components["schemas"]["associated_resource"][]; - volume_snapshots?: components["schemas"]["associated_resource"][]; + certificate?: components["schemas"]["certificate"]; }; }; }; - /** @description A JSON object containing containing the status of a request to destroy a Droplet and its associated resources. */ - associated_resources_status: { + /** @description The response will be a JSON object that contains the following attributes */ + balance: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16198,11 +17722,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["associated_resource_status"]; + "application/json": components["schemas"]["balance"]; }; }; - /** @description Conflict */ - conflict: { + /** @description The response will be a JSON object that contains the following attributes */ + billing_history: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16210,11 +17734,14 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["error"]; + "application/json": { + billing_history?: components["schemas"]["billing_history"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta_optional_total"]; }; }; - /** @description A JSON object with a key of `autoscale_pools`. */ - all_autoscale_pools: { + /** @description The response will be a JSON object contains that contains a list of invoices under the `invoices` key, and the invoice preview under the `invoice_preview` key. + * Each element contains the invoice summary attributes. */ + invoices: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16223,12 +17750,13 @@ export interface components { }; content: { "application/json": { - autoscale_pools?: components["schemas"]["autoscale_pool"][]; + invoices?: components["schemas"]["invoice_preview"][]; + invoice_preview?: components["schemas"]["invoice_preview"]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description Accepted */ - autoscale_pool_create: { + /** @description The response will be a JSON object with a key called `invoice_items`. This will be set to an array of invoice item objects. */ + invoice: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16237,42 +17765,38 @@ export interface components { }; content: { "application/json": { - autoscale_pool?: components["schemas"]["autoscale_pool"]; - }; + invoice_items?: components["schemas"]["invoice_item"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `autoscale_pool`. This will be - * set to a JSON object that contains the standard autoscale pool attributes. - * */ - existing_autoscale_pool: { + /** @description The response will be a CSV file. */ + invoice_csv: { headers: { + "content-disposition": components["headers"]["content-disposition"]; "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; "ratelimit-reset": components["headers"]["ratelimit-reset"]; [name: string]: unknown; }; content: { - "application/json": { - autoscale_pool?: components["schemas"]["autoscale_pool"]; - }; + "text/csv": string; }; }; - /** @description A JSON object with a key of `droplets`. */ - all_members: { + /** @description The response will be a PDF file. */ + invoice_pdf: { headers: { + "content-disposition": components["headers"]["content-disposition"]; "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; "ratelimit-reset": components["headers"]["ratelimit-reset"]; [name: string]: unknown; }; content: { - "application/json": { - droplets?: components["schemas"]["member"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/pdf": string; }; }; - /** @description A JSON object with a key of `history`. */ - history_events: { + /** @description To retrieve a summary for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/summary`. */ + invoice_summary: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16280,13 +17804,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - history?: components["schemas"]["history"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["invoice_summary"]; }; }; - /** @description To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. */ - list_firewalls_response: { + /** @description A JSON string with a key of `options`. */ + options: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16294,13 +17816,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - firewalls?: components["schemas"]["firewall"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["options"]; }; }; - /** @description The response will be a JSON object with a firewall key. This will be set to an object containing the standard firewall attributes */ - create_firewall_response: { + /** @description A JSON object with a key of `databases`. */ + database_clusters: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16309,12 +17829,12 @@ export interface components { }; content: { "application/json": { - firewall?: components["schemas"]["firewall"]; + databases?: components["schemas"]["database_cluster"][]; }; }; }; - /** @description Bad Request */ - bad_request: { + /** @description A JSON object with a key of `database`. */ + database_cluster: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16322,11 +17842,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["error"]; + "application/json": { + database: components["schemas"]["database_cluster"]; + }; }; }; - /** @description The response will be a JSON object with a firewall key. This will be set to an object containing the standard firewall attributes. */ - get_firewall_response: { + /** @description A JSON object with a key of `config`. */ + database_config: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16335,12 +17857,12 @@ export interface components { }; content: { "application/json": { - firewall?: components["schemas"]["firewall"]; + config: components["schemas"]["mysql_advanced_config"] | components["schemas"]["postgres_advanced_config"] | components["schemas"]["redis_advanced_config"] | components["schemas"]["kafka_advanced_config"] | components["schemas"]["opensearch_advanced_config"] | components["schemas"]["mongo_advanced_config"]; }; }; }; - /** @description The response will be a JSON object with a `firewall` key. This will be set to an object containing the standard firewall attributes. */ - put_firewall_response: { + /** @description A JSON object with a key of `ca`. */ + ca: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16349,12 +17871,12 @@ export interface components { }; content: { "application/json": { - firewall?: components["schemas"]["firewall"]; + ca: components["schemas"]["ca"]; }; }; }; - /** @description The response will be a JSON object with a key called `floating_ips`. This will be set to an array of floating IP objects, each of which will contain the standard floating IP attributes */ - floating_ip_list: { + /** @description A JSON object. */ + online_migration: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16362,14 +17884,21 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - floating_ips?: components["schemas"]["floating_ip"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["online_migration"]; }; }; - /** @description The response will be a JSON object with a key called `floating_ip`. The value of this will be an object that contains the standard attributes associated with a floating IP. - * When assigning a floating IP to a Droplet at same time as it created, the response's `links` object will contain links to both the Droplet and the assignment action. The latter can be used to check the status of the action. */ - floating_ip_created: { + /** @description The does not indicate the success or failure of any operation, just that the request has been accepted for processing. */ + accepted: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content?: never; + }; + /** @description A JSON object with a key of `rules`. */ + firewall_rules: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16378,16 +17907,12 @@ export interface components { }; content: { "application/json": { - floating_ip?: components["schemas"]["floating_ip"]; - links?: { - droplets?: components["schemas"]["action_link"][]; - actions?: components["schemas"]["action_link"][]; - }; + rules?: components["schemas"]["firewall_rule"][]; }; }; }; - /** @description The response will be a JSON object with a key called `floating_ip`. The value of this will be an object that contains the standard attributes associated with a floating IP. */ - floating_ip: { + /** @description A JSON object with a key of `database_backups`. */ + database_backups: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16396,12 +17921,12 @@ export interface components { }; content: { "application/json": { - floating_ip?: components["schemas"]["floating_ip"]; + backups: components["schemas"]["backup"][]; }; }; }; - /** @description The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with action objects containing the standard floating IP action attributes. */ - floating_ip_actions: { + /** @description A JSON object with a key of `replicas`. */ + database_replicas: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16410,12 +17935,12 @@ export interface components { }; content: { "application/json": { - actions?: components["schemas"]["action"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + replicas?: components["schemas"]["database_replica"][]; + }; }; }; - /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard floating IP action attributes. */ - floating_ip_action: { + /** @description A JSON object with a key of `replica`. */ + database_replica: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16424,20 +17949,12 @@ export interface components { }; content: { "application/json": { - action?: components["schemas"]["action"] & { - /** - * Format: uuid - * @description The UUID of the project to which the reserved IP currently belongs. - * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 - */ - project_id?: string; - }; + replica?: components["schemas"]["database_replica"]; }; }; }; - /** @description An array of JSON objects with a key called `namespaces`. Each object represents a namespace and contains - * the properties associated with it. */ - list_namespaces: { + /** @description A JSON object with a key of `events`. */ + events_logs: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16446,13 +17963,12 @@ export interface components { }; content: { "application/json": { - namespaces?: components["schemas"]["namespace_info"][]; + events?: components["schemas"]["events_logs"][]; }; }; }; - /** @description A JSON response object with a key called `namespace`. The object contains the properties associated - * with the namespace. */ - namespace_created: { + /** @description A JSON object with a key of `users`. */ + users: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16461,12 +17977,12 @@ export interface components { }; content: { "application/json": { - namespace?: components["schemas"]["namespace_info"]; + users?: components["schemas"]["database_user"][]; }; }; }; - /** @description Bad Request. */ - namespace_bad_request: { + /** @description A JSON object with a key of `user`. */ + user: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16474,11 +17990,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["error"]; + "application/json": { + user: components["schemas"]["database_user"]; + }; }; }; - /** @description Limit Reached */ - namespace_limit_reached: { + /** @description A JSON object with a key of `databases`. */ + databases: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16486,11 +18004,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["error"]; + "application/json": { + dbs?: components["schemas"]["database"][]; + }; }; }; - /** @description Not Allowed. */ - namespace_not_allowed: { + /** @description A JSON object with a key of `db`. */ + database: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16498,11 +18018,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["error"]; + "application/json": { + db: components["schemas"]["database"]; + }; }; }; - /** @description Bad Request. */ - namespace_not_found: { + /** @description A JSON object with a key of `pools`. */ + connection_pools: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16510,12 +18032,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["error"]; + "application/json": components["schemas"]["connection_pools"]; }; }; - /** @description An array of JSON objects with a key called `namespaces`. Each object represents a namespace and contains - * the properties associated with it. */ - list_triggers: { + /** @description A JSON object with a key of `pool`. */ + connection_pool: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16524,13 +18045,12 @@ export interface components { }; content: { "application/json": { - triggers?: components["schemas"]["trigger_info"][]; + pool: components["schemas"]["connection_pool"]; }; }; }; - /** @description A JSON response object with a key called `trigger`. The object contains the properties associated - * with the trigger. */ - trigger_response: { + /** @description A JSON string with a key of `eviction_policy`. */ + eviction_policy_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16539,12 +18059,12 @@ export interface components { }; content: { "application/json": { - trigger?: components["schemas"]["trigger_info"]; + eviction_policy: components["schemas"]["eviction_policy_model"]; }; }; }; - /** @description Bad Request. */ - trigger_bad_request: { + /** @description A JSON string with a key of `sql_mode`. */ + sql_mode: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16552,11 +18072,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["error"]; + "application/json": components["schemas"]["sql_mode"]; }; }; - /** @description Limit Reached */ - trigger_limit_reached: { + /** @description A JSON object with a key of `topics`. */ + kafka_topics: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16564,11 +18084,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["error"]; + "application/json": { + topics?: components["schemas"]["kafka_topic"][]; + }; }; }; - /** @description Bad Request. */ - trigger_not_found: { + /** @description A JSON object with a key of `topic`. */ + kafka_topic: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16576,11 +18098,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["error"]; + "application/json": { + topic?: components["schemas"]["kafka_topic_verbose"]; + }; }; }; - /** @description The response will be a JSON object with a key called `images`. This will be set to an array of image objects, each of which will contain the standard image attributes. */ - all_images: { + /** @description A JSON object with a key of `sinks`. */ + logsinks: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16589,12 +18113,12 @@ export interface components { }; content: { "application/json": { - images: components["schemas"]["image"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + sinks?: components["schemas"]["logsink_verbose"][]; + }; }; }; - /** @description The response will be a JSON object with a key set to `image`. The value of this will be an image object containing a subset of the standard image attributes as listed below, including the image's `id` and `status`. After initial creation, the `status` will be `NEW`. Using the image's id, you may query the image's status by sending a `GET` request to the `/v2/images/$IMAGE_ID` endpoint. When the `status` changes to `available`, the image will be ready for use. */ - new_custom_image: { + /** @description A JSON object with a key of `sink`. */ + logsink: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16603,12 +18127,12 @@ export interface components { }; content: { "application/json": { - image?: components["schemas"]["image"]; + sink?: components["schemas"]["logsink_verbose"]; }; }; }; - /** @description The response will be a JSON object with a key called `image`. The value of this will be an image object containing the standard image attributes. */ - existing_image: { + /** @description A JSON object with a key of `credentials`. */ + database_metrics_auth: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16617,12 +18141,12 @@ export interface components { }; content: { "application/json": { - image: components["schemas"]["image"]; + credentials?: components["schemas"]["database_metrics_credentials"]; }; }; }; - /** @description The response will be a JSON object with a key set to `image`. The value of this will be an image object containing the standard image attributes. */ - updated_image: { + /** @description A JSON object with a key of `indexes`. */ + opensearch_indexes: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16631,12 +18155,12 @@ export interface components { }; content: { "application/json": { - image: components["schemas"]["image"]; + indexes?: components["schemas"]["opensearch_index"][]; }; }; }; - /** @description The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with action objects containing the standard action attributes. */ - get_image_actions_response: { + /** @description The response will be a JSON object with a key called `domains`. The value of this will be an array of Domain objects, each of which contain the standard domain attributes. */ + all_domains_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16645,12 +18169,13 @@ export interface components { }; content: { "application/json": { - actions?: components["schemas"]["action"][]; + /** @description Array of volumes. */ + domains: components["schemas"]["domain"][]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `action`. The value of this will be an object containing the standard image action attributes. */ - post_image_action_response: { + /** @description The response will be a JSON object with a key called `domain`. The value of this will be an object that contains the standard attributes associated with a domain. */ + create_domain_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16658,11 +18183,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["action"]; + "application/json": { + domain?: components["schemas"]["domain"]; + }; }; }; - /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard image action attributes. */ - get_image_action_response: { + /** @description The response will be a JSON object with a key called `domain`. The value of this will be an object that contains the standard attributes defined for a domain. */ + existing_domain: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16670,14 +18197,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["action"]; + "application/json": { + domain?: components["schemas"]["domain"]; + }; }; }; - /** @description The response will be a JSON object with a key called `kubernetes_clusters`. - * This will be set to an array of objects, each of which will contain the - * standard Kubernetes cluster attributes. - * */ - all_clusters: { + /** @description The response will be a JSON object with a key called `domain_records`. The value of this will be an array of domain record objects, each of which contains the standard domain record attributes. For attributes that are not used by a specific record type, a value of `null` will be returned. For instance, all records other than SRV will have `null` for the `weight` and `port` attributes. */ + all_domain_records_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16686,20 +18212,12 @@ export interface components { }; content: { "application/json": { - kubernetes_clusters?: components["schemas"]["cluster"][]; + domain_records?: components["schemas"]["domain_record"][]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `kubernetes_cluster`. The - * value of this will be an object containing the standard attributes of a - * Kubernetes cluster. - * - * The IP address and cluster API server endpoint will not be available until the - * cluster has finished provisioning. The initial value of the cluster's - * `status.state` attribute will be `provisioning`. When the cluster is ready, - * this will transition to `running`. - * */ - cluster_create: { + /** @description The response body will be a JSON object with a key called `domain_record`. The value of this will be an object representing the new record. Attributes that are not applicable for the record type will be set to `null`. An `id` attribute is generated for each record as part of the object. */ + created_domain_record: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16708,15 +18226,12 @@ export interface components { }; content: { "application/json": { - kubernetes_cluster?: components["schemas"]["cluster"]; + domain_record?: components["schemas"]["domain_record"]; }; }; }; - /** @description The response will be a JSON object with a key called `kubernetes_cluster`. The - * value of this will be an object containing the standard attributes of a - * Kubernetes cluster. - * */ - existing_cluster: { + /** @description The response will be a JSON object with a key called `domain_record`. The value of this will be a domain record object which contains the standard domain record attributes. */ + domain_record: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16725,15 +18240,12 @@ export interface components { }; content: { "application/json": { - kubernetes_cluster?: components["schemas"]["cluster"]; + domain_record?: components["schemas"]["domain_record"]; }; }; }; - /** @description The response will be a JSON object with a key called `kubernetes_cluster`. The - * value of this will be an object containing the standard attributes of a - * Kubernetes cluster. - * */ - updated_cluster: { + /** @description A JSON object with a key of `droplets`. */ + all_droplets: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16742,12 +18254,12 @@ export interface components { }; content: { "application/json": { - kubernetes_cluster?: components["schemas"]["cluster"]; - }; + droplets?: components["schemas"]["droplet"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object containing `load_balancers`, `volumes`, and `volume_snapshots` keys. Each will be set to an array of objects containing the standard attributes for associated resources. */ - associated_kubernetes_resources_list: { + /** @description Accepted */ + droplet_create: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16755,23 +18267,34 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["associated_kubernetes_resources"]; + "application/json": { + droplet: components["schemas"]["droplet"]; + links: { + actions?: components["schemas"]["action_link"][]; + }; + } | { + droplets: components["schemas"]["droplet"][]; + links: { + actions?: components["schemas"]["action_link"][]; + }; + }; }; }; - /** @description A kubeconfig file for the cluster in YAML format. */ - kubeconfig: { + /** @description The action was successful and the response body is empty. This response has content-type set. */ + no_content_with_content_type: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; "ratelimit-reset": components["headers"]["ratelimit-reset"]; + "content-type": components["headers"]["content-type"]; [name: string]: unknown; }; - content: { - "application/yaml": unknown; - }; + content?: never; }; - /** @description A JSON object containing credentials for a cluster. */ - credentials: { + /** @description The response will be a JSON object with a key called `droplet`. This will be + * set to a JSON object that contains the standard Droplet attributes. + * */ + existing_droplet: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16779,17 +18302,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["credentials"]; + "application/json": { + droplet?: components["schemas"]["droplet"]; + }; }; }; - /** @description The response will be a JSON object with a key called - * `available_upgrade_versions`. The value of this will be an array of objects, - * representing the upgrade versions currently available for this cluster. - * - * If the cluster is up-to-date (i.e. there are no upgrades currently available) - * `available_upgrade_versions` will be `null`. - * */ - available_upgrades: { + /** @description A JSON object with an `backups` key. */ + all_droplet_backups: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16798,15 +18317,14 @@ export interface components { }; content: { "application/json": { - available_upgrade_versions?: components["schemas"]["kubernetes_version"][] | null; - }; + backups?: components["schemas"]["droplet_snapshot"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `node_pools`. This will - * be set to an array of objects, each of which will contain the standard node - * pool attributes. + /** @description The response will be a JSON object with a key called `policy`. This will be + * set to a JSON object that contains the standard Droplet backup policy attributes. * */ - all_node_pools: { + droplet_backup_policy: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16815,14 +18333,12 @@ export interface components { }; content: { "application/json": { - node_pools?: components["schemas"]["kubernetes_node_pool"][]; + policy?: components["schemas"]["droplet_backup_policy_record"]; }; }; }; - /** @description The response will be a JSON object with a key called `node_pool`. The value of - * this will be an object containing the standard attributes of a node pool. - * */ - node_pool_create: { + /** @description A JSON object with a `policies` key set to a map. The keys are Droplet IDs and the values are objects containing the backup policy information for each Droplet. */ + all_droplet_backup_policies: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16831,14 +18347,17 @@ export interface components { }; content: { "application/json": { - node_pool?: components["schemas"]["kubernetes_node_pool"]; - }; + /** @description A map where the keys are the Droplet IDs and the values are + * objects containing the backup policy information for each Droplet. + * */ + policies?: { + [key: string]: components["schemas"]["droplet_backup_policy_record"]; + }; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `node_pool`. The value - * of this will be an object containing the standard attributes of a node pool. - * */ - existing_node_pool: { + /** @description A JSON object with an `supported_policies` key set to an array of objects describing each supported backup policy. */ + droplets_supported_backup_policies: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16847,14 +18366,12 @@ export interface components { }; content: { "application/json": { - node_pool?: components["schemas"]["kubernetes_node_pool"]; + supported_policies?: components["schemas"]["supported_droplet_backup_policy"][]; }; }; }; - /** @description The response will be a JSON object with a key called `node_pool`. The value of - * this will be an object containing the standard attributes of a node pool. - * */ - node_pool_update: { + /** @description A JSON object with an `snapshots` key. */ + all_droplet_snapshots: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16863,14 +18380,12 @@ export interface components { }; content: { "application/json": { - node_pool?: components["schemas"]["kubernetes_node_pool"]; - }; + snapshots?: components["schemas"]["droplet_snapshot"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `kubernetes_cluster_user` - * containing the username and in-cluster groups that it belongs to. - * */ - cluster_user: { + /** @description A JSON object with an `actions` key. */ + all_droplet_actions: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16878,14 +18393,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["user"]; + "application/json": { + actions?: components["schemas"]["action"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `options` which contains - * `regions`, `versions`, and `sizes` objects listing the available options and - * the matching slugs for use when creating a new cluster. - * */ - all_options: { + /** @description The response will be a JSON object with a key called `action`. */ + droplet_action: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16893,14 +18407,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["kubernetes_options"]; + "application/json": { + action?: components["schemas"]["action"]; + }; }; }; - /** @description The response is a JSON object which contains the diagnostics on Kubernetes - * objects in the cluster. Each diagnostic will contain some metadata information - * about the object and feedback for users to act upon. - * */ - clusterlint_results: { + /** @description The response will be a JSON object with a key called `actions`. */ + droplet_actions_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16908,11 +18421,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["clusterlint_results"]; + "application/json": { + actions?: components["schemas"]["action"][]; + }; }; }; - /** @description The response is a JSON object with a key called `run_id` that you can later use to fetch the run results. */ - clusterlint_run: { + /** @description A JSON object that has a key called `kernels`. */ + all_kernels: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16921,16 +18436,12 @@ export interface components { }; content: { "application/json": { - /** - * @description ID of the clusterlint run that can be used later to fetch the diagnostics. - * @example 50c2f44c-011d-493e-aee5-361a4a0d1844 - */ - run_id?: string; - }; + kernels?: components["schemas"]["kernel"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description A JSON object with a key of `load_balancers`. This will be set to an array of objects, each of which will contain the standard load balancer attributes. */ - all_load_balancers: { + /** @description A JSON object that has a key called `firewalls`. */ + all_firewalls: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16939,12 +18450,12 @@ export interface components { }; content: { "application/json": { - load_balancers?: components["schemas"]["load_balancer"][]; + firewalls?: components["schemas"]["firewall"][]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description Accepted */ - load_balancer_create: { + /** @description A JSON object with an `droplets` key. */ + neighbor_droplets: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16953,15 +18464,12 @@ export interface components { }; content: { "application/json": { - load_balancer?: components["schemas"]["load_balancer"]; + droplets?: components["schemas"]["droplet"][]; }; }; }; - /** @description The response will be a JSON object with a key called `load_balancer`. The - * value of this will be an object that contains the standard attributes - * associated with a load balancer - * */ - existing_load_balancer: { + /** @description A JSON object containing `snapshots`, `volumes`, and `volume_snapshots` keys. */ + associated_resources_list: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16970,15 +18478,16 @@ export interface components { }; content: { "application/json": { - load_balancer?: components["schemas"]["load_balancer"]; + reserved_ips?: components["schemas"]["associated_resource"][]; + floating_ips?: components["schemas"]["associated_resource"][]; + snapshots?: components["schemas"]["associated_resource"][]; + volumes?: components["schemas"]["associated_resource"][]; + volume_snapshots?: components["schemas"]["associated_resource"][]; }; }; }; - /** @description The response will be a JSON object with a key called `load_balancer`. The - * value of this will be an object containing the standard attributes of a - * load balancer. - * */ - updated_load_balancer: { + /** @description A JSON object containing containing the status of a request to destroy a Droplet and its associated resources. */ + associated_resources_status: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -16986,13 +18495,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - load_balancer?: components["schemas"]["load_balancer"]; - }; + "application/json": components["schemas"]["associated_resource_status"]; }; }; - /** @description A list of alert policies. */ - list_alert_policy_response: { + /** @description Conflict */ + conflict: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17000,11 +18507,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["list_alert_policy"] & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["error"]; }; }; - /** @description An alert policy. */ - alert_policy_response: { + /** @description A JSON object with a key of `autoscale_pools`. */ + all_autoscale_pools: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17013,12 +18520,12 @@ export interface components { }; content: { "application/json": { - policy?: components["schemas"]["alert_policy"]; - }; + autoscale_pools?: components["schemas"]["autoscale_pool"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `data` and `status`. */ - droplet_bandwidth_metric_response: { + /** @description Accepted */ + autoscale_pool_create: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17026,11 +18533,15 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["metrics"]; + "application/json": { + autoscale_pool?: components["schemas"]["autoscale_pool"]; + }; }; }; - /** @description The response will be a JSON object with a key called `data` and `status`. */ - droplet_cpu_metric_response: { + /** @description The response will be a JSON object with a key called `autoscale_pool`. This will be + * set to a JSON object that contains the standard autoscale pool attributes. + * */ + existing_autoscale_pool: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17038,11 +18549,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["metrics"]; + "application/json": { + autoscale_pool?: components["schemas"]["autoscale_pool"]; + }; }; }; - /** @description The response will be a JSON object with a key called `data` and `status`. */ - droplet_filesystem_metric_response: { + /** @description A JSON object with a key of `droplets`. */ + all_members: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17050,11 +18563,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["metrics"]; + "application/json": { + droplets?: components["schemas"]["member"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `data` and `status`. */ - metric_response: { + /** @description A JSON object with a key of `history`. */ + history_events: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17062,11 +18577,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["metrics"]; + "application/json": { + history?: components["schemas"]["history"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `data` and `status`. */ - app_metric_response: { + /** @description To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. */ + list_firewalls_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17074,11 +18591,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["metrics"]; + "application/json": { + firewalls?: components["schemas"]["firewall"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response is a JSON object with a `destinations` key. */ - monitoring_list_destinations: { + /** @description The response will be a JSON object with a firewall key. This will be set to an object containing the standard firewall attributes */ + create_firewall_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17087,12 +18606,12 @@ export interface components { }; content: { "application/json": { - destinations?: components["schemas"]["destination_omit_credentials"][]; + firewall?: components["schemas"]["firewall"]; }; }; }; - /** @description The response is a JSON object with a `destination` key. */ - destination: { + /** @description Bad Request */ + bad_request: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17100,13 +18619,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - destination?: components["schemas"]["destination_omit_credentials"]; - }; + "application/json": components["schemas"]["error"]; }; }; - /** @description The response is a JSON object with a `sinks` key. */ - list_sinks: { + /** @description The response will be a JSON object with a firewall key. This will be set to an object containing the standard firewall attributes. */ + get_firewall_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17115,13 +18632,12 @@ export interface components { }; content: { "application/json": { - /** @description List of sinks identified by their URNs. */ - sinks?: components["schemas"]["sinks_response"][]; + firewall?: components["schemas"]["firewall"]; }; }; }; - /** @description The response is a JSON object with a `sink` key. */ - sinks: { + /** @description The response will be a JSON object with a `firewall` key. This will be set to an object containing the standard firewall attributes. */ + put_firewall_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17130,12 +18646,12 @@ export interface components { }; content: { "application/json": { - sink?: components["schemas"]["sinks_response"]; + firewall?: components["schemas"]["firewall"]; }; }; }; - /** @description The response will be a JSON object with a key called `projects`. The value of this will be an object with the standard project attributes */ - projects_list: { + /** @description The response will be a JSON object with a key called `floating_ips`. This will be set to an array of floating IP objects, each of which will contain the standard floating IP attributes */ + floating_ip_list: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17144,12 +18660,13 @@ export interface components { }; content: { "application/json": { - projects?: components["schemas"]["project"][]; + floating_ips?: components["schemas"]["floating_ip"][]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `project`. The value of this will be an object with the standard project attributes */ - existing_project: { + /** @description The response will be a JSON object with a key called `floating_ip`. The value of this will be an object that contains the standard attributes associated with a floating IP. + * When assigning a floating IP to a Droplet at same time as it created, the response's `links` object will contain links to both the Droplet and the assignment action. The latter can be used to check the status of the action. */ + floating_ip_created: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17158,12 +18675,16 @@ export interface components { }; content: { "application/json": { - project?: components["schemas"]["project"]; + floating_ip?: components["schemas"]["floating_ip"]; + links?: { + droplets?: components["schemas"]["action_link"][]; + actions?: components["schemas"]["action_link"][]; + }; }; }; }; - /** @description The response will be a JSON object with a key called `project`. The value of this will be an object with the standard project attributes */ - default_project: { + /** @description The response will be a JSON object with a key called `floating_ip`. The value of this will be an object that contains the standard attributes associated with a floating IP. */ + floating_ip: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17172,24 +18693,12 @@ export interface components { }; content: { "application/json": { - project?: components["schemas"]["project"]; + floating_ip?: components["schemas"]["floating_ip"]; }; }; }; - /** @description Only an empty project can be deleted. */ - precondition_failed: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; - }; - /** @description The response will be a JSON object with a key called `resources`. The value of this will be an object with the standard resource attributes. */ - resources_list: { + /** @description The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with action objects containing the standard floating IP action attributes. */ + floating_ip_actions: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17198,12 +18707,12 @@ export interface components { }; content: { "application/json": { - resources?: components["schemas"]["resource"][]; + actions?: components["schemas"]["action"][]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `resources`. The value of this will be an object with the standard resource attributes. */ - assigned_resources_list: { + /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard floating IP action attributes. */ + floating_ip_action: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17212,12 +18721,20 @@ export interface components { }; content: { "application/json": { - resources?: components["schemas"]["resource"][]; + action?: components["schemas"]["action"] & { + /** + * Format: uuid + * @description The UUID of the project to which the reserved IP currently belongs. + * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + */ + project_id?: string; + }; }; }; }; - /** @description A JSON object with a key set to `regions`. The value is an array of `region` objects, each of which contain the standard `region` attributes. */ - all_regions: { + /** @description An array of JSON objects with a key called `namespaces`. Each object represents a namespace and contains + * the properties associated with it. */ + list_namespaces: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17226,12 +18743,13 @@ export interface components { }; content: { "application/json": { - regions: components["schemas"]["region"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + namespaces?: components["schemas"]["namespace_info"][]; + }; }; }; - /** @description The response will be a JSON object with the key `registry` containing information about your registry. */ - registry_info: { + /** @description A JSON response object with a key called `namespace`. The object contains the properties associated + * with the namespace. */ + namespace_created: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17240,12 +18758,12 @@ export interface components { }; content: { "application/json": { - registry?: components["schemas"]["registry"]; + namespace?: components["schemas"]["namespace_info"]; }; }; }; - /** @description The response will be a JSON object with a key called `subscription` containing information about your subscription. */ - subscription_response: { + /** @description Bad Request. */ + namespace_bad_request: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17253,13 +18771,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - subscription?: components["schemas"]["subscription"]; - }; + "application/json": components["schemas"]["error"]; }; }; - /** @description A Docker `config.json` file for the container registry. */ - docker_credentials: { + /** @description Limit Reached */ + namespace_limit_reached: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17267,11 +18783,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["docker_credentials"]; + "application/json": components["schemas"]["error"]; }; }; - /** @description The response body will be a JSON object with a key of `repositories`. This will be set to an array containing objects each representing a repository. */ - all_repositories: { + /** @description Not Allowed. */ + namespace_not_allowed: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17279,13 +18795,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - repositories?: components["schemas"]["repository"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["error"]; }; }; - /** @description The response body will be a JSON object with a key of `repositories`. This will be set to an array containing objects each representing a repository. */ - all_repositories_v2: { + /** @description Bad Request. */ + namespace_not_found: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17293,13 +18807,12 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - repositories?: components["schemas"]["repository_v2"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["error"]; }; }; - /** @description The response body will be a JSON object with a key of `tags`. This will be set to an array containing objects each representing a tag. */ - repository_tags: { + /** @description An array of JSON objects with a key called `namespaces`. Each object represents a namespace and contains + * the properties associated with it. */ + list_triggers: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17308,12 +18821,13 @@ export interface components { }; content: { "application/json": { - tags?: components["schemas"]["repository_tag"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + triggers?: components["schemas"]["trigger_info"][]; + }; }; }; - /** @description The response body will be a JSON object with a key of `manifests`. This will be set to an array containing objects each representing a manifest. */ - repository_manifests: { + /** @description A JSON response object with a key called `trigger`. The object contains the properties associated + * with the trigger. */ + trigger_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17322,12 +18836,12 @@ export interface components { }; content: { "application/json": { - manifests?: components["schemas"]["repository_manifest"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + trigger?: components["schemas"]["trigger_info"]; + }; }; }; - /** @description The response will be a JSON object with a key of `garbage_collection`. This will be a json object with attributes representing the currently-active garbage collection. */ - garbage_collection: { + /** @description Bad Request. */ + trigger_bad_request: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17335,13 +18849,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - garbage_collection?: components["schemas"]["garbage_collection"]; - }; + "application/json": components["schemas"]["error"]; }; }; - /** @description The response will be a JSON object with a key of `garbage_collections`. This will be set to an array containing objects representing each past garbage collection. Each will contain the standard Garbage Collection attributes. */ - garbage_collections: { + /** @description Limit Reached */ + trigger_limit_reached: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17349,13 +18861,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - garbage_collections?: components["schemas"]["garbage_collection"][]; - }; + "application/json": components["schemas"]["error"]; }; }; - /** @description The response will be a JSON object with a key called `options` which contains a key called `subscription_tiers` listing the available tiers. */ - registry_options_response: { + /** @description Bad Request. */ + trigger_not_found: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17363,19 +18873,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - options?: { - /** @example [ - * "nyc3" - * ] */ - available_regions?: string[]; - subscription_tiers?: (components["schemas"]["subscription_tier_base"] & components["schemas"]["subscription_tier_extended"])[]; - }; - }; + "application/json": components["schemas"]["error"]; }; }; - /** @description A JSON object with an `neighbor_ids` key. */ - droplet_neighbors_ids: { + /** @description The response will be a JSON object with a key called `images`. This will be set to an array of image objects, each of which will contain the standard image attributes. */ + all_images: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17383,11 +18885,13 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["neighbor_ids"]; + "application/json": { + images: components["schemas"]["image"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `reserved_ips`. This will be set to an array of reserved IP objects, each of which will contain the standard reserved IP attributes */ - reserved_ip_list: { + /** @description The response will be a JSON object with a key set to `image`. The value of this will be an image object containing a subset of the standard image attributes as listed below, including the image's `id` and `status`. After initial creation, the `status` will be `NEW`. Using the image's id, you may query the image's status by sending a `GET` request to the `/v2/images/$IMAGE_ID` endpoint. When the `status` changes to `available`, the image will be ready for use. */ + new_custom_image: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17396,13 +18900,12 @@ export interface components { }; content: { "application/json": { - reserved_ips?: components["schemas"]["reserved_ip"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + image?: components["schemas"]["image"]; + }; }; }; - /** @description The response will be a JSON object with a key called `reserved_ip`. The value of this will be an object that contains the standard attributes associated with a reserved IP. - * When assigning a reserved IP to a Droplet at same time as it created, the response's `links` object will contain links to both the Droplet and the assignment action. The latter can be used to check the status of the action. */ - reserved_ip_created: { + /** @description The response will be a JSON object with a key called `image`. The value of this will be an image object containing the standard image attributes. */ + existing_image: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17411,16 +18914,12 @@ export interface components { }; content: { "application/json": { - reserved_ip?: components["schemas"]["reserved_ip"]; - links?: { - droplets?: components["schemas"]["action_link"][]; - actions?: components["schemas"]["action_link"][]; - }; + image: components["schemas"]["image"]; }; }; }; - /** @description The response will be a JSON object with a key called `reserved_ip`. The value of this will be an object that contains the standard attributes associated with a reserved IP. */ - reserved_ip: { + /** @description The response will be a JSON object with a key set to `image`. The value of this will be an image object containing the standard image attributes. */ + updated_image: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17429,12 +18928,12 @@ export interface components { }; content: { "application/json": { - reserved_ip?: components["schemas"]["reserved_ip"]; + image: components["schemas"]["image"]; }; }; }; - /** @description The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with action objects containing the standard reserved IP action attributes. */ - reserved_ip_actions: { + /** @description The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with action objects containing the standard action attributes. */ + get_image_actions_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17447,8 +18946,8 @@ export interface components { } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard reserved IP action attributes. */ - reserved_ip_action: { + /** @description The response will be a JSON object with a key called `action`. The value of this will be an object containing the standard image action attributes. */ + post_image_action_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17456,20 +18955,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - action?: components["schemas"]["action"] & { - /** - * Format: uuid - * @description The UUID of the project to which the reserved IP currently belongs. - * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 - */ - project_id?: string; - }; - }; + "application/json": components["schemas"]["action"]; }; }; - /** @description A JSON object with a key called `sizes`. The value of this will be an array of `size` objects each of which contain the standard size attributes. */ - all_sizes: { + /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard image action attributes. */ + get_image_action_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17477,13 +18967,14 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - sizes: components["schemas"]["size"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["action"]; }; }; - /** @description A JSON object with a key of `snapshots`. */ - snapshots: { + /** @description The response will be a JSON object with a key called `kubernetes_clusters`. + * This will be set to an array of objects, each of which will contain the + * standard Kubernetes cluster attributes. + * */ + all_clusters: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17492,13 +18983,20 @@ export interface components { }; content: { "application/json": { - snapshots?: components["schemas"]["snapshots"][]; + kubernetes_clusters?: components["schemas"]["cluster"][]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description A JSON object with a key called `snapshot`. + /** @description The response will be a JSON object with a key called `kubernetes_cluster`. The + * value of this will be an object containing the standard attributes of a + * Kubernetes cluster. + * + * The IP address and cluster API server endpoint will not be available until the + * cluster has finished provisioning. The initial value of the cluster's + * `status.state` attribute will be `provisioning`. When the cluster is ready, + * this will transition to `running`. * */ - snapshots_existing: { + cluster_create: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17507,12 +19005,15 @@ export interface components { }; content: { "application/json": { - snapshot?: components["schemas"]["snapshots"]; + kubernetes_cluster?: components["schemas"]["cluster"]; }; }; }; - /** @description Bad Request */ - not_a_snapshot: { + /** @description The response will be a JSON object with a key called `kubernetes_cluster`. The + * value of this will be an object containing the standard attributes of a + * Kubernetes cluster. + * */ + existing_cluster: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17520,11 +19021,16 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["error"]; + "application/json": { + kubernetes_cluster?: components["schemas"]["cluster"]; + }; }; }; - /** @description To list all of your tags, you can send a `GET` request to `/v2/tags`. */ - tags_all: { + /** @description The response will be a JSON object with a key called `kubernetes_cluster`. The + * value of this will be an object containing the standard attributes of a + * Kubernetes cluster. + * */ + updated_cluster: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17533,12 +19039,12 @@ export interface components { }; content: { "application/json": { - tags?: components["schemas"]["tags"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + kubernetes_cluster?: components["schemas"]["cluster"]; + }; }; }; - /** @description The response will be a JSON object with a key called tag. The value of this will be a tag object containing the standard tag attributes */ - tags_new: { + /** @description The response will be a JSON object containing `load_balancers`, `volumes`, and `volume_snapshots` keys. Each will be set to an array of objects containing the standard attributes for associated resources. */ + associated_kubernetes_resources_list: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17546,26 +19052,41 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - tag?: components["schemas"]["tags"]; - }; + "application/json": components["schemas"]["associated_kubernetes_resources"]; }; }; - /** @description Bad Request */ - tags_bad_request: { + /** @description A kubeconfig file for the cluster in YAML format. */ + kubeconfig: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; "ratelimit-reset": components["headers"]["ratelimit-reset"]; - "x-request-id": components["headers"]["x-request-id"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["error_with_root_causes"]; + "application/yaml": unknown; }; }; - /** @description The response will be a JSON object with a key called `tag`. The value of this will be a tag object containing the standard tag attributes. */ - tags_existing: { + /** @description A JSON object containing credentials for a cluster. */ + credentials: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["credentials"]; + }; + }; + /** @description The response will be a JSON object with a key called + * `available_upgrade_versions`. The value of this will be an array of objects, + * representing the upgrade versions currently available for this cluster. + * + * If the cluster is up-to-date (i.e. there are no upgrades currently available) + * `available_upgrade_versions` will be `null`. + * */ + available_upgrades: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17574,12 +19095,15 @@ export interface components { }; content: { "application/json": { - tag?: components["schemas"]["tags"]; + available_upgrade_versions?: components["schemas"]["kubernetes_version"][] | null; }; }; }; - /** @description The response will be a JSON object with a key called `volumes`. This will be set to an array of volume objects, each of which will contain the standard volume attributes. */ - volumes: { + /** @description The response will be a JSON object with a key called `node_pools`. This will + * be set to an array of objects, each of which will contain the standard node + * pool attributes. + * */ + all_node_pools: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17588,13 +19112,14 @@ export interface components { }; content: { "application/json": { - /** @description Array of volumes. */ - volumes: components["schemas"]["volume_full"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + node_pools?: components["schemas"]["kubernetes_node_pool"][]; + }; }; }; - /** @description The response will be a JSON object with a key called `volume`. The value will be an object containing the standard attributes associated with a volume. */ - volume: { + /** @description The response will be a JSON object with a key called `node_pool`. The value of + * this will be an object containing the standard attributes of a node pool. + * */ + node_pool_create: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17603,12 +19128,14 @@ export interface components { }; content: { "application/json": { - volume?: components["schemas"]["volume_full"]; + node_pool?: components["schemas"]["kubernetes_node_pool"]; }; }; }; - /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard volume action attributes */ - volumeAction: { + /** @description The response will be a JSON object with a key called `node_pool`. The value + * of this will be an object containing the standard attributes of a node pool. + * */ + existing_node_pool: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17617,12 +19144,14 @@ export interface components { }; content: { "application/json": { - action?: components["schemas"]["volumeAction"]; + node_pool?: components["schemas"]["kubernetes_node_pool"]; }; }; }; - /** @description You will get back a JSON object that has a `snapshot` key. This will contain the standard snapshot attributes */ - volumeSnapshot: { + /** @description The response will be a JSON object with a key called `node_pool`. The value of + * this will be an object containing the standard attributes of a node pool. + * */ + node_pool_update: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17631,12 +19160,14 @@ export interface components { }; content: { "application/json": { - snapshot?: components["schemas"]["snapshots"]; + node_pool?: components["schemas"]["kubernetes_node_pool"]; }; }; }; - /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard volume action attributes. */ - volumeActions: { + /** @description The response will be a JSON object with a key called `kubernetes_cluster_user` + * containing the username and in-cluster groups that it belongs to. + * */ + cluster_user: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17644,13 +19175,14 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - actions?: components["schemas"]["volumeAction"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["user"]; }; }; - /** @description You will get back a JSON object that has a `snapshots` key. This will be set to an array of snapshot objects, each of which contain the standard snapshot attributes */ - volumeSnapshots: { + /** @description The response will be a JSON object with a key called `options` which contains + * `regions`, `versions`, and `sizes` objects listing the available options and + * the matching slugs for use when creating a new cluster. + * */ + all_options: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17658,13 +19190,14 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - snapshots?: components["schemas"]["snapshots"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["kubernetes_options"]; }; }; - /** @description The response will be a JSON object with a key called `vpcs`. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC */ - all_vpcs: { + /** @description The response is a JSON object which contains the diagnostics on Kubernetes + * objects in the cluster. Each diagnostic will contain some metadata information + * about the object and feedback for users to act upon. + * */ + clusterlint_results: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17672,13 +19205,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - vpcs?: components["schemas"]["vpc"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["clusterlint_results"]; }; }; - /** @description The response will be a JSON object with a key called `vpc`. The value of this will be an object that contains the standard attributes associated with a VPC. */ - existing_vpc: { + /** @description The response is a JSON object with a key called `run_id` that you can later use to fetch the run results. */ + clusterlint_run: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17687,12 +19218,16 @@ export interface components { }; content: { "application/json": { - vpc?: components["schemas"]["vpc"]; + /** + * @description ID of the clusterlint run that can be used later to fetch the diagnostics. + * @example 50c2f44c-011d-493e-aee5-361a4a0d1844 + */ + run_id?: string; }; }; }; - /** @description The response will be a JSON object with a key called members. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC member. */ - vpc_members: { + /** @description A JSON object with a key of `load_balancers`. This will be set to an array of objects, each of which will contain the standard load balancer attributes. */ + all_load_balancers: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17701,12 +19236,12 @@ export interface components { }; content: { "application/json": { - members?: components["schemas"]["vpc_member"][]; + load_balancers?: components["schemas"]["load_balancer"][]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `peerings`. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC peering. */ - vpc_peerings: { + /** @description Accepted */ + load_balancer_create: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17715,12 +19250,15 @@ export interface components { }; content: { "application/json": { - peerings?: components["schemas"]["vpc_peering"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + load_balancer?: components["schemas"]["load_balancer"]; + }; }; }; - /** @description The response will be a JSON object with a key called `peering`, containing the standard attributes associated with a VPC peering. */ - vpc_peering: { + /** @description The response will be a JSON object with a key called `load_balancer`. The + * value of this will be an object that contains the standard attributes + * associated with a load balancer + * */ + existing_load_balancer: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17729,12 +19267,15 @@ export interface components { }; content: { "application/json": { - peering?: components["schemas"]["vpc_peering"]; + load_balancer?: components["schemas"]["load_balancer"]; }; }; }; - /** @description The response will be a JSON object with a key called `vpc_peerings`. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC peering. */ - all_vpc_peerings: { + /** @description The response will be a JSON object with a key called `load_balancer`. The + * value of this will be an object containing the standard attributes of a + * load balancer. + * */ + updated_load_balancer: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17743,12 +19284,12 @@ export interface components { }; content: { "application/json": { - vpc_peerings?: components["schemas"]["vpc_peering"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + load_balancer?: components["schemas"]["load_balancer"]; + }; }; }; - /** @description The response will be a JSON object with a key called `vpc_peering`. The value of this will be an object that contains the standard attributes associated with a VPC peering. */ - provisioning_vpc_peering: { + /** @description A list of alert policies. */ + list_alert_policy_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17756,13 +19297,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - vpc_peering?: components["schemas"]["vpc_peering"]; - }; + "application/json": components["schemas"]["list_alert_policy"] & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a JSON object with a key called `vpc_peering`. The value of this will be an object that contains the standard attributes associated with a VPC peering. */ - active_vpc_peering: { + /** @description An alert policy. */ + alert_policy_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17771,12 +19310,12 @@ export interface components { }; content: { "application/json": { - vpc_peering?: components["schemas"]["vpc_peering"]; + policy?: components["schemas"]["alert_policy"]; }; }; }; - /** @description The response will be a JSON object with a key called `vpc_peering`. The value of this will be an object that contains the standard attributes associated with a VPC peering. */ - deleting_vpc_peering: { + /** @description The response will be a JSON object with a key called `data` and `status`. */ + droplet_bandwidth_metric_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17784,13 +19323,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - vpc_peering?: components["schemas"]["vpc_peering"]; - }; + "application/json": components["schemas"]["metrics"]; }; }; - /** @description The response will be a JSON object with a key called `checks`. This will be set to an array of objects, each of which will contain the standard attributes associated with an uptime check */ - all_checks: { + /** @description The response will be a JSON object with a key called `data` and `status`. */ + droplet_cpu_metric_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17798,13 +19335,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - checks?: components["schemas"]["check"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["metrics"]; }; }; - /** @description The response will be a JSON object with a key called `check`. The value of this will be an object that contains the standard attributes associated with an uptime check. */ - existing_check: { + /** @description The response will be a JSON object with a key called `data` and `status`. */ + droplet_filesystem_metric_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17812,13 +19347,11 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - check?: components["schemas"]["check"]; - }; + "application/json": components["schemas"]["metrics"]; }; }; - /** @description The response will be a JSON object with a key called `state`. The value of this will be an object that contains the standard attributes associated with an uptime check's state. */ - existing_check_state: { + /** @description The response will be a JSON object with a key called `data` and `status`. */ + metric_response: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17826,13 +19359,23 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - state?: components["schemas"]["state"]; - }; + "application/json": components["schemas"]["metrics"]; }; }; - /** @description The response will be a JSON object with a key called `alerts`. This will be set to an array of objects, each of which will contain the standard attributes associated with an uptime alert. */ - all_alerts: { + /** @description The response will be a JSON object with a key called `data` and `status`. */ + app_metric_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["metrics"]; + }; + }; + /** @description The response is a JSON object with a `destinations` key. */ + monitoring_list_destinations: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17841,12 +19384,12 @@ export interface components { }; content: { "application/json": { - alerts?: components["schemas"]["alert"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + destinations?: components["schemas"]["destination_omit_credentials"][]; + }; }; }; - /** @description The response will be a JSON object with a key called `alert`. The value of this will be an object that contains the standard attributes associated with an uptime alert. */ - existing_alert: { + /** @description The response is a JSON object with a `destination` key. */ + destination: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17855,17 +19398,771 @@ export interface components { }; content: { "application/json": { - alert?: components["schemas"]["alert"]; + destination?: components["schemas"]["destination_omit_credentials"]; }; }; }; - }; - parameters: { - /** - * @description Restrict results to a certain type of 1-Click. - * @example kubernetes - */ - oneClicks_type: "droplet" | "kubernetes"; + /** @description The response is a JSON object with a `sinks` key. */ + list_sinks: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description List of sinks identified by their URNs. */ + sinks?: components["schemas"]["sinks_response"][]; + }; + }; + }; + /** @description The response is a JSON object with a `sink` key. */ + sinks: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + sink?: components["schemas"]["sinks_response"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `projects`. The value of this will be an object with the standard project attributes */ + projects_list: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + projects?: components["schemas"]["project"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `project`. The value of this will be an object with the standard project attributes */ + existing_project: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + project?: components["schemas"]["project"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `project`. The value of this will be an object with the standard project attributes */ + default_project: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + project?: components["schemas"]["project"]; + }; + }; + }; + /** @description Only an empty project can be deleted. */ + precondition_failed: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + /** @description The response will be a JSON object with a key called `resources`. The value of this will be an object with the standard resource attributes. */ + resources_list: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + resources?: components["schemas"]["resource"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `resources`. The value of this will be an object with the standard resource attributes. */ + assigned_resources_list: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + resources?: components["schemas"]["resource"][]; + }; + }; + }; + /** @description A JSON object with a key set to `regions`. The value is an array of `region` objects, each of which contain the standard `region` attributes. */ + all_regions: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + regions: components["schemas"]["region"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with the key `registry` containing information about your registry. */ + registry_info: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + registry?: components["schemas"]["registry"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `subscription` containing information about your subscription. */ + subscription_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + subscription?: components["schemas"]["subscription"]; + }; + }; + }; + /** @description A Docker `config.json` file for the container registry. */ + docker_credentials: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["docker_credentials"]; + }; + }; + /** @description The response body will be a JSON object with a key of `repositories`. This will be set to an array containing objects each representing a repository. */ + all_repositories: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + repositories?: components["schemas"]["repository"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response body will be a JSON object with a key of `repositories`. This will be set to an array containing objects each representing a repository. */ + all_repositories_v2: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + repositories?: components["schemas"]["repository_v2"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response body will be a JSON object with a key of `tags`. This will be set to an array containing objects each representing a tag. */ + repository_tags: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + tags?: components["schemas"]["repository_tag"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response body will be a JSON object with a key of `manifests`. This will be set to an array containing objects each representing a manifest. */ + repository_manifests: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + manifests?: components["schemas"]["repository_manifest"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key of `garbage_collection`. This will be a json object with attributes representing the currently-active garbage collection. */ + garbage_collection: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + garbage_collection?: components["schemas"]["garbage_collection"]; + }; + }; + }; + /** @description The response will be a JSON object with a key of `garbage_collections`. This will be set to an array containing objects representing each past garbage collection. Each will contain the standard Garbage Collection attributes. */ + garbage_collections: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + garbage_collections?: components["schemas"]["garbage_collection"][]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `options` which contains a key called `subscription_tiers` listing the available tiers. */ + registry_options_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + options?: { + /** @example [ + * "nyc3" + * ] */ + available_regions?: string[]; + subscription_tiers?: (components["schemas"]["subscription_tier_base"] & components["schemas"]["subscription_tier_extended"])[]; + }; + }; + }; + }; + /** @description A JSON object with an `neighbor_ids` key. */ + droplet_neighbors_ids: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["neighbor_ids"]; + }; + }; + /** @description The response will be a JSON object with a key called `reserved_ips`. This will be set to an array of reserved IP objects, each of which will contain the standard reserved IP attributes */ + reserved_ip_list: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + reserved_ips?: components["schemas"]["reserved_ip"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `reserved_ip`. The value of this will be an object that contains the standard attributes associated with a reserved IP. + * When assigning a reserved IP to a Droplet at same time as it created, the response's `links` object will contain links to both the Droplet and the assignment action. The latter can be used to check the status of the action. */ + reserved_ip_created: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + reserved_ip?: components["schemas"]["reserved_ip"]; + links?: { + droplets?: components["schemas"]["action_link"][]; + actions?: components["schemas"]["action_link"][]; + }; + }; + }; + }; + /** @description The response will be a JSON object with a key called `reserved_ip`. The value of this will be an object that contains the standard attributes associated with a reserved IP. */ + reserved_ip: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + reserved_ip?: components["schemas"]["reserved_ip"]; + }; + }; + }; + /** @description The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with action objects containing the standard reserved IP action attributes. */ + reserved_ip_actions: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + actions?: components["schemas"]["action"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard reserved IP action attributes. */ + reserved_ip_action: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + action?: components["schemas"]["action"] & { + /** + * Format: uuid + * @description The UUID of the project to which the reserved IP currently belongs. + * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + */ + project_id?: string; + }; + }; + }; + }; + /** @description A JSON object with a key called `sizes`. The value of this will be an array of `size` objects each of which contain the standard size attributes. */ + all_sizes: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + sizes: components["schemas"]["size"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description A JSON object with a key of `snapshots`. */ + snapshots: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + snapshots?: components["schemas"]["snapshots"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description A JSON object with a key called `snapshot`. + * */ + snapshots_existing: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + snapshot?: components["schemas"]["snapshots"]; + }; + }; + }; + /** @description Bad Request */ + not_a_snapshot: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + /** @description To list all of your tags, you can send a `GET` request to `/v2/tags`. */ + tags_all: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + tags?: components["schemas"]["tags"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called tag. The value of this will be a tag object containing the standard tag attributes */ + tags_new: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + tag?: components["schemas"]["tags"]; + }; + }; + }; + /** @description Bad Request */ + tags_bad_request: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + "x-request-id": components["headers"]["x-request-id"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error_with_root_causes"]; + }; + }; + /** @description The response will be a JSON object with a key called `tag`. The value of this will be a tag object containing the standard tag attributes. */ + tags_existing: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + tag?: components["schemas"]["tags"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `volumes`. This will be set to an array of volume objects, each of which will contain the standard volume attributes. */ + volumes: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Array of volumes. */ + volumes: components["schemas"]["volume_full"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `volume`. The value will be an object containing the standard attributes associated with a volume. */ + volume: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + volume?: components["schemas"]["volume_full"]; + }; + }; + }; + /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard volume action attributes */ + volumeAction: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + action?: components["schemas"]["volumeAction"]; + }; + }; + }; + /** @description You will get back a JSON object that has a `snapshot` key. This will contain the standard snapshot attributes */ + volumeSnapshot: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + snapshot?: components["schemas"]["snapshots"]; + }; + }; + }; + /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard volume action attributes. */ + volumeActions: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + actions?: components["schemas"]["volumeAction"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description You will get back a JSON object that has a `snapshots` key. This will be set to an array of snapshot objects, each of which contain the standard snapshot attributes */ + volumeSnapshots: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + snapshots?: components["schemas"]["snapshots"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `vpcs`. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC */ + all_vpcs: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + vpcs?: components["schemas"]["vpc"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `vpc`. The value of this will be an object that contains the standard attributes associated with a VPC. */ + existing_vpc: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + vpc?: components["schemas"]["vpc"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called members. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC member. */ + vpc_members: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + members?: components["schemas"]["vpc_member"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `peerings`. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC peering. */ + vpc_peerings: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + peerings?: components["schemas"]["vpc_peering"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `peering`, containing the standard attributes associated with a VPC peering. */ + vpc_peering: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + peering?: components["schemas"]["vpc_peering"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `vpc_peerings`. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC peering. */ + all_vpc_peerings: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + vpc_peerings?: components["schemas"]["vpc_peering"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `vpc_peering`. The value of this will be an object that contains the standard attributes associated with a VPC peering. */ + provisioning_vpc_peering: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + vpc_peering?: components["schemas"]["vpc_peering"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `vpc_peering`. The value of this will be an object that contains the standard attributes associated with a VPC peering. */ + active_vpc_peering: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + vpc_peering?: components["schemas"]["vpc_peering"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `vpc_peering`. The value of this will be an object that contains the standard attributes associated with a VPC peering. */ + deleting_vpc_peering: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + vpc_peering?: components["schemas"]["vpc_peering"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `checks`. This will be set to an array of objects, each of which will contain the standard attributes associated with an uptime check */ + all_checks: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + checks?: components["schemas"]["check"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `check`. The value of this will be an object that contains the standard attributes associated with an uptime check. */ + existing_check: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + check?: components["schemas"]["check"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `state`. The value of this will be an object that contains the standard attributes associated with an uptime check's state. */ + existing_check_state: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + state?: components["schemas"]["state"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `alerts`. This will be set to an array of objects, each of which will contain the standard attributes associated with an uptime alert. */ + all_alerts: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + alerts?: components["schemas"]["alert"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `alert`. The value of this will be an object that contains the standard attributes associated with an uptime alert. */ + existing_alert: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + alert?: components["schemas"]["alert"]; + }; + }; + }; + }; + parameters: { + /** + * @description Restrict results to a certain type of 1-Click. + * @example kubernetes + */ + oneClicks_type: "droplet" | "kubernetes"; /** * @description Number of items returned per page * @example 2 @@ -18215,6 +20512,11 @@ export interface components { * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ parameters_load_balancer_id: string; + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + parameters_autoscale_pool_id: string; /** * @description A unique identifier for a destination. * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 @@ -18346,164 +20648,758 @@ export interface components { */ parameters_alert_id: string; }; - requestBodies: never; - headers: { - /** - * @description The default limit on number of requests that can be made per hour and per minute. Current rate limits are 5000 requests per hour and 250 requests per minute. - * @example 5000 - */ - "ratelimit-limit": number; - /** - * @description The number of requests in your hourly quota that remain before you hit your request limit. See https://developers.digitalocean.com/documentation/v2/#rate-limit for information about how requests expire. - * @example 4816 - */ - "ratelimit-remaining": number; - /** - * @description The time when the oldest request will expire. The value is given in Unix epoch time. See https://developers.digitalocean.com/documentation/v2/#rate-limit for information about how requests expire. - * @example 1444931833 - */ - "ratelimit-reset": number; - /** - * @description Indicates if the content is expected to be displayed *inline* in the browser, that is, as a Web page or as part of a Web page, or as an *attachment*, that is downloaded and saved locally. - * @example attachment; filename="DigitalOcean Invoice 2020 Jul (6173678-418071234).csv" - */ - "content-disposition": string; - /** - * @description The type of data that is returned from a request. - * @example application/json; charset=utf-8 - */ - "content-type": string; - /** - * @description Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue. - * @example 515850a0-a812-50bf-aa3c-d0d21d287e40 - */ - "x-request-id": string; + requestBodies: never; + headers: { + /** + * @description The default limit on number of requests that can be made per hour and per minute. Current rate limits are 5000 requests per hour and 250 requests per minute. + * @example 5000 + */ + "ratelimit-limit": number; + /** + * @description The number of requests in your hourly quota that remain before you hit your request limit. See https://developers.digitalocean.com/documentation/v2/#rate-limit for information about how requests expire. + * @example 4816 + */ + "ratelimit-remaining": number; + /** + * @description The time when the oldest request will expire. The value is given in Unix epoch time. See https://developers.digitalocean.com/documentation/v2/#rate-limit for information about how requests expire. + * @example 1444931833 + */ + "ratelimit-reset": number; + /** + * @description Indicates if the content is expected to be displayed *inline* in the browser, that is, as a Web page or as part of a Web page, or as an *attachment*, that is downloaded and saved locally. + * @example attachment; filename="DigitalOcean Invoice 2020 Jul (6173678-418071234).csv" + */ + "content-disposition": string; + /** + * @description The type of data that is returned from a request. + * @example application/json; charset=utf-8 + */ + "content-type": string; + /** + * @description Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue. + * @example 515850a0-a812-50bf-aa3c-d0d21d287e40 + */ + "x-request-id": string; + }; + pathItems: never; +} +export type $defs = Record; +export interface operations { + oneClicks_list: { + parameters: { + query?: { + /** + * @description Restrict results to a certain type of 1-Click. + * @example kubernetes + */ + type?: components["parameters"]["oneClicks_type"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["oneClicks_all"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + oneClicks_install_kubernetes: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["oneClicks_create"]; + }; + }; + responses: { + 200: components["responses"]["oneClicks_create"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + account_get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["account"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + sshKeys_list: { + parameters: { + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["sshKeys_all"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + sshKeys_create: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["sshKeys"]; + }; + }; + responses: { + 201: components["responses"]["sshKeys_new"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + sshKeys_get: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description Either the ID or the fingerprint of an existing SSH key. + * @example 512189 + */ + ssh_key_identifier: components["parameters"]["ssh_key_identifier"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["sshKeys_existing"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + sshKeys_update: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description Either the ID or the fingerprint of an existing SSH key. + * @example 512189 + */ + ssh_key_identifier: components["parameters"]["ssh_key_identifier"]; + }; + cookie?: never; + }; + /** @description Set the `name` attribute to the new name you want to use. */ + requestBody: { + content: { + "application/json": { + name?: components["schemas"]["ssh_key_name"]; + }; + }; + }; + responses: { + 200: components["responses"]["sshKeys_existing"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + sshKeys_delete: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description Either the ID or the fingerprint of an existing SSH key. + * @example 512189 + */ + ssh_key_identifier: components["parameters"]["ssh_key_identifier"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + actions_list: { + parameters: { + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["actions"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + actions_get: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 + */ + action_id: components["parameters"]["action_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["action"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_list: { + parameters: { + query?: { + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Whether the project_id of listed apps should be fetched and included. + * @example true + */ + with_projects?: components["parameters"]["with_projects"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["list_apps"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_create: { + parameters: { + query?: never; + header?: { + /** + * @description The content-type that should be used by the response. By default, the response will be `application/json`. `application/yaml` is also supported. + * @example application/json + */ + Accept?: components["parameters"]["accept"]; + /** + * @description The content-type used for the request. By default, the requests are assumed to use `application/json`. `application/yaml` is also supported. + * @example application/json + */ + "Content-Type"?: components["parameters"]["content-type"]; + }; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + /** @example { + * "spec": { + * "name": "web-app", + * "region": "nyc", + * "services": [ + * { + * "name": "api", + * "github": { + * "branch": "main", + * "deploy_on_push": true, + * "repo": "digitalocean/sample-golang" + * }, + * "run_command": "bin/api", + * "environment_slug": "node-js", + * "instance_count": 2, + * "instance_size_slug": "apps-s-1vcpu-0.5gb", + * "routes": [ + * { + * "path": "/api" + * } + * ] + * } + * ], + * "egress": { + * "type": "DEDICATED_IP" + * } + * } + * } */ + "application/json": components["schemas"]["apps_create_app_request"]; + }; + }; + responses: { + 200: components["responses"]["new_app"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_get: { + parameters: { + query?: { + /** + * @description The name of the app to retrieve. + * @example myApp + */ + name?: components["parameters"]["app_name"]; + }; + header?: never; + path: { + /** + * @description The ID of the app + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + id: components["parameters"]["id_app"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["apps_get"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_update: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The ID of the app + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + id: components["parameters"]["id_app"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["apps_update_app_request"]; + }; + }; + responses: { + 200: components["responses"]["update_app"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; }; - pathItems: never; -} -export type $defs = Record; -export interface operations { - oneClicks_list: { + apps_delete: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The ID of the app + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + id: components["parameters"]["id_app"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["delete_app"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_restart: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["apps_restart_request"]; + }; + }; + responses: { + 200: components["responses"]["new_app_deployment"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_get_logs_active_deployment: { + parameters: { + query: { + /** + * @description Whether the logs should follow live updates. + * @example true + */ + follow?: components["parameters"]["live_updates"]; + /** + * @description The type of logs to retrieve + * - BUILD: Build-time logs + * - DEPLOY: Deploy-time logs + * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime + * @example BUILD + */ + type: components["parameters"]["log_type"]; + /** + * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. + * @example 3m + */ + pod_connection_timeout?: components["parameters"]["time_wait"]; + }; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + /** + * @description An optional component name. If set, logs will be limited to this component only. + * @example component + */ + component_name: components["parameters"]["component"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["list_logs"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_get_exec_active_deployment: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + /** + * @description An optional component name. If set, logs will be limited to this component only. + * @example component + */ + component_name: components["parameters"]["component"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["get_exec"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_list_deployments: { parameters: { query?: { /** - * @description Restrict results to a certain type of 1-Click. - * @example kubernetes + * @description Which 'page' of paginated results to return. + * @example 1 */ - type?: components["parameters"]["oneClicks_type"]; + page?: components["parameters"]["page"]; + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; }; header?: never; - path?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["oneClicks_all"]; + 200: components["responses"]["existing_deployments"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - oneClicks_install_kubernetes: { + apps_create_deployment: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["oneClicks_create"]; + "application/json": components["schemas"]["apps_create_deployment_request"]; + }; + }; + responses: { + 200: components["responses"]["new_app_deployment"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_get_deployment: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id: components["parameters"]["deployment_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["oneClicks_create"]; + 200: components["responses"]["list_deployment"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - account_get: { + apps_cancel_deployment: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id: components["parameters"]["deployment_id"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["account"]; + 200: components["responses"]["cancel_deployment"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - sshKeys_list: { + apps_get_logs: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description Whether the logs should follow live updates. + * @example true */ - per_page?: components["parameters"]["per_page"]; + follow?: components["parameters"]["live_updates"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description The type of logs to retrieve + * - BUILD: Build-time logs + * - DEPLOY: Deploy-time logs + * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime + * @example BUILD */ - page?: components["parameters"]["page"]; + type: components["parameters"]["log_type"]; + /** + * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. + * @example 3m + */ + pod_connection_timeout?: components["parameters"]["time_wait"]; }; header?: never; - path?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id: components["parameters"]["deployment_id"]; + /** + * @description An optional component name. If set, logs will be limited to this component only. + * @example component + */ + component_name: components["parameters"]["component"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["sshKeys_all"]; + 200: components["responses"]["list_logs"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - sshKeys_create: { + apps_get_logs_aggregate: { parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["sshKeys"]; + query: { + /** + * @description Whether the logs should follow live updates. + * @example true + */ + follow?: components["parameters"]["live_updates"]; + /** + * @description The type of logs to retrieve + * - BUILD: Build-time logs + * - DEPLOY: Deploy-time logs + * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime + * @example BUILD + */ + type: components["parameters"]["log_type"]; + /** + * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. + * @example 3m + */ + pod_connection_timeout?: components["parameters"]["time_wait"]; }; - }; - responses: { - 201: components["responses"]["sshKeys_new"]; - 401: components["responses"]["unauthorized"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - sshKeys_get: { - parameters: { - query?: never; header?: never; path: { /** - * @description Either the ID or the fingerprint of an existing SSH key. - * @example 512189 + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - ssh_key_identifier: components["parameters"]["ssh_key_identifier"]; + app_id: components["parameters"]["app_id"]; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id: components["parameters"]["deployment_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["sshKeys_existing"]; + 200: components["responses"]["list_logs"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18511,29 +21407,32 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - sshKeys_update: { + apps_get_exec: { parameters: { query?: never; header?: never; path: { /** - * @description Either the ID or the fingerprint of an existing SSH key. - * @example 512189 + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - ssh_key_identifier: components["parameters"]["ssh_key_identifier"]; + app_id: components["parameters"]["app_id"]; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id: components["parameters"]["deployment_id"]; + /** + * @description An optional component name. If set, logs will be limited to this component only. + * @example component + */ + component_name: components["parameters"]["component"]; }; cookie?: never; }; - /** @description Set the `name` attribute to the new name you want to use. */ - requestBody: { - content: { - "application/json": { - name?: components["schemas"]["ssh_key_name"]; - }; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["sshKeys_existing"]; + 200: components["responses"]["get_exec"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18541,22 +21440,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - sshKeys_delete: { + apps_get_logs_active_deployment_aggregate: { parameters: { - query?: never; + query: { + /** + * @description Whether the logs should follow live updates. + * @example true + */ + follow?: components["parameters"]["live_updates"]; + /** + * @description The type of logs to retrieve + * - BUILD: Build-time logs + * - DEPLOY: Deploy-time logs + * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime + * @example BUILD + */ + type: components["parameters"]["log_type"]; + /** + * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. + * @example 3m + */ + pod_connection_timeout?: components["parameters"]["time_wait"]; + }; header?: never; path: { /** - * @description Either the ID or the fingerprint of an existing SSH key. - * @example 512189 + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - ssh_key_identifier: components["parameters"]["ssh_key_identifier"]; + app_id: components["parameters"]["app_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["list_logs"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18564,49 +21483,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - actions_list: { + apps_list_instanceSizes: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["actions"]; + 200: components["responses"]["list_instance"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - actions_get: { + apps_get_instanceSize: { parameters: { query?: never; header?: never; path: { /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 + * @description The slug of the instance size + * @example apps-s-1vcpu-0.5gb */ - action_id: components["parameters"]["action_id"]; + slug: components["parameters"]["slug_size"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["action"]; + 200: components["responses"]["get_instance"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18614,53 +21522,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_list: { + apps_list_regions: { parameters: { - query?: { - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Whether the project_id of listed apps should be fetched and included. - * @example true - */ - with_projects?: components["parameters"]["with_projects"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_apps"]; + 200: components["responses"]["list_regions"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - apps_create: { + apps_validate_appSpec: { parameters: { query?: never; - header?: { - /** - * @description The content-type that should be used by the response. By default, the response will be `application/json`. `application/yaml` is also supported. - * @example application/json - */ - Accept?: components["parameters"]["accept"]; - /** - * @description The content-type used for the request. By default, the requests are assumed to use `application/json`. `application/yaml` is also supported. - * @example application/json - */ - "Content-Type"?: components["parameters"]["content-type"]; - }; + header?: never; path?: never; cookie?: never; }; @@ -18688,45 +21569,37 @@ export interface operations { * } * ] * } - * ], - * "egress": { - * "type": "DEDICATED_IP" - * } - * } + * ] + * }, + * "app_id": "b6bdf840-2854-4f87-a36c-5f231c617c84" * } */ - "application/json": components["schemas"]["apps_create_app_request"]; + "application/json": components["schemas"]["app_propose"]; }; }; responses: { - 200: components["responses"]["new_app"]; + 200: components["responses"]["propose_app"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - apps_get: { + apps_list_alerts: { parameters: { - query?: { - /** - * @description The name of the app to retrieve. - * @example myApp - */ - name?: components["parameters"]["app_name"]; - }; + query?: never; header?: never; path: { /** - * @description The ID of the app + * @description The app ID * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - id: components["parameters"]["id_app"]; + app_id: components["parameters"]["app_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["apps_get"]; + 200: components["responses"]["list_alerts"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18734,26 +21607,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_update: { + apps_assign_alertDestinations: { parameters: { query?: never; header?: never; path: { /** - * @description The ID of the app + * @description The app ID * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - id: components["parameters"]["id_app"]; + app_id: components["parameters"]["app_id"]; + /** + * @description The alert ID + * @example 5a624ab5-dd58-4b39-b7dd-8b7c36e8a91d + */ + alert_id: components["parameters"]["alert_id"]; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["apps_update_app_request"]; + "application/json": components["schemas"]["apps_assign_app_alert_destinations_request"]; }; }; responses: { - 200: components["responses"]["update_app"]; + 200: components["responses"]["assign_alert_destinations"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18761,22 +21639,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_delete: { + apps_create_rollback: { parameters: { query?: never; header?: never; path: { /** - * @description The ID of the app + * @description The app ID * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - id: components["parameters"]["id_app"]; + app_id: components["parameters"]["app_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["apps_rollback_app_request"]; + }; + }; responses: { - 200: components["responses"]["delete_app"]; + 200: components["responses"]["new_app_deployment"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18784,7 +21666,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_restart: { + apps_validate_rollback: { parameters: { query?: never; header?: never; @@ -18797,13 +21679,13 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": components["schemas"]["apps_restart_request"]; + "application/json": components["schemas"]["apps_rollback_app_request"]; }; }; responses: { - 200: components["responses"]["new_app_deployment"]; + 200: components["responses"]["apps_validate_rollback"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18811,29 +21693,9 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_logs_active_deployment: { + apps_commit_rollback: { parameters: { - query: { - /** - * @description Whether the logs should follow live updates. - * @example true - */ - follow?: components["parameters"]["live_updates"]; - /** - * @description The type of logs to retrieve - * - BUILD: Build-time logs - * - DEPLOY: Deploy-time logs - * - RUN: Live run-time logs - * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - * @example BUILD - */ - type: components["parameters"]["log_type"]; - /** - * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. - * @example 3m - */ - pod_connection_timeout?: components["parameters"]["time_wait"]; - }; + query?: never; header?: never; path: { /** @@ -18841,17 +21703,12 @@ export interface operations { * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ app_id: components["parameters"]["app_id"]; - /** - * @description An optional component name. If set, logs will be limited to this component only. - * @example component - */ - component_name: components["parameters"]["component"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_logs"]; + 200: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18859,7 +21716,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_exec_active_deployment: { + apps_revert_rollback: { parameters: { query?: never; header?: never; @@ -18869,17 +21726,12 @@ export interface operations { * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ app_id: components["parameters"]["app_id"]; - /** - * @description An optional component name. If set, logs will be limited to this component only. - * @example component - */ - component_name: components["parameters"]["component"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_exec"]; + 200: components["responses"]["new_app_deployment"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18887,19 +21739,14 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_list_deployments: { + apps_get_metrics_bandwidth_daily: { parameters: { query?: { /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - /** - * @description Number of items returned per page - * @example 2 + * @description Optional day to query. Only the date component of the timestamp will be considered. Default: yesterday. + * @example 2023-01-17T00:00:00Z */ - per_page?: components["parameters"]["per_page"]; + date?: string; }; header?: never; path: { @@ -18913,7 +21760,7 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["existing_deployments"]; + 200: components["responses"]["get_metrics_bandwidth_usage"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18921,26 +21768,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_create_deployment: { + apps_list_metrics_bandwidth_daily: { parameters: { query?: never; header?: never; - path: { - /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - }; + path?: never; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["apps_create_deployment_request"]; + /** @example { + * "app_ids": [ + * "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf", + * "c2a93513-8d9b-4223-9d61-5e7272c81cf5" + * ], + * "date": "2023-01-17T00:00:00Z" + * } */ + "application/json": components["schemas"]["app_metrics_bandwidth_usage_request"]; }; }; responses: { - 200: components["responses"]["new_app_deployment"]; + 200: components["responses"]["list_metrics_bandwidth_usage"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -18948,108 +21796,69 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_deployment: { + cdn_list_endpoints: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description Number of items returned per page + * @example 2 */ - app_id: components["parameters"]["app_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description The deployment ID - * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + * @description Which 'page' of paginated results to return. + * @example 1 */ - deployment_id: components["parameters"]["deployment_id"]; + page?: components["parameters"]["page"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_deployment"]; + 200: components["responses"]["all_cdn_endpoints"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - apps_cancel_deployment: { + cdn_create_endpoint: { parameters: { query?: never; header?: never; - path: { - /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - /** - * @description The deployment ID - * @example 3aa4d20e-5527-4c00-b496-601fbd22520a - */ - deployment_id: components["parameters"]["deployment_id"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["cdn_endpoint"]; + }; + }; responses: { - 200: components["responses"]["cancel_deployment"]; + 201: components["responses"]["existing_endpoint"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - apps_get_logs: { + cdn_get_endpoint: { parameters: { - query: { - /** - * @description Whether the logs should follow live updates. - * @example true - */ - follow?: components["parameters"]["live_updates"]; - /** - * @description The type of logs to retrieve - * - BUILD: Build-time logs - * - DEPLOY: Deploy-time logs - * - RUN: Live run-time logs - * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - * @example BUILD - */ - type: components["parameters"]["log_type"]; - /** - * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. - * @example 3m - */ - pod_connection_timeout?: components["parameters"]["time_wait"]; - }; + query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - /** - * @description The deployment ID - * @example 3aa4d20e-5527-4c00-b496-601fbd22520a - */ - deployment_id: components["parameters"]["deployment_id"]; - /** - * @description An optional component name. If set, logs will be limited to this component only. - * @example component + * @description A unique identifier for a CDN endpoint. + * @example 19f06b6a-3ace-4315-b086-499a0e521b76 */ - component_name: components["parameters"]["component"]; + cdn_id: components["parameters"]["cdn_endpoint_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_logs"]; + 200: components["responses"]["existing_endpoint"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19057,47 +21866,49 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_logs_aggregate: { + cdn_update_endpoints: { parameters: { - query: { - /** - * @description Whether the logs should follow live updates. - * @example true - */ - follow?: components["parameters"]["live_updates"]; - /** - * @description The type of logs to retrieve - * - BUILD: Build-time logs - * - DEPLOY: Deploy-time logs - * - RUN: Live run-time logs - * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - * @example BUILD - */ - type: components["parameters"]["log_type"]; + query?: never; + header?: never; + path: { /** - * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. - * @example 3m + * @description A unique identifier for a CDN endpoint. + * @example 19f06b6a-3ace-4315-b086-499a0e521b76 */ - pod_connection_timeout?: components["parameters"]["time_wait"]; + cdn_id: components["parameters"]["cdn_endpoint_id"]; }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["update_endpoint"]; + }; + }; + responses: { + 200: components["responses"]["existing_endpoint"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + cdn_delete_endpoint: { + parameters: { + query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - /** - * @description The deployment ID - * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + * @description A unique identifier for a CDN endpoint. + * @example 19f06b6a-3ace-4315-b086-499a0e521b76 */ - deployment_id: components["parameters"]["deployment_id"]; + cdn_id: components["parameters"]["cdn_endpoint_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_logs"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19105,32 +21916,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_exec: { + cdn_purge_cache: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - /** - * @description The deployment ID - * @example 3aa4d20e-5527-4c00-b496-601fbd22520a - */ - deployment_id: components["parameters"]["deployment_id"]; - /** - * @description An optional component name. If set, logs will be limited to this component only. - * @example component + * @description A unique identifier for a CDN endpoint. + * @example 19f06b6a-3ace-4315-b086-499a0e521b76 */ - component_name: components["parameters"]["component"]; + cdn_id: components["parameters"]["cdn_endpoint_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["purge_cache"]; + }; + }; responses: { - 200: components["responses"]["get_exec"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19138,81 +21943,74 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_logs_active_deployment_aggregate: { + certificates_list: { parameters: { - query: { + query?: { /** - * @description Whether the logs should follow live updates. - * @example true + * @description Number of items returned per page + * @example 2 */ - follow?: components["parameters"]["live_updates"]; + per_page?: components["parameters"]["per_page"]; /** - * @description The type of logs to retrieve - * - BUILD: Build-time logs - * - DEPLOY: Deploy-time logs - * - RUN: Live run-time logs - * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - * @example BUILD + * @description Which 'page' of paginated results to return. + * @example 1 */ - type: components["parameters"]["log_type"]; + page?: components["parameters"]["page"]; /** - * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. - * @example 3m + * @description Name of expected certificate + * @example certificate-name */ - pod_connection_timeout?: components["parameters"]["time_wait"]; + name?: components["parameters"]["certificate_name"]; }; header?: never; - path: { - /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_logs"]; + 200: components["responses"]["all_certificates"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - apps_list_instanceSizes: { + certificates_create: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["certificate_request_lets_encrypt"] | components["schemas"]["certificate_request_custom"]; + }; + }; responses: { - 200: components["responses"]["list_instance"]; + 201: components["responses"]["new_certificate"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - apps_get_instanceSize: { + certificates_get: { parameters: { query?: never; header?: never; path: { /** - * @description The slug of the instance size - * @example apps-s-1vcpu-0.5gb + * @description A unique identifier for a certificate. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - slug: components["parameters"]["slug_size"]; + certificate_id: components["parameters"]["certificate_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_instance"]; + 200: components["responses"]["existing_certificate"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19220,84 +22018,56 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_list_regions: { + certificates_delete: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique identifier for a certificate. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + certificate_id: components["parameters"]["certificate_id"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_regions"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - apps_validate_appSpec: { + balance_get: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - requestBody: { - content: { - /** @example { - * "spec": { - * "name": "web-app", - * "region": "nyc", - * "services": [ - * { - * "name": "api", - * "github": { - * "branch": "main", - * "deploy_on_push": true, - * "repo": "digitalocean/sample-golang" - * }, - * "run_command": "bin/api", - * "environment_slug": "node-js", - * "instance_count": 2, - * "instance_size_slug": "apps-s-1vcpu-0.5gb", - * "routes": [ - * { - * "path": "/api" - * } - * ] - * } - * ] - * }, - * "app_id": "b6bdf840-2854-4f87-a36c-5f231c617c84" - * } */ - "application/json": components["schemas"]["app_propose"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["propose_app"]; + 200: components["responses"]["balance"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - apps_list_alerts: { + billingHistory_list: { parameters: { query?: never; header?: never; - path: { - /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_alerts"]; + 200: components["responses"]["billing_history"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19305,31 +22075,60 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_assign_alertDestinations: { + invoices_list: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description Number of items returned per page + * @example 2 */ - app_id: components["parameters"]["app_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description The alert ID - * @example 5a624ab5-dd58-4b39-b7dd-8b7c36e8a91d + * @description Which 'page' of paginated results to return. + * @example 1 */ - alert_id: components["parameters"]["alert_id"]; + page?: components["parameters"]["page"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["apps_assign_app_alert_destinations_request"]; + requestBody?: never; + responses: { + 200: components["responses"]["invoices"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + invoices_get_byUUID: { + parameters: { + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** + * @description UUID of the invoice + * @example 22737513-0ea7-4206-8ceb-98a575af7681 + */ + invoice_uuid: components["parameters"]["invoice_uuid"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["assign_alert_destinations"]; + 200: components["responses"]["invoice"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19337,26 +22136,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_create_rollback: { + invoices_get_csvByUUID: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description UUID of the invoice + * @example 22737513-0ea7-4206-8ceb-98a575af7681 */ - app_id: components["parameters"]["app_id"]; + invoice_uuid: components["parameters"]["invoice_uuid"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["apps_rollback_app_request"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["new_app_deployment"]; + 200: components["responses"]["invoice_csv"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19364,26 +22159,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_validate_rollback: { + invoices_get_pdfByUUID: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description UUID of the invoice + * @example 22737513-0ea7-4206-8ceb-98a575af7681 */ - app_id: components["parameters"]["app_id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["apps_rollback_app_request"]; + invoice_uuid: components["parameters"]["invoice_uuid"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["apps_validate_rollback"]; + 200: components["responses"]["invoice_pdf"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19391,22 +22182,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_commit_rollback: { + invoices_get_summaryByUUID: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description UUID of the invoice + * @example 22737513-0ea7-4206-8ceb-98a575af7681 */ - app_id: components["parameters"]["app_id"]; + invoice_uuid: components["parameters"]["invoice_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["no_content"]; + 200: components["responses"]["invoice_summary"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19414,22 +22205,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_revert_rollback: { + databases_list_options: { parameters: { query?: never; header?: never; - path: { - /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["new_app_deployment"]; + 200: components["responses"]["options"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19437,28 +22222,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_metrics_bandwidth_daily: { + databases_list_clusters: { parameters: { query?: { /** - * @description Optional day to query. Only the date component of the timestamp will be considered. Default: yesterday. - * @example 2023-01-17T00:00:00Z + * @description Limits the results to database clusters with a specific tag. + * @example production */ - date?: string; + tag_name?: components["parameters"]["tag_name"]; }; header?: never; - path: { - /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_metrics_bandwidth_usage"]; + 200: components["responses"]["database_clusters"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19466,7 +22245,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_list_metrics_bandwidth_daily: { + databases_create_cluster: { parameters: { query?: never; header?: never; @@ -19475,18 +22254,13 @@ export interface operations { }; requestBody: { content: { - /** @example { - * "app_ids": [ - * "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf", - * "c2a93513-8d9b-4223-9d61-5e7272c81cf5" - * ], - * "date": "2023-01-17T00:00:00Z" - * } */ - "application/json": components["schemas"]["app_metrics_bandwidth_usage_request"]; + "application/json": components["schemas"]["database_cluster"] & { + backup_restore?: components["schemas"]["database_backup"]; + }; }; }; responses: { - 200: components["responses"]["list_metrics_bandwidth_usage"]; + 201: components["responses"]["database_cluster"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19494,69 +22268,68 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - cdn_list_endpoints: { + databases_get_cluster: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; + query?: never; + header?: never; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - page?: components["parameters"]["page"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_cdn_endpoints"]; + 200: components["responses"]["database_cluster"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - cdn_create_endpoint: { + databases_destroy_cluster: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["cdn_endpoint"]; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 201: components["responses"]["existing_endpoint"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - cdn_get_endpoint: { + databases_get_config: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a CDN endpoint. - * @example 19f06b6a-3ace-4315-b086-499a0e521b76 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - cdn_id: components["parameters"]["cdn_endpoint_id"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_endpoint"]; + 200: components["responses"]["database_config"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19564,26 +22337,32 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - cdn_update_endpoints: { + databases_patch_config: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a CDN endpoint. - * @example 19f06b6a-3ace-4315-b086-499a0e521b76 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - cdn_id: components["parameters"]["cdn_endpoint_id"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["update_endpoint"]; + /** @example { + * "config": { + * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES", + * "sql_require_primary_key": true + * } + * } */ + "application/json": components["schemas"]["database_config"]; }; }; responses: { - 200: components["responses"]["existing_endpoint"]; + 200: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19591,22 +22370,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - cdn_delete_endpoint: { + databases_get_ca: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a CDN endpoint. - * @example 19f06b6a-3ace-4315-b086-499a0e521b76 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - cdn_id: components["parameters"]["cdn_endpoint_id"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["ca"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19614,26 +22393,63 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - cdn_purge_cache: { + databases_get_migrationStatus: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a CDN endpoint. - * @example 19f06b6a-3ace-4315-b086-499a0e521b76 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - cdn_id: components["parameters"]["cdn_endpoint_id"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["online_migration"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + databases_update_onlineMigration: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["purge_cache"]; + /** @example { + * "source": { + * "host": "source-do-user-6607903-0.b.db.ondigitalocean.com", + * "dbname": "defaultdb", + * "port": 25060, + * "username": "doadmin", + * "password": "paakjnfe10rsrsmf" + * }, + * "disable_ssl": false, + * "ignore_dbs": [ + * "db0", + * "db1" + * ] + * } */ + "application/json": components["schemas"]["source_database"]; }; }; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["online_migration"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19641,74 +22457,92 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - certificates_list: { + databases_delete_onlineMigration: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; + query?: never; + header?: never; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - page?: components["parameters"]["page"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; /** - * @description Name of expected certificate - * @example certificate-name + * @description A unique identifier assigned to the online migration. + * @example 77b28fc8-19ff-11eb-8c9c-c68e24557488 */ - name?: components["parameters"]["certificate_name"]; + migration_id: components["parameters"]["migration_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_certificates"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - certificates_create: { + databases_update_region: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["certificate_request_lets_encrypt"] | components["schemas"]["certificate_request_custom"]; + "application/json": { + /** + * @description A slug identifier for the region to which the database cluster will be migrated. + * @example lon1 + */ + region: string; + }; }; }; responses: { - 201: components["responses"]["new_certificate"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - certificates_get: { + databases_update_clusterSize: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a certificate. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - certificate_id: components["parameters"]["certificate_id"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** @example { + * "size": "db-s-4vcpu-8gb", + * "num_nodes": 3, + * "storage_size_mib": 163840 + * } */ + "application/json": components["schemas"]["database_cluster_resize"]; + }; + }; responses: { - 200: components["responses"]["existing_certificate"]; + 202: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19716,22 +22550,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - certificates_delete: { + databases_list_firewall_rules: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a certificate. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - certificate_id: components["parameters"]["certificate_id"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["firewall_rules"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19739,16 +22573,48 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - balance_get: { + databases_update_firewall_rules: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** @example { + * "rules": [ + * { + * "type": "ip_addr", + * "value": "192.168.1.1" + * }, + * { + * "type": "k8s", + * "value": "ff2a6c52-5a44-4b63-b99c-0e98e7a63d61" + * }, + * { + * "type": "droplet", + * "value": "163973392" + * }, + * { + * "type": "tag", + * "value": "backend" + * } + * ] + * } */ + "application/json": { + rules?: components["schemas"]["firewall_rule"][]; + }; + }; + }; responses: { - 200: components["responses"]["balance"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19756,77 +22622,53 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - billingHistory_list: { + databases_update_maintenanceWindow: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: components["responses"]["billing_history"]; - 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - invoices_list: { - parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - page?: components["parameters"]["page"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** @example { + * "day": "tuesday", + * "hour": "14:00" + * } */ + "application/json": components["schemas"]["database_maintenance_window"]; + }; + }; responses: { - 200: components["responses"]["invoices"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - invoices_get_byUUID: { + databases_install_update: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** - * @description UUID of the invoice - * @example 22737513-0ea7-4206-8ceb-98a575af7681 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - invoice_uuid: components["parameters"]["invoice_uuid"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["invoice"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19834,22 +22676,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - invoices_get_csvByUUID: { + databases_list_backups: { parameters: { query?: never; header?: never; path: { /** - * @description UUID of the invoice - * @example 22737513-0ea7-4206-8ceb-98a575af7681 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - invoice_uuid: components["parameters"]["invoice_uuid"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["invoice_csv"]; + 200: components["responses"]["database_backups"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19857,22 +22699,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - invoices_get_pdfByUUID: { + databases_list_replicas: { parameters: { query?: never; header?: never; path: { /** - * @description UUID of the invoice - * @example 22737513-0ea7-4206-8ceb-98a575af7681 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - invoice_uuid: components["parameters"]["invoice_uuid"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["invoice_pdf"]; + 200: components["responses"]["database_replicas"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19880,22 +22722,32 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - invoices_get_summaryByUUID: { + databases_create_replica: { parameters: { query?: never; header?: never; path: { /** - * @description UUID of the invoice - * @example 22737513-0ea7-4206-8ceb-98a575af7681 + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - invoice_uuid: components["parameters"]["invoice_uuid"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + /** @example { + * "name": "read-nyc3-01", + * "region": "nyc3", + * "size": "db-s-2vcpu-4gb", + * "storage_size_mib": 61440 + * } */ + "application/json": WithRequired; + }; + }; responses: { - 200: components["responses"]["invoice_summary"]; + 201: components["responses"]["database_replica"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19903,16 +22755,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_options: { + databases_list_events_logs: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["options"]; + 200: components["responses"]["events_logs"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19920,22 +22778,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_clusters: { + databases_get_replica: { parameters: { - query?: { + query?: never; + header?: never; + path: { /** - * @description Limits the results to database clusters with a specific tag. - * @example production + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - tag_name?: components["parameters"]["tag_name"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database replica. + * @example read-nyc3-01 + */ + replica_name: components["parameters"]["replica_name"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["database_clusters"]; + 200: components["responses"]["database_replica"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19943,22 +22806,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_create_cluster: { + databases_destroy_replica: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["database_cluster"] & { - backup_restore?: components["schemas"]["database_backup"]; - }; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database replica. + * @example read-nyc3-01 + */ + replica_name: components["parameters"]["replica_name"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 201: components["responses"]["database_cluster"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19966,7 +22834,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_cluster: { + databases_promote_replica: { parameters: { query?: never; header?: never; @@ -19976,12 +22844,17 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database replica. + * @example read-nyc3-01 + */ + replica_name: components["parameters"]["replica_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["database_cluster"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -19989,7 +22862,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_destroy_cluster: { + databases_list_users: { parameters: { query?: never; header?: never; @@ -20004,7 +22877,7 @@ export interface operations { }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["users"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20012,7 +22885,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_config: { + databases_add_user: { parameters: { query?: never; header?: never; @@ -20025,9 +22898,21 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["database_user"] & { + /** + * @description For MongoDB clusters, set to `true` to create a read-only user. + * This option is not currently supported for other database engines. + * + * @example true + */ + readonly?: boolean; + }; + }; + }; responses: { - 200: components["responses"]["database_config"]; + 201: components["responses"]["user"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20035,7 +22920,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_patch_config: { + databases_get_user: { parameters: { query?: never; header?: never; @@ -20045,22 +22930,17 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database user. + * @example app-01 + */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody: { - content: { - /** @example { - * "config": { - * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES", - * "sql_require_primary_key": true - * } - * } */ - "application/json": components["schemas"]["database_config"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["no_content"]; + 200: components["responses"]["user"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20068,7 +22948,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_ca: { + databases_update_user: { parameters: { query?: never; header?: never; @@ -20078,12 +22958,23 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database user. + * @example app-01 + */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + settings: components["schemas"]["user_settings"]; + }; + }; + }; responses: { - 200: components["responses"]["ca"]; + 201: components["responses"]["user"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20091,7 +22982,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_migrationStatus: { + databases_delete_user: { parameters: { query?: never; header?: never; @@ -20101,12 +22992,17 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database user. + * @example app-01 + */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["online_migration"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20114,7 +23010,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_onlineMigration: { + databases_reset_auth: { parameters: { query?: never; header?: never; @@ -20124,30 +23020,28 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database user. + * @example app-01 + */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody: { content: { /** @example { - * "source": { - * "host": "source-do-user-6607903-0.b.db.ondigitalocean.com", - * "dbname": "defaultdb", - * "port": 25060, - * "username": "doadmin", - * "password": "paakjnfe10rsrsmf" - * }, - * "disable_ssl": false, - * "ignore_dbs": [ - * "db0", - * "db1" - * ] + * "mysql_settings": { + * "auth_plugin": "caching_sha2_password" + * } * } */ - "application/json": components["schemas"]["source_database"]; + "application/json": { + mysql_settings?: components["schemas"]["mysql_settings"]; + }; }; }; responses: { - 200: components["responses"]["online_migration"]; + 200: components["responses"]["user"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20155,7 +23049,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete_onlineMigration: { + databases_list: { parameters: { query?: never; header?: never; @@ -20165,17 +23059,12 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description A unique identifier assigned to the online migration. - * @example 77b28fc8-19ff-11eb-8c9c-c68e24557488 - */ - migration_id: components["parameters"]["migration_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["databases"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20183,7 +23072,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_region: { + databases_add: { parameters: { query?: never; header?: never; @@ -20198,17 +23087,14 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** - * @description A slug identifier for the region to which the database cluster will be migrated. - * @example lon1 - */ - region: string; - }; + /** @example { + * "name": "alpha" + * } */ + "application/json": components["schemas"]["database"]; }; }; responses: { - 202: components["responses"]["accepted"]; + 201: components["responses"]["database"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20216,7 +23102,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_clusterSize: { + databases_get: { parameters: { query?: never; header?: never; @@ -20226,21 +23112,17 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database. + * @example alpha + */ + database_name: components["parameters"]["database_name"]; }; cookie?: never; }; - requestBody: { - content: { - /** @example { - * "size": "db-s-4vcpu-8gb", - * "num_nodes": 3, - * "storage_size_mib": 163840 - * } */ - "application/json": components["schemas"]["database_cluster_resize"]; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["no_content"]; + 200: components["responses"]["database"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20248,7 +23130,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_firewall_rules: { + databases_delete: { parameters: { query?: never; header?: never; @@ -20258,12 +23140,17 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database. + * @example alpha + */ + database_name: components["parameters"]["database_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["firewall_rules"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20271,7 +23158,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_firewall_rules: { + databases_list_connectionPools: { parameters: { query?: never; header?: never; @@ -20284,35 +23171,9 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - /** @example { - * "rules": [ - * { - * "type": "ip_addr", - * "value": "192.168.1.1" - * }, - * { - * "type": "k8s", - * "value": "ff2a6c52-5a44-4b63-b99c-0e98e7a63d61" - * }, - * { - * "type": "droplet", - * "value": "163973392" - * }, - * { - * "type": "tag", - * "value": "backend" - * } - * ] - * } */ - "application/json": { - rules?: components["schemas"]["firewall_rule"][]; - }; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["connection_pools"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20320,7 +23181,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_maintenanceWindow: { + databases_add_connectionPool: { parameters: { query?: never; header?: never; @@ -20336,14 +23197,17 @@ export interface operations { requestBody: { content: { /** @example { - * "day": "tuesday", - * "hour": "14:00" + * "name": "backend-pool", + * "mode": "transaction", + * "size": 10, + * "db": "defaultdb", + * "user": "doadmin" * } */ - "application/json": components["schemas"]["database_maintenance_window"]; + "application/json": components["schemas"]["connection_pool"]; }; }; responses: { - 204: components["responses"]["no_content"]; + 201: components["responses"]["connection_pool"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20351,7 +23215,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_install_update: { + databases_get_connectionPool: { parameters: { query?: never; header?: never; @@ -20361,12 +23225,17 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name used to identify the connection pool. + * @example backend-pool + */ + pool_name: components["parameters"]["pool_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["connection_pool"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20374,7 +23243,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_backups: { + databases_update_connectionPool: { parameters: { query?: never; header?: never; @@ -20384,12 +23253,27 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name used to identify the connection pool. + * @example backend-pool + */ + pool_name: components["parameters"]["pool_name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** @example { + * "mode": "transaction", + * "size": 10, + * "db": "defaultdb", + * "user": "doadmin" + * } */ + "application/json": components["schemas"]["connection_pool_update"]; + }; + }; responses: { - 200: components["responses"]["database_backups"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20397,7 +23281,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_replicas: { + databases_delete_connectionPool: { parameters: { query?: never; header?: never; @@ -20407,12 +23291,17 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name used to identify the connection pool. + * @example backend-pool + */ + pool_name: components["parameters"]["pool_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["database_replicas"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20420,7 +23309,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_create_replica: { + databases_get_evictionPolicy: { parameters: { query?: never; header?: never; @@ -20433,19 +23322,9 @@ export interface operations { }; cookie?: never; }; - requestBody?: { - content: { - /** @example { - * "name": "read-nyc3-01", - * "region": "nyc3", - * "size": "db-s-2vcpu-4gb", - * "storage_size_mib": 61440 - * } */ - "application/json": WithRequired; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["database_replica"]; + 200: components["responses"]["eviction_policy_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20453,7 +23332,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_events_logs: { + databases_update_evictionPolicy: { parameters: { query?: never; header?: never; @@ -20466,9 +23345,18 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** @example { + * "eviction_policy": "allkeys_lru" + * } */ + "application/json": { + eviction_policy: components["schemas"]["eviction_policy_model"]; + }; + }; + }; responses: { - 200: components["responses"]["events_logs"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20476,7 +23364,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_replica: { + databases_get_sql_mode: { parameters: { query?: never; header?: never; @@ -20486,17 +23374,12 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name of the database replica. - * @example read-nyc3-01 - */ - replica_name: components["parameters"]["replica_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["database_replica"]; + 200: components["responses"]["sql_mode"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20504,7 +23387,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_destroy_replica: { + databases_update_sql_mode: { parameters: { query?: never; header?: never; @@ -20514,15 +23397,17 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name of the database replica. - * @example read-nyc3-01 - */ - replica_name: components["parameters"]["replica_name"]; }; - cookie?: never; + cookie?: never; + }; + requestBody: { + content: { + /** @example { + * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE" + * } */ + "application/json": components["schemas"]["sql_mode"]; + }; }; - requestBody?: never; responses: { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; @@ -20532,7 +23417,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_promote_replica: { + databases_update_major_version: { parameters: { query?: never; header?: never; @@ -20542,15 +23427,17 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name of the database replica. - * @example read-nyc3-01 - */ - replica_name: components["parameters"]["replica_name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** @example { + * "version": "14" + * } */ + "application/json": components["schemas"]["version-2"]; + }; + }; responses: { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; @@ -20560,7 +23447,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_users: { + databases_list_kafka_topics: { parameters: { query?: never; header?: never; @@ -20575,7 +23462,7 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["users"]; + 200: components["responses"]["kafka_topics"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20583,7 +23470,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_add_user: { + databases_create_kafka_topic: { parameters: { query?: never; header?: never; @@ -20596,21 +23483,22 @@ export interface operations { }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["database_user"] & { - /** - * @description For MongoDB clusters, set to `true` to create a read-only user. - * This option is not currently supported for other database engines. - * - * @example true - */ - readonly?: boolean; - }; + /** @example { + * "name": "customer-events", + * "partitions": 3, + * "replication": 2, + * "config": { + * "retention_bytes": -1, + * "retention_ms": 100000 + * } + * } */ + "application/json": components["schemas"]["kafka_topic_create"]; }; }; responses: { - 201: components["responses"]["user"]; + 201: components["responses"]["kafka_topic"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20618,7 +23506,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_user: { + databases_get_kafka_topic: { parameters: { query?: never; header?: never; @@ -20629,16 +23517,16 @@ export interface operations { */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; /** - * @description The name of the database user. - * @example app-01 + * @description The name used to identify the Kafka topic. + * @example customer-events */ - username: components["parameters"]["username"]; + topic_name: components["parameters"]["kafka_topic_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["user"]; + 200: components["responses"]["kafka_topic"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20646,7 +23534,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_user: { + databases_update_kafka_topic: { parameters: { query?: never; header?: never; @@ -20657,22 +23545,28 @@ export interface operations { */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; /** - * @description The name of the database user. - * @example app-01 + * @description The name used to identify the Kafka topic. + * @example customer-events */ - username: components["parameters"]["username"]; + topic_name: components["parameters"]["kafka_topic_name"]; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": { - settings: components["schemas"]["user_settings"]; - }; + /** @example { + * "partitions": 3, + * "replication": 2, + * "config": { + * "retention_bytes": -1, + * "retention_ms": 100000 + * } + * } */ + "application/json": components["schemas"]["kafka_topic_update"]; }; }; responses: { - 201: components["responses"]["user"]; + 200: components["responses"]["kafka_topic"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20680,7 +23574,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete_user: { + databases_delete_kafka_topic: { parameters: { query?: never; header?: never; @@ -20691,10 +23585,10 @@ export interface operations { */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; /** - * @description The name of the database user. - * @example app-01 + * @description The name used to identify the Kafka topic. + * @example customer-events */ - username: components["parameters"]["username"]; + topic_name: components["parameters"]["kafka_topic_name"]; }; cookie?: never; }; @@ -20708,7 +23602,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_reset_auth: { + databases_list_logsink: { parameters: { query?: never; header?: never; @@ -20718,28 +23612,12 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name of the database user. - * @example app-01 - */ - username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody: { - content: { - /** @example { - * "mysql_settings": { - * "auth_plugin": "caching_sha2_password" - * } - * } */ - "application/json": { - mysql_settings?: components["schemas"]["mysql_settings"]; - }; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["user"]; + 201: components["responses"]["logsinks"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20747,7 +23625,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list: { + databases_create_logsink: { parameters: { query?: never; header?: never; @@ -20760,9 +23638,13 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["logsink_create"]; + }; + }; responses: { - 200: components["responses"]["databases"]; + 201: components["responses"]["logsink"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20770,7 +23652,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_add: { + databases_get_logsink: { parameters: { query?: never; header?: never; @@ -20780,19 +23662,17 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description A unique identifier for a logsink of a database cluster + * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + */ + logsink_id: components["parameters"]["logsink_id"]; }; cookie?: never; }; - requestBody: { - content: { - /** @example { - * "name": "alpha" - * } */ - "application/json": components["schemas"]["database"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["database"]; + 201: components["responses"]["logsink"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20800,7 +23680,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get: { + databases_update_logsink: { parameters: { query?: never; header?: never; @@ -20811,16 +23691,28 @@ export interface operations { */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; /** - * @description The name of the database. - * @example alpha + * @description A unique identifier for a logsink of a database cluster + * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 */ - database_name: components["parameters"]["database_name"]; + logsink_id: components["parameters"]["logsink_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** @example { + * "config": { + * "server": "192.168.0.1", + * "port": 514, + * "tls": false, + * "format": "rfc3164" + * } + * } */ + "application/json": components["schemas"]["logsink_update"]; + }; + }; responses: { - 200: components["responses"]["database"]; + 200: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20828,7 +23720,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete: { + databases_delete_logsink: { parameters: { query?: never; header?: never; @@ -20839,16 +23731,16 @@ export interface operations { */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; /** - * @description The name of the database. - * @example alpha + * @description A unique identifier for a logsink of a database cluster + * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 */ - database_name: components["parameters"]["database_name"]; + logsink_id: components["parameters"]["logsink_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20856,22 +23748,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_connectionPools: { + databases_get_cluster_metrics_credentials: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["connection_pools"]; + 200: components["responses"]["database_metrics_auth"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20879,41 +23765,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_add_connectionPool: { + databases_update_cluster_metrics_credentials: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - }; + path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { /** @example { - * "name": "backend-pool", - * "mode": "transaction", - * "size": 10, - * "db": "defaultdb", - * "user": "doadmin" + * "credentials": { + * "basic_auth_username": "new_username", + * "basic_auth_password": "new_password" + * } * } */ - "application/json": components["schemas"]["connection_pool"]; + "application/json": components["schemas"]["database_metrics_credentials"]; }; }; responses: { - 201: components["responses"]["connection_pool"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - databases_get_connectionPool: { + databases_list_opeasearch_indexes: { parameters: { query?: never; header?: never; @@ -20923,17 +23801,12 @@ export interface operations { * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name used to identify the connection pool. - * @example backend-pool - */ - pool_name: components["parameters"]["pool_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["connection_pool"]; + 200: components["responses"]["opensearch_indexes"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -20941,7 +23814,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_connectionPool: { + databases_delete_opensearch_index: { parameters: { query?: never; header?: never; @@ -20952,24 +23825,14 @@ export interface operations { */ database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; /** - * @description The name used to identify the connection pool. - * @example backend-pool + * @description The name of the OpenSearch index. + * @example logs-* */ - pool_name: components["parameters"]["pool_name"]; + index_name: components["parameters"]["opensearch_index_name"]; }; cookie?: never; }; - requestBody: { - content: { - /** @example { - * "mode": "transaction", - * "size": 10, - * "db": "defaultdb", - * "user": "doadmin" - * } */ - "application/json": components["schemas"]["connection_pool_update"]; - }; - }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; @@ -20979,82 +23842,72 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete_connectionPool: { + domains_list: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description Number of items returned per page + * @example 2 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + per_page?: components["parameters"]["per_page"]; /** - * @description The name used to identify the connection pool. - * @example backend-pool + * @description Which 'page' of paginated results to return. + * @example 1 */ - pool_name: components["parameters"]["pool_name"]; + page?: components["parameters"]["page"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["all_domains_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - databases_get_evictionPolicy: { + domains_create: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + /** @example { + * "name": "example.com" + * } */ + "application/json": components["schemas"]["domain"]; + }; + }; responses: { - 200: components["responses"]["eviction_policy_response"]; + 201: components["responses"]["create_domain_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - databases_update_evictionPolicy: { + domains_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The name of the domain itself. + * @example example.com */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + domain_name: components["parameters"]["domain_name"]; }; cookie?: never; }; - requestBody: { - content: { - /** @example { - * "eviction_policy": "allkeys_lru" - * } */ - "application/json": { - eviction_policy: components["schemas"]["eviction_policy_model"]; - }; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["existing_domain"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21062,22 +23915,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_sql_mode: { + domains_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The name of the domain itself. + * @example example.com */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + domain_name: components["parameters"]["domain_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["sql_mode"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21085,29 +23938,43 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_sql_mode: { + domains_list_records: { parameters: { - query?: never; + query?: { + /** + * @description A fully qualified record name. For example, to only include records matching sub.example.com, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. + * @example sub.example.com + */ + name?: components["parameters"]["domain_name_query"]; + /** + * @description The type of the DNS record. For example: A, CNAME, TXT, ... + * @example A + */ + type?: components["parameters"]["domain_type_query"]; + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The name of the domain itself. + * @example example.com */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + domain_name: components["parameters"]["domain_name"]; }; cookie?: never; }; - requestBody: { - content: { - /** @example { - * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE" - * } */ - "application/json": components["schemas"]["sql_mode"]; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["all_domain_records_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21115,29 +23982,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_major_version: { + domains_create_record: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The name of the domain itself. + * @example example.com */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + domain_name: components["parameters"]["domain_name"]; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { /** @example { - * "version": "14" + * "type": "A", + * "name": "www", + * "data": "162.10.66.0", + * "priority": null, + * "port": null, + * "ttl": 1800, + * "weight": null, + * "flags": null, + * "tag": null * } */ - "application/json": components["schemas"]["version-2"]; + "application/json": components["schemas"]["domain_record_a"] | components["schemas"]["domain_record_aaaa"] | components["schemas"]["domain_record_caa"] | components["schemas"]["domain_record_cname"] | components["schemas"]["domain_record_mx"] | components["schemas"]["domain_record_ns"] | components["schemas"]["domain_record_soa"] | components["schemas"]["domain_record_srv"] | components["schemas"]["domain_record_txt"]; }; }; responses: { - 204: components["responses"]["no_content"]; + 201: components["responses"]["created_domain_record"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21145,22 +24020,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_kafka_topics: { + domains_get_record: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The name of the domain itself. + * @example example.com */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + domain_name: components["parameters"]["domain_name"]; + /** + * @description The unique identifier of the domain record. + * @example 3352896 + */ + domain_record_id: components["parameters"]["domain_record_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["kafka_topics"]; + 200: components["responses"]["domain_record"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21168,35 +24048,35 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_create_kafka_topic: { + domains_update_record: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The name of the domain itself. + * @example example.com */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + domain_name: components["parameters"]["domain_name"]; + /** + * @description The unique identifier of the domain record. + * @example 3352896 + */ + domain_record_id: components["parameters"]["domain_record_id"]; }; cookie?: never; }; requestBody?: { content: { /** @example { - * "name": "customer-events", - * "partitions": 3, - * "replication": 2, - * "config": { - * "retention_bytes": -1, - * "retention_ms": 100000 - * } + * "name": "blog", + * "type": "CNAME" * } */ - "application/json": components["schemas"]["kafka_topic_create"]; + "application/json": components["schemas"]["domain_record"]; }; }; responses: { - 201: components["responses"]["kafka_topic"]; + 200: components["responses"]["domain_record"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21204,27 +24084,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_kafka_topic: { + domains_delete_record: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The name of the domain itself. + * @example example.com */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + domain_name: components["parameters"]["domain_name"]; /** - * @description The name used to identify the Kafka topic. - * @example customer-events + * @description The unique identifier of the domain record. + * @example 3352896 */ - topic_name: components["parameters"]["kafka_topic_name"]; + domain_record_id: components["parameters"]["domain_record_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["kafka_topic"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21232,90 +24112,120 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_kafka_topic: { + domains_patch_record: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The name of the domain itself. + * @example example.com */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + domain_name: components["parameters"]["domain_name"]; /** - * @description The name used to identify the Kafka topic. - * @example customer-events + * @description The unique identifier of the domain record. + * @example 3352896 */ - topic_name: components["parameters"]["kafka_topic_name"]; + domain_record_id: components["parameters"]["domain_record_id"]; }; cookie?: never; }; requestBody?: { content: { /** @example { - * "partitions": 3, - * "replication": 2, - * "config": { - * "retention_bytes": -1, - * "retention_ms": 100000 - * } + * "name": "blog", + * "type": "A" * } */ - "application/json": components["schemas"]["kafka_topic_update"]; + "application/json": components["schemas"]["domain_record"]; + }; + }; + responses: { + 200: components["responses"]["domain_record"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + droplets_list: { + parameters: { + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + /** + * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`. + * @example env:prod + */ + tag_name?: components["parameters"]["droplet_tag_name"]; + /** + * @description Used to filter list response by Droplet name returning only exact matches. It is case-insensitive and can not be combined with `tag_name`. + * @example web-01 + */ + name?: components["parameters"]["droplet_name"]; + /** + * @description When `type` is set to `gpus`, only GPU Droplets will be returned. By default, only non-GPU Droplets are returned. Can not be combined with `tag_name`. + * @example droplets + */ + type?: components["parameters"]["droplet_type"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["kafka_topic"]; + 200: components["responses"]["all_droplets"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - databases_delete_kafka_topic: { + droplets_create: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name used to identify the Kafka topic. - * @example customer-events - */ - topic_name: components["parameters"]["kafka_topic_name"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["droplet_single_create"] | components["schemas"]["droplet_multi_create"]; + }; + }; responses: { - 204: components["responses"]["no_content"]; + 202: components["responses"]["droplet_create"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - databases_list_logsink: { + droplets_destroy_byTag: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description Specifies Droplets to be deleted by tag. + * @example env:test */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + tag_name: components["parameters"]["droplet_delete_tag_name"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 201: components["responses"]["logsinks"]; + 204: components["responses"]["no_content_with_content_type"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21323,26 +24233,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_create_logsink: { + droplets_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["logsink_create"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["logsink"]; + 200: components["responses"]["existing_droplet"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21350,27 +24256,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_logsink: { + droplets_destroy: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description A unique identifier for a logsink of a database cluster - * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - logsink_id: components["parameters"]["logsink_id"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 201: components["responses"]["logsink"]; + 204: components["responses"]["no_content_with_content_type"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21378,39 +24279,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_logsink: { + droplets_list_backups: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description Number of items returned per page + * @example 2 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + per_page?: components["parameters"]["per_page"]; /** - * @description A unique identifier for a logsink of a database cluster - * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + * @description Which 'page' of paginated results to return. + * @example 1 */ - logsink_id: components["parameters"]["logsink_id"]; + page?: components["parameters"]["page"]; }; - cookie?: never; - }; - requestBody: { - content: { - /** @example { - * "config": { - * "server": "192.168.0.1", - * "port": 514, - * "tls": false, - * "format": "rfc3164" - * } - * } */ - "application/json": components["schemas"]["logsink_update"]; + header?: never; + path: { + /** + * @description A unique identifier for a Droplet instance. + * @example 3164444 + */ + droplet_id: components["parameters"]["droplet_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["no_content"]; + 200: components["responses"]["all_droplet_backups"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21418,27 +24313,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete_logsink: { + droplets_get_backup_policy: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description A unique identifier for a logsink of a database cluster - * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - logsink_id: components["parameters"]["logsink_id"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["no_content"]; + 200: components["responses"]["droplet_backup_policy"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21446,16 +24336,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_cluster_metrics_credentials: { + droplets_list_backup_policies: { parameters: { - query?: never; + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["database_metrics_auth"]; + 200: components["responses"]["all_droplet_backup_policies"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21463,48 +24364,50 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_cluster_metrics_credentials: { + droplets_list_supported_backup_policies: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: { - content: { - /** @example { - * "credentials": { - * "basic_auth_username": "new_username", - * "basic_auth_password": "new_password" - * } - * } */ - "application/json": components["schemas"]["database_metrics_credentials"]; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["droplets_supported_backup_policies"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - databases_list_opeasearch_indexes: { + droplets_list_snapshots: { parameters: { - query?: never; + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["opensearch_indexes"]; + 200: components["responses"]["all_droplet_snapshots"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21512,27 +24415,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete_opensearch_index: { + dropletActions_list: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description Number of items returned per page + * @example 2 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + per_page?: components["parameters"]["per_page"]; /** - * @description The name of the OpenSearch index. - * @example logs-* + * @description Which 'page' of paginated results to return. + * @example 1 */ - index_name: components["parameters"]["opensearch_index_name"]; + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** + * @description A unique identifier for a Droplet instance. + * @example 3164444 + */ + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["all_droplet_actions"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21540,72 +24449,88 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - domains_list: { + dropletActions_post: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; + query?: never; + header?: never; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - page?: components["parameters"]["page"]; + droplet_id: components["parameters"]["droplet_id"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + /** @description The `type` attribute set in the request body will specify the action that + * will be taken on the Droplet. Some actions will require additional + * attributes to be set as well. + * */ + requestBody?: { + content: { + "application/json": components["schemas"]["droplet_action"] | components["schemas"]["droplet_action_enable_backups"] | components["schemas"]["droplet_action_change_backup_policy"] | components["schemas"]["droplet_action_restore"] | components["schemas"]["droplet_action_resize"] | components["schemas"]["droplet_action_rebuild"] | components["schemas"]["droplet_action_rename"] | components["schemas"]["droplet_action_change_kernel"] | components["schemas"]["droplet_action_snapshot"]; + }; + }; responses: { - 200: components["responses"]["all_domains_response"]; + 201: components["responses"]["droplet_action"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - domains_create: { + dropletActions_post_byTag: { parameters: { - query?: never; + query?: { + /** + * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`. + * @example env:prod + */ + tag_name?: components["parameters"]["droplet_tag_name"]; + }; header?: never; path?: never; cookie?: never; }; + /** @description The `type` attribute set in the request body will specify the action that + * will be taken on the Droplet. Some actions will require additional + * attributes to be set as well. + * */ requestBody?: { content: { - /** @example { - * "name": "example.com" - * } */ - "application/json": components["schemas"]["domain"]; + "application/json": components["schemas"]["droplet_action"] | components["schemas"]["droplet_action_snapshot"]; }; }; responses: { - 201: components["responses"]["create_domain_response"]; + 201: components["responses"]["droplet_actions_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - domains_get: { + dropletActions_get: { parameters: { query?: never; header?: never; path: { /** - * @description The name of the domain itself. - * @example example.com + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - domain_name: components["parameters"]["domain_name"]; + droplet_id: components["parameters"]["droplet_id"]; + /** + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 + */ + action_id: components["parameters"]["action_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_domain"]; + 200: components["responses"]["action"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21613,22 +24538,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - domains_delete: { + droplets_list_kernels: { parameters: { - query?: never; + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; header?: never; path: { /** - * @description The name of the domain itself. - * @example example.com + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - domain_name: components["parameters"]["domain_name"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["all_kernels"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21636,19 +24572,9 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - domains_list_records: { + droplets_list_firewalls: { parameters: { query?: { - /** - * @description A fully qualified record name. For example, to only include records matching sub.example.com, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. - * @example sub.example.com - */ - name?: components["parameters"]["domain_name_query"]; - /** - * @description The type of the DNS record. For example: A, CNAME, TXT, ... - * @example A - */ - type?: components["parameters"]["domain_type_query"]; /** * @description Number of items returned per page * @example 2 @@ -21663,16 +24589,16 @@ export interface operations { header?: never; path: { /** - * @description The name of the domain itself. - * @example example.com + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - domain_name: components["parameters"]["domain_name"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_domain_records_response"]; + 200: components["responses"]["all_firewalls"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21680,37 +24606,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - domains_create_record: { + droplets_list_neighbors: { parameters: { query?: never; header?: never; path: { /** - * @description The name of the domain itself. - * @example example.com + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - domain_name: components["parameters"]["domain_name"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; - requestBody?: { - content: { - /** @example { - * "type": "A", - * "name": "www", - * "data": "162.10.66.0", - * "priority": null, - * "port": null, - * "ttl": 1800, - * "weight": null, - * "flags": null, - * "tag": null - * } */ - "application/json": components["schemas"]["domain_record_a"] | components["schemas"]["domain_record_aaaa"] | components["schemas"]["domain_record_caa"] | components["schemas"]["domain_record_cname"] | components["schemas"]["domain_record_mx"] | components["schemas"]["domain_record_ns"] | components["schemas"]["domain_record_soa"] | components["schemas"]["domain_record_srv"] | components["schemas"]["domain_record_txt"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["created_domain_record"]; + 200: components["responses"]["neighbor_droplets"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21718,27 +24629,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - domains_get_record: { + droplets_list_associatedResources: { parameters: { query?: never; header?: never; path: { /** - * @description The name of the domain itself. - * @example example.com - */ - domain_name: components["parameters"]["domain_name"]; - /** - * @description The unique identifier of the domain record. - * @example 3352896 + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - domain_record_id: components["parameters"]["domain_record_id"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["domain_record"]; + 200: components["responses"]["associated_resources_list"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21746,35 +24652,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - domains_update_record: { + droplets_destroy_withAssociatedResourcesSelective: { parameters: { query?: never; header?: never; path: { /** - * @description The name of the domain itself. - * @example example.com - */ - domain_name: components["parameters"]["domain_name"]; - /** - * @description The unique identifier of the domain record. - * @example 3352896 + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - domain_record_id: components["parameters"]["domain_record_id"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: { content: { - /** @example { - * "name": "blog", - * "type": "CNAME" - * } */ - "application/json": components["schemas"]["domain_record"]; + "application/json": components["schemas"]["selective_destroy_associated_resource"]; }; }; responses: { - 200: components["responses"]["domain_record"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21782,27 +24679,28 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - domains_delete_record: { + droplets_destroy_withAssociatedResourcesDangerous: { parameters: { query?: never; - header?: never; - path: { + header: { /** - * @description The name of the domain itself. - * @example example.com + * @description Acknowledge this action will destroy the Droplet and all associated resources and _can not_ be reversed. + * @example true */ - domain_name: components["parameters"]["domain_name"]; + "X-Dangerous": components["parameters"]["x_dangerous"]; + }; + path: { /** - * @description The unique identifier of the domain record. - * @example 3352896 + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - domain_record_id: components["parameters"]["domain_record_id"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21810,43 +24708,54 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - domains_patch_record: { + droplets_get_DestroyAssociatedResourcesStatus: { parameters: { query?: never; header?: never; path: { /** - * @description The name of the domain itself. - * @example example.com - */ - domain_name: components["parameters"]["domain_name"]; - /** - * @description The unique identifier of the domain record. - * @example 3352896 + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - domain_record_id: components["parameters"]["domain_record_id"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; - requestBody?: { - content: { - /** @example { - * "name": "blog", - * "type": "A" - * } */ - "application/json": components["schemas"]["domain_record"]; + requestBody?: never; + responses: { + 200: components["responses"]["associated_resources_status"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + droplets_destroy_retryWithAssociatedResources: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a Droplet instance. + * @example 3164444 + */ + droplet_id: components["parameters"]["droplet_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["domain_record"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - droplets_list: { + autoscalepools_list: { parameters: { query?: { /** @@ -21860,70 +24769,110 @@ export interface operations { */ page?: components["parameters"]["page"]; /** - * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`. - * @example env:prod - */ - tag_name?: components["parameters"]["droplet_tag_name"]; - /** - * @description Used to filter list response by Droplet name returning only exact matches. It is case-insensitive and can not be combined with `tag_name`. - * @example web-01 + * @description The name of the autoscale pool + * @example my-autoscale-pool */ - name?: components["parameters"]["droplet_name"]; + name?: components["parameters"]["autoscale_pool_name"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["all_autoscale_pools"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + autoscalepools_create: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["autoscale_pool_create"]; + }; + }; + responses: { + 202: components["responses"]["autoscale_pool_create"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + autoscalepools_get: { + parameters: { + query?: never; + header?: never; + path: { /** - * @description When `type` is set to `gpus`, only GPU Droplets will be returned. By default, only non-GPU Droplets are returned. Can not be combined with `tag_name`. - * @example droplets + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - type?: components["parameters"]["droplet_type"]; + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_droplets"]; + 200: components["responses"]["existing_autoscale_pool"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - droplets_create: { + autoscalepools_update: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + }; cookie?: never; }; requestBody?: { content: { - "application/json": components["schemas"]["droplet_single_create"] | components["schemas"]["droplet_multi_create"]; + "application/json": components["schemas"]["autoscale_pool_create"]; }; }; responses: { - 202: components["responses"]["droplet_create"]; + 200: components["responses"]["autoscale_pool_create"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - droplets_destroy_byTag: { + autoscalepools_delete: { parameters: { - query: { + query?: never; + header?: never; + path: { /** - * @description Specifies Droplets to be deleted by tag. - * @example env:test + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - tag_name: components["parameters"]["droplet_delete_tag_name"]; + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content_with_content_type"]; + 202: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21931,22 +24880,62 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_get: { + autoscalepools_delete_dangerous: { parameters: { query?: never; + header: { + /** + * @description Acknowledge this action will destroy the autoscale pool and its associated resources and _can not_ be reversed. + * @example true + */ + "X-Dangerous": components["parameters"]["parameters_x_dangerous"]; + }; + path: { + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + autoscalepools_list_members: { + parameters: { + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - droplet_id: components["parameters"]["droplet_id"]; + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_droplet"]; + 200: components["responses"]["all_members"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21954,22 +24943,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_destroy: { + autoscalepools_list_history: { parameters: { - query?: never; + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - droplet_id: components["parameters"]["droplet_id"]; + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content_with_content_type"]; + 200: components["responses"]["history_events"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -21977,7 +24977,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_list_backups: { + firewalls_list: { parameters: { query?: { /** @@ -21992,18 +24992,96 @@ export interface operations { page?: components["parameters"]["page"]; }; header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["list_firewalls_response"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + firewalls_create: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + /** @example { + * "name": "firewall", + * "inbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "80", + * "sources": { + * "load_balancer_uids": [ + * "4de7ac8b-495b-4884-9a69-1050c6793cd6" + * ] + * } + * }, + * { + * "protocol": "tcp", + * "ports": "22", + * "sources": { + * "tags": [ + * "gateway" + * ], + * "addresses": [ + * "18.0.0.0/8" + * ] + * } + * } + * ], + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "80", + * "destinations": { + * "addresses": [ + * "0.0.0.0/0", + * "::/0" + * ] + * } + * } + * ], + * "droplet_ids": [ + * 8043964 + * ] + * } */ + "application/json": components["schemas"]["firewall"] & unknown & (unknown | unknown); + }; + }; + responses: { + 202: components["responses"]["create_firewall_response"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + firewalls_get: { + parameters: { + query?: never; + header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - droplet_id: components["parameters"]["droplet_id"]; + firewall_id: components["parameters"]["firewall_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_droplet_backups"]; + 200: components["responses"]["get_firewall_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22011,22 +25089,71 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_get_backup_policy: { + firewalls_update: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - droplet_id: components["parameters"]["droplet_id"]; + firewall_id: components["parameters"]["firewall_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + /** @example { + * "name": "frontend-firewall", + * "inbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "8080", + * "sources": { + * "load_balancer_uids": [ + * "4de7ac8b-495b-4884-9a69-1050c6793cd6" + * ] + * } + * }, + * { + * "protocol": "tcp", + * "ports": "22", + * "sources": { + * "tags": [ + * "gateway" + * ], + * "addresses": [ + * "18.0.0.0/8" + * ] + * } + * } + * ], + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "8080", + * "destinations": { + * "addresses": [ + * "0.0.0.0/0", + * "::/0" + * ] + * } + * } + * ], + * "droplet_ids": [ + * 8043964 + * ], + * "tags": [ + * "frontend" + * ] + * } */ + "application/json": components["schemas"]["firewall"] & (unknown | unknown); + }; + }; responses: { - 200: components["responses"]["droplet_backup_policy"]; + 200: components["responses"]["put_firewall_response"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22034,27 +25161,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_list_backup_policies: { + firewalls_delete: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; + query?: never; + header?: never; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - page?: components["parameters"]["page"]; + firewall_id: components["parameters"]["firewall_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_droplet_backup_policies"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22062,16 +25184,40 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_list_supported_backup_policies: { + firewalls_assign_droplets: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c + */ + firewall_id: components["parameters"]["firewall_id"]; + }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + /** @example { + * "droplet_ids": [ + * 49696269 + * ] + * } */ + "application/json": { + /** + * @description An array containing the IDs of the Droplets to be assigned to the firewall. + * @example [ + * 49696269 + * ] + */ + droplet_ids: number[]; + }; + }; + }; responses: { - 200: components["responses"]["droplets_supported_backup_policies"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22079,33 +25225,40 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_list_snapshots: { + firewalls_delete_droplets: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - droplet_id: components["parameters"]["droplet_id"]; + firewall_id: components["parameters"]["firewall_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + /** @example { + * "droplet_ids": [ + * 49696269 + * ] + * } */ + "application/json": { + /** + * @description An array containing the IDs of the Droplets to be removed from the firewall. + * @example [ + * 49696269 + * ] + */ + droplet_ids: number[]; + }; + }; + }; responses: { - 200: components["responses"]["all_droplet_snapshots"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22113,33 +25266,34 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - dropletActions_list: { + firewalls_add_tags: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - droplet_id: components["parameters"]["droplet_id"]; + firewall_id: components["parameters"]["firewall_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + /** @example { + * "tags": [ + * "frontend" + * ] + * } */ + "application/json": { + tags: components["schemas"]["existing_tags_array"] & unknown; + }; + }; + }; responses: { - 200: components["responses"]["all_droplet_actions"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22147,30 +25301,34 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - dropletActions_post: { + firewalls_delete_tags: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - droplet_id: components["parameters"]["droplet_id"]; + firewall_id: components["parameters"]["firewall_id"]; }; cookie?: never; }; - /** @description The `type` attribute set in the request body will specify the action that - * will be taken on the Droplet. Some actions will require additional - * attributes to be set as well. - * */ requestBody?: { content: { - "application/json": components["schemas"]["droplet_action"] | components["schemas"]["droplet_action_enable_backups"] | components["schemas"]["droplet_action_change_backup_policy"] | components["schemas"]["droplet_action_restore"] | components["schemas"]["droplet_action_resize"] | components["schemas"]["droplet_action_rebuild"] | components["schemas"]["droplet_action_rename"] | components["schemas"]["droplet_action_change_kernel"] | components["schemas"]["droplet_action_snapshot"]; + /** @example { + * "tags": [ + * "frontend" + * ] + * } */ + "application/json": { + tags: components["schemas"]["existing_tags_array"] & unknown; + }; }; }; responses: { - 201: components["responses"]["droplet_action"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22178,57 +25336,103 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - dropletActions_post_byTag: { + firewalls_add_rules: { parameters: { - query?: { + query?: never; + header?: never; + path: { /** - * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`. - * @example env:prod + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - tag_name?: components["parameters"]["droplet_tag_name"]; + firewall_id: components["parameters"]["firewall_id"]; }; - header?: never; - path?: never; cookie?: never; }; - /** @description The `type` attribute set in the request body will specify the action that - * will be taken on the Droplet. Some actions will require additional - * attributes to be set as well. - * */ requestBody?: { content: { - "application/json": components["schemas"]["droplet_action"] | components["schemas"]["droplet_action_snapshot"]; + /** @example { + * "inbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "3306", + * "sources": { + * "droplet_ids": [ + * 49696269 + * ] + * } + * } + * ], + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "3306", + * "destinations": { + * "droplet_ids": [ + * 49696269 + * ] + * } + * } + * ] + * } */ + "application/json": components["schemas"]["firewall_rules"] & (unknown | unknown); }; }; responses: { - 201: components["responses"]["droplet_actions_response"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - dropletActions_get: { + firewalls_delete_rules: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 - */ - droplet_id: components["parameters"]["droplet_id"]; - /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - action_id: components["parameters"]["action_id"]; + firewall_id: components["parameters"]["firewall_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + /** @example { + * "inbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "3306", + * "sources": { + * "droplet_ids": [ + * 49696269 + * ] + * } + * } + * ], + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "3306", + * "destinations": { + * "droplet_ids": [ + * 49696269 + * ] + * } + * } + * ] + * } */ + "application/json": components["schemas"]["firewall_rules"] & (unknown | unknown); + }; + }; responses: { - 200: components["responses"]["action"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22236,7 +25440,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_list_kernels: { + floatingIPs_list: { parameters: { query?: { /** @@ -22251,52 +25455,54 @@ export interface operations { page?: components["parameters"]["page"]; }; header?: never; - path: { - /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 - */ - droplet_id: components["parameters"]["droplet_id"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_kernels"]; + 200: components["responses"]["floating_ip_list"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - droplets_list_firewalls: { + floatingIPs_create: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["floating_ip_create"]; }; + }; + responses: { + 202: components["responses"]["floating_ip_created"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + floatingIPs_get: { + parameters: { + query?: never; header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A floating IP address. + * @example 45.55.96.47 */ - droplet_id: components["parameters"]["droplet_id"]; + floating_ip: components["parameters"]["floating_ip"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_firewalls"]; + 200: components["responses"]["floating_ip"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22304,22 +25510,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_list_neighbors: { + floatingIPs_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A floating IP address. + * @example 45.55.96.47 */ - droplet_id: components["parameters"]["droplet_id"]; + floating_ip: components["parameters"]["floating_ip"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["neighbor_droplets"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22327,22 +25533,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_list_associatedResources: { + floatingIPsAction_list: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A floating IP address. + * @example 45.55.96.47 */ - droplet_id: components["parameters"]["droplet_id"]; + floating_ip: components["parameters"]["floating_ip"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["associated_resources_list"]; + 200: components["responses"]["floating_ip_actions"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22350,26 +25556,29 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_destroy_withAssociatedResourcesSelective: { + floatingIPsAction_post: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A floating IP address. + * @example 45.55.96.47 */ - droplet_id: components["parameters"]["droplet_id"]; + floating_ip: components["parameters"]["floating_ip"]; }; cookie?: never; }; + /** @description The `type` attribute set in the request body will specify the action that + * will be taken on the floating IP. + * */ requestBody?: { content: { - "application/json": components["schemas"]["selective_destroy_associated_resource"]; + "application/json": components["schemas"]["floating_ip_action_unassign"] | components["schemas"]["floating_ip_action_assign"]; }; }; responses: { - 202: components["responses"]["accepted"]; + 201: components["responses"]["floating_ip_action"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22377,28 +25586,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_destroy_withAssociatedResourcesDangerous: { + floatingIPsAction_get: { parameters: { query?: never; - header: { + header?: never; + path: { /** - * @description Acknowledge this action will destroy the Droplet and all associated resources and _can not_ be reversed. - * @example true + * @description A floating IP address. + * @example 45.55.96.47 */ - "X-Dangerous": components["parameters"]["x_dangerous"]; - }; - path: { + floating_ip: components["parameters"]["floating_ip"]; /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 */ - droplet_id: components["parameters"]["droplet_id"]; + action_id: components["parameters"]["action_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["floating_ip_action"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22406,210 +25614,250 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - droplets_get_DestroyAssociatedResourcesStatus: { + functions_list_namespaces: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 - */ - droplet_id: components["parameters"]["droplet_id"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["associated_resources_status"]; + 200: components["responses"]["list_namespaces"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - droplets_destroy_retryWithAssociatedResources: { + functions_create_namespace: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["create_namespace"]; + }; + }; + responses: { + 200: components["responses"]["namespace_created"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["namespace_bad_request"]; + 422: components["responses"]["namespace_limit_reached"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + functions_get_namespace: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - droplet_id: components["parameters"]["droplet_id"]; + namespace_id: components["parameters"]["namespace_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["namespace_created"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + 403: components["responses"]["namespace_not_allowed"]; + 404: components["responses"]["namespace_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - autoscalepools_list: { + functions_delete_namespace: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; + query?: never; + header?: never; + path: { /** - * @description The name of the autoscale pool - * @example my-autoscale-pool + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - name?: components["parameters"]["autoscale_pool_name"]; + namespace_id: components["parameters"]["namespace_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_autoscale_pools"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["namespace_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - autoscalepools_create: { + functions_list_triggers: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["autoscale_pool_create"]; + path: { + /** + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + */ + namespace_id: components["parameters"]["namespace_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 202: components["responses"]["autoscale_pool_create"]; + 200: components["responses"]["list_triggers"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["namespace_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - autoscalepools_get: { + functions_create_trigger: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + namespace_id: components["parameters"]["namespace_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["create_trigger"]; + }; + }; responses: { - 200: components["responses"]["existing_autoscale_pool"]; + 200: components["responses"]["trigger_response"]; + 400: components["responses"]["trigger_bad_request"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 404: components["responses"]["namespace_not_found"]; + 422: components["responses"]["trigger_limit_reached"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - autoscalepools_update: { + functions_get_trigger: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + namespace_id: components["parameters"]["namespace_id"]; + /** + * @description The name of the trigger to be managed. + * @example my trigger + */ + trigger_name: components["parameters"]["trigger_name"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["autoscale_pool_create"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["autoscale_pool_create"]; + 200: components["responses"]["trigger_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 404: components["responses"]["trigger_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - autoscalepools_delete: { + functions_update_trigger: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + */ + namespace_id: components["parameters"]["namespace_id"]; + /** + * @description The name of the trigger to be managed. + * @example my trigger */ - autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + trigger_name: components["parameters"]["trigger_name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["update_trigger"]; + }; + }; responses: { - 202: components["responses"]["no_content"]; + 200: components["responses"]["trigger_response"]; + 400: components["responses"]["trigger_bad_request"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 404: components["responses"]["trigger_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - autoscalepools_delete_dangerous: { + functions_delete_trigger: { parameters: { query?: never; - header: { + header?: never; + path: { /** - * @description Acknowledge this action will destroy the autoscale pool and its associated resources and _can not_ be reversed. - * @example true + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - "X-Dangerous": components["parameters"]["parameters_x_dangerous"]; - }; - path: { + namespace_id: components["parameters"]["namespace_id"]; /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + * @description The name of the trigger to be managed. + * @example my trigger */ - autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + trigger_name: components["parameters"]["trigger_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["no_content"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 404: components["responses"]["trigger_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - autoscalepools_list_members: { + images_list: { parameters: { query?: { + /** + * @description Filters results based on image type which can be either `application` or `distribution`. + * @example distribution + */ + type?: components["parameters"]["type"]; + /** + * @description Used to filter only user images. + * @example true + */ + private?: components["parameters"]["private"]; + /** + * @description Used to filter images by a specific tag. + * @example base-image + */ + tag_name?: components["parameters"]["tag"]; /** * @description Number of items returned per page * @example 2 @@ -22622,164 +25870,107 @@ export interface operations { page?: components["parameters"]["page"]; }; header?: never; - path: { - /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac - */ - autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_members"]; + 200: components["responses"]["all_images"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - autoscalepools_list_history: { + images_create_custom: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; - path: { - /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac - */ - autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["image_new_custom"]; + }; + }; responses: { - 200: components["responses"]["history_events"]; + 202: components["responses"]["new_custom_image"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - firewalls_list: { + images_get: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; - path?: never; + path: { + /** @description A unique number (id) or string (slug) used to identify and reference a + * specific image. + * + * **Public** images can be identified by image `id` or `slug`. + * + * **Private** images *must* be identified by image `id`. + * */ + image_id: number | string; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_firewalls_response"]; + 200: components["responses"]["existing_image"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - firewalls_create: { + images_update: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique number that can be used to identify and reference a specific image. + * @example 62137902 + */ + image_id: components["parameters"]["image_id"]; + }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - /** @example { - * "name": "firewall", - * "inbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "80", - * "sources": { - * "load_balancer_uids": [ - * "4de7ac8b-495b-4884-9a69-1050c6793cd6" - * ] - * } - * }, - * { - * "protocol": "tcp", - * "ports": "22", - * "sources": { - * "tags": [ - * "gateway" - * ], - * "addresses": [ - * "18.0.0.0/8" - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "80", - * "destinations": { - * "addresses": [ - * "0.0.0.0/0", - * "::/0" - * ] - * } - * } - * ], - * "droplet_ids": [ - * 8043964 - * ] - * } */ - "application/json": components["schemas"]["firewall"] & unknown & (unknown | unknown); + "application/json": components["schemas"]["image_update"]; }; }; responses: { - 202: components["responses"]["create_firewall_response"]; - 400: components["responses"]["bad_request"]; + 200: components["responses"]["updated_image"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - firewalls_get: { + images_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description A unique number that can be used to identify and reference a specific image. + * @example 62137902 */ - firewall_id: components["parameters"]["firewall_id"]; + image_id: components["parameters"]["image_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_firewall_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22787,71 +25978,49 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_update: { + imageActions_list: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description A unique number that can be used to identify and reference a specific image. + * @example 62137902 */ - firewall_id: components["parameters"]["firewall_id"]; + image_id: components["parameters"]["image_id"]; }; cookie?: never; }; - requestBody?: { - content: { - /** @example { - * "name": "frontend-firewall", - * "inbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "8080", - * "sources": { - * "load_balancer_uids": [ - * "4de7ac8b-495b-4884-9a69-1050c6793cd6" - * ] - * } - * }, - * { - * "protocol": "tcp", - * "ports": "22", - * "sources": { - * "tags": [ - * "gateway" - * ], - * "addresses": [ - * "18.0.0.0/8" - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "8080", - * "destinations": { - * "addresses": [ - * "0.0.0.0/0", - * "::/0" - * ] - * } - * } - * ], - * "droplet_ids": [ - * 8043964 - * ], - * "tags": [ - * "frontend" - * ] - * } */ - "application/json": components["schemas"]["firewall"] & (unknown | unknown); + requestBody?: never; + responses: { + 200: components["responses"]["get_image_actions_response"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + imageActions_post: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique number that can be used to identify and reference a specific image. + * @example 62137902 + */ + image_id: components["parameters"]["image_id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["image_action_base"] | components["schemas"]["image_action_transfer"]; }; }; responses: { - 200: components["responses"]["put_firewall_response"]; - 400: components["responses"]["bad_request"]; + 201: components["responses"]["post_image_action_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22859,22 +26028,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_delete: { + imageActions_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description A unique number that can be used to identify and reference a specific image. + * @example 62137902 */ - firewall_id: components["parameters"]["firewall_id"]; + image_id: components["parameters"]["image_id"]; + /** + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 + */ + action_id: components["parameters"]["action_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["get_image_action_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22882,81 +26056,69 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_assign_droplets: { + kubernetes_list_clusters: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description Number of items returned per page + * @example 2 */ - firewall_id: components["parameters"]["firewall_id"]; + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody?: { + requestBody?: never; + responses: { + 200: components["responses"]["all_clusters"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + kubernetes_create_cluster: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { content: { - /** @example { - * "droplet_ids": [ - * 49696269 - * ] - * } */ - "application/json": { - /** - * @description An array containing the IDs of the Droplets to be assigned to the firewall. - * @example [ - * 49696269 - * ] - */ - droplet_ids: number[]; - }; + "application/json": components["schemas"]["cluster"]; }; }; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; + 201: components["responses"]["cluster_create"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - firewalls_delete_droplets: { + kubernetes_get_cluster: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - firewall_id: components["parameters"]["firewall_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody?: { - content: { - /** @example { - * "droplet_ids": [ - * 49696269 - * ] - * } */ - "application/json": { - /** - * @description An array containing the IDs of the Droplets to be removed from the firewall. - * @example [ - * 49696269 - * ] - */ - droplet_ids: number[]; - }; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; + 200: components["responses"]["existing_cluster"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22964,34 +26126,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_add_tags: { + kubernetes_update_cluster: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - firewall_id: components["parameters"]["firewall_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - /** @example { - * "tags": [ - * "frontend" - * ] - * } */ - "application/json": { - tags: components["schemas"]["existing_tags_array"] & unknown; - }; + "application/json": components["schemas"]["cluster_update"]; }; }; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; + 202: components["responses"]["updated_cluster"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22999,34 +26153,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_delete_tags: { + kubernetes_delete_cluster: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - firewall_id: components["parameters"]["firewall_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody?: { - content: { - /** @example { - * "tags": [ - * "frontend" - * ] - * } */ - "application/json": { - tags: components["schemas"]["existing_tags_array"] & unknown; - }; - }; - }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23034,51 +26176,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_add_rules: { + kubernetes_list_associatedResources: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - firewall_id: components["parameters"]["firewall_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody?: { - content: { - /** @example { - * "inbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "3306", - * "sources": { - * "droplet_ids": [ - * 49696269 - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "3306", - * "destinations": { - * "droplet_ids": [ - * 49696269 - * ] - * } - * } - * ] - * } */ - "application/json": components["schemas"]["firewall_rules"] & (unknown | unknown); - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; + 200: components["responses"]["associated_kubernetes_resources_list"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23086,51 +26199,49 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_delete_rules: { + kubernetes_destroy_associatedResourcesSelective: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - firewall_id: components["parameters"]["firewall_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - /** @example { - * "inbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "3306", - * "sources": { - * "droplet_ids": [ - * 49696269 - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "3306", - * "destinations": { - * "droplet_ids": [ - * 49696269 - * ] - * } - * } - * ] - * } */ - "application/json": components["schemas"]["firewall_rules"] & (unknown | unknown); + "application/json": components["schemas"]["destroy_associated_kubernetes_resources"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + kubernetes_destroy_associatedResourcesDangerous: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af + */ + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23138,69 +26249,80 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPs_list: { + kubernetes_get_kubeconfig: { parameters: { query?: { /** - * @description Number of items returned per page - * @example 2 + * @description The duration in seconds that the returned Kubernetes credentials will be valid. If not set or 0, the credentials will have a 7 day expiry. + * @example 300 */ - per_page?: components["parameters"]["per_page"]; + expiry_seconds?: components["parameters"]["kubernetes_expiry_seconds"]; + }; + header?: never; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - page?: components["parameters"]["page"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["floating_ip_list"]; + 200: components["responses"]["kubeconfig"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - floatingIPs_create: { + kubernetes_get_credentials: { parameters: { - query?: never; + query?: { + /** + * @description The duration in seconds that the returned Kubernetes credentials will be valid. If not set or 0, the credentials will have a 7 day expiry. + * @example 300 + */ + expiry_seconds?: components["parameters"]["kubernetes_expiry_seconds"]; + }; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["floating_ip_create"]; + path: { + /** + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af + */ + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 202: components["responses"]["floating_ip_created"]; + 200: components["responses"]["credentials"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - floatingIPs_get: { + kubernetes_get_availableUpgrades: { parameters: { query?: never; header?: never; path: { /** - * @description A floating IP address. - * @example 45.55.96.47 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - floating_ip: components["parameters"]["floating_ip"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["floating_ip"]; + 200: components["responses"]["available_upgrades"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23208,22 +26330,32 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPs_delete: { + kubernetes_upgrade_cluster: { parameters: { query?: never; header?: never; path: { /** - * @description A floating IP address. - * @example 45.55.96.47 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - floating_ip: components["parameters"]["floating_ip"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description The slug identifier for the version of Kubernetes that the cluster will be upgraded to. + * @example 1.16.13-do.0 + */ + version?: string; + }; + }; + }; responses: { - 204: components["responses"]["no_content"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23231,22 +26363,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPsAction_list: { + kubernetes_list_nodePools: { parameters: { query?: never; header?: never; path: { /** - * @description A floating IP address. - * @example 45.55.96.47 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - floating_ip: components["parameters"]["floating_ip"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["floating_ip_actions"]; + 200: components["responses"]["all_node_pools"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23254,29 +26386,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPsAction_post: { + kubernetes_add_nodePool: { parameters: { query?: never; header?: never; path: { /** - * @description A floating IP address. - * @example 45.55.96.47 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - floating_ip: components["parameters"]["floating_ip"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - /** @description The `type` attribute set in the request body will specify the action that - * will be taken on the floating IP. - * */ - requestBody?: { + requestBody: { content: { - "application/json": components["schemas"]["floating_ip_action_unassign"] | components["schemas"]["floating_ip_action_assign"]; + /** @example { + * "size": "s-1vcpu-2gb", + * "count": 3, + * "name": "new-pool", + * "tags": [ + * "frontend" + * ], + * "auto_scale": true, + * "min_nodes": 3, + * "max_nodes": 6 + * } */ + "application/json": components["schemas"]["kubernetes_node_pool"]; }; }; responses: { - 201: components["responses"]["floating_ip_action"]; + 201: components["responses"]["node_pool_create"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23284,27 +26424,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPsAction_get: { + kubernetes_get_nodePool: { parameters: { query?: never; header?: never; path: { /** - * @description A floating IP address. - * @example 45.55.96.47 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - floating_ip: components["parameters"]["floating_ip"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d */ - action_id: components["parameters"]["action_id"]; + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["floating_ip_action"]; + 200: components["responses"]["existing_node_pool"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23312,250 +26452,286 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - functions_list_namespaces: { + kubernetes_update_nodePool: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af + */ + cluster_id: components["parameters"]["kubernetes_cluster_id"]; + /** + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d + */ + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["kubernetes_node_pool_update"]; + }; + }; responses: { - 200: components["responses"]["list_namespaces"]; + 202: components["responses"]["node_pool_update"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_create_namespace: { + kubernetes_delete_nodePool: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af + */ + cluster_id: components["parameters"]["kubernetes_cluster_id"]; + /** + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d + */ + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; + }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["create_namespace"]; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + kubernetes_delete_node: { + parameters: { + query?: { + /** + * @description Specifies whether or not to drain workloads from a node before it is deleted. Setting it to `1` causes node draining to be skipped. Omitting the query parameter or setting its value to `0` carries out draining prior to deletion. + * @example 1 + */ + skip_drain?: components["parameters"]["kubernetes_node_skip_drain"]; + /** + * @description Specifies whether or not to replace a node after it has been deleted. Setting it to `1` causes the node to be replaced by a new one after deletion. Omitting the query parameter or setting its value to `0` deletes without replacement. + * @example 1 + */ + replace?: components["parameters"]["kubernetes_node_replace"]; + }; + header?: never; + path: { + /** + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af + */ + cluster_id: components["parameters"]["kubernetes_cluster_id"]; + /** + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d + */ + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; + /** + * @description A unique ID that can be used to reference a node in a Kubernetes node pool. + * @example 478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f + */ + node_id: components["parameters"]["kubernetes_node_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["namespace_created"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["namespace_bad_request"]; - 422: components["responses"]["namespace_limit_reached"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_get_namespace: { + kubernetes_recycle_node_pool: { parameters: { query?: never; header?: never; path: { /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - namespace_id: components["parameters"]["namespace_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; + /** + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d + */ + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @example [ + * "d8db5e1a-6103-43b5-a7b3-8a948210a9fc" + * ] */ + nodes?: string[]; + }; }; - cookie?: never; }; - requestBody?: never; responses: { - 200: components["responses"]["namespace_created"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; - 403: components["responses"]["namespace_not_allowed"]; - 404: components["responses"]["namespace_not_found"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_delete_namespace: { + kubernetes_get_clusterUser: { parameters: { query?: never; header?: never; path: { /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - namespace_id: components["parameters"]["namespace_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["cluster_user"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["namespace_not_found"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_list_triggers: { + kubernetes_list_options: { parameters: { query?: never; header?: never; - path: { - /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - */ - namespace_id: components["parameters"]["namespace_id"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_triggers"]; + 200: components["responses"]["all_options"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["namespace_not_found"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_create_trigger: { + kubernetes_get_clusterLintResults: { parameters: { - query?: never; + query?: { + /** + * @description Specifies the clusterlint run whose results will be retrieved. + * @example 50c2f44c-011d-493e-aee5-361a4a0d1844 + */ + run_id?: components["parameters"]["clusterlint_run_id"]; + }; header?: never; path: { /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - namespace_id: components["parameters"]["namespace_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["create_trigger"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["trigger_response"]; - 400: components["responses"]["trigger_bad_request"]; + 200: components["responses"]["clusterlint_results"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["namespace_not_found"]; - 422: components["responses"]["trigger_limit_reached"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_get_trigger: { + kubernetes_run_clusterLint: { parameters: { query?: never; header?: never; path: { /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - */ - namespace_id: components["parameters"]["namespace_id"]; - /** - * @description The name of the trigger to be managed. - * @example my trigger + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - trigger_name: components["parameters"]["trigger_name"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["clusterlint_request"]; + }; + }; responses: { - 200: components["responses"]["trigger_response"]; + 202: components["responses"]["clusterlint_run"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["trigger_not_found"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_update_trigger: { + kubernetes_add_registry: { parameters: { query?: never; header?: never; - path: { - /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - */ - namespace_id: components["parameters"]["namespace_id"]; - /** - * @description The name of the trigger to be managed. - * @example my trigger - */ - trigger_name: components["parameters"]["trigger_name"]; - }; + path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["update_trigger"]; + "application/json": components["schemas"]["cluster_registries"]; }; }; responses: { - 200: components["responses"]["trigger_response"]; - 400: components["responses"]["trigger_bad_request"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["trigger_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_delete_trigger: { + kubernetes_remove_registry: { parameters: { query?: never; header?: never; - path: { - /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - */ - namespace_id: components["parameters"]["namespace_id"]; - /** - * @description The name of the trigger to be managed. - * @example my trigger - */ - trigger_name: components["parameters"]["trigger_name"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["cluster_registries"]; + }; + }; responses: { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["trigger_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - images_list: { + loadBalancers_list: { parameters: { query?: { - /** - * @description Filters results based on image type which can be either `application` or `distribution`. - * @example distribution - */ - type?: components["parameters"]["type"]; - /** - * @description Used to filter only user images. - * @example true - */ - private?: components["parameters"]["private"]; - /** - * @description Used to filter images by a specific tag. - * @example base-image - */ - tag_name?: components["parameters"]["tag"]; /** * @description Number of items returned per page * @example 2 @@ -23573,14 +26749,14 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_images"]; + 200: components["responses"]["all_load_balancers"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - images_create_custom: { + loadBalancers_create: { parameters: { query?: never; header?: never; @@ -23589,36 +26765,33 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["image_new_custom"]; + "application/json": components["schemas"]["load_balancer_create"]; }; }; responses: { - 202: components["responses"]["new_custom_image"]; + 202: components["responses"]["load_balancer_create"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - images_get: { + loadBalancers_get: { parameters: { query?: never; header?: never; path: { - /** @description A unique number (id) or string (slug) used to identify and reference a - * specific image. - * - * **Public** images can be identified by image `id` or `slug`. - * - * **Private** images *must* be identified by image `id`. - * */ - image_id: number | string; + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_image"]; + 200: components["responses"]["existing_load_balancer"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23626,26 +26799,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - images_update: { + loadBalancers_update: { parameters: { query?: never; header?: never; path: { /** - * @description A unique number that can be used to identify and reference a specific image. - * @example 62137902 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - image_id: components["parameters"]["image_id"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["image_update"]; + "application/json": components["schemas"]["load_balancer_create"]; }; }; responses: { - 200: components["responses"]["updated_image"]; + 200: components["responses"]["updated_load_balancer"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23653,16 +26826,39 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - images_delete: { + loadBalancers_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique number that can be used to identify and reference a specific image. - * @example 62137902 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - image_id: components["parameters"]["image_id"]; + lb_id: components["parameters"]["load_balancer_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + loadBalancers_delete_cache: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; @@ -23676,22 +26872,71 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - imageActions_list: { + loadBalancers_add_droplets: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + lb_id: components["parameters"]["load_balancer_id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description An array containing the IDs of the Droplets assigned to the load balancer. + * @example [ + * 3164444, + * 3164445 + * ] + */ + droplet_ids: number[]; + }; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + loadBalancers_remove_droplets: { parameters: { query?: never; header?: never; path: { /** - * @description A unique number that can be used to identify and reference a specific image. - * @example 62137902 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - image_id: components["parameters"]["image_id"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description An array containing the IDs of the Droplets assigned to the load balancer. + * @example [ + * 3164444, + * 3164445 + * ] + */ + droplet_ids: number[]; + }; + }; + }; responses: { - 200: components["responses"]["get_image_actions_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23699,26 +26944,28 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - imageActions_post: { + loadBalancers_add_forwardingRules: { parameters: { query?: never; header?: never; path: { /** - * @description A unique number that can be used to identify and reference a specific image. - * @example 62137902 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - image_id: components["parameters"]["image_id"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": components["schemas"]["image_action_base"] | components["schemas"]["image_action_transfer"]; + "application/json": { + forwarding_rules: components["schemas"]["forwarding_rule"][]; + }; }; }; responses: { - 201: components["responses"]["post_image_action_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23726,27 +26973,28 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - imageActions_get: { + loadBalancers_remove_forwardingRules: { parameters: { query?: never; header?: never; path: { /** - * @description A unique number that can be used to identify and reference a specific image. - * @example 62137902 - */ - image_id: components["parameters"]["image_id"]; - /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - action_id: components["parameters"]["action_id"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + forwarding_rules: components["schemas"]["forwarding_rule"][]; + }; + }; + }; responses: { - 200: components["responses"]["get_image_action_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23754,7 +27002,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_list_clusters: { + monitoring_list_alertPolicy: { parameters: { query?: { /** @@ -23774,49 +27022,90 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_clusters"]; + 200: components["responses"]["list_alert_policy_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_create_cluster: { + monitoring_create_alertPolicy: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + /** @description The `type` field dictates what type of entity that the alert policy applies to and hence what type of entity is passed in the `entities` array. If both the `tags` array and `entities` array are empty the alert policy applies to all entities of the relevant type that are owned by the user account. Otherwise the following table shows the valid entity types for each type of alert policy: + * + * Type | Description | Valid Entity Type + * -----|-------------|-------------------- + * `v1/insights/droplet/memory_utilization_percent` | alert on the percent of memory utilization | Droplet ID + * `v1/insights/droplet/disk_read` | alert on the rate of disk read I/O in MBps | Droplet ID + * `v1/insights/droplet/load_5` | alert on the 5 minute load average | Droplet ID + * `v1/insights/droplet/load_15` | alert on the 15 minute load average | Droplet ID + * `v1/insights/droplet/disk_utilization_percent` | alert on the percent of disk utilization | Droplet ID + * `v1/insights/droplet/cpu` | alert on the percent of CPU utilization | Droplet ID + * `v1/insights/droplet/disk_write` | alert on the rate of disk write I/O in MBps | Droplet ID + * `v1/insights/droplet/public_outbound_bandwidth` | alert on the rate of public outbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/public_inbound_bandwidth` | alert on the rate of public inbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/private_outbound_bandwidth` | alert on the rate of private outbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/private_inbound_bandwidth` | alert on the rate of private inbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/load_1` | alert on the 1 minute load average | Droplet ID + * `v1/insights/lbaas/avg_cpu_utilization_percent`|alert on the percent of CPU utilization|load balancer ID + * `v1/insights/lbaas/connection_utilization_percent`|alert on the percent of connection utilization|load balancer ID + * `v1/insights/lbaas/droplet_health`|alert on Droplet health status changes|load balancer ID + * `v1/insights/lbaas/tls_connections_per_second_utilization_percent`|alert on the percent of TLS connections per second utilization (requires at least one HTTPS forwarding rule)|load balancer ID + * `v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx`|alert on the percent increase of 5xx level http errors over 5m|load balancer ID + * `v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx`|alert on the percent increase of 4xx level http errors over 5m|load balancer ID + * `v1/insights/lbaas/increase_in_http_error_rate_count_5xx`|alert on the count of 5xx level http errors over 5m|load balancer ID + * `v1/insights/lbaas/increase_in_http_error_rate_count_4xx`|alert on the count of 4xx level http errors over 5m|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time`|alert on high average http response time|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time_50p`|alert on high 50th percentile http response time|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time_95p`|alert on high 95th percentile http response time|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time_99p`|alert on high 99th percentile http response time|load balancer ID + * `v1/dbaas/alerts/load_15_alerts` | alert on 15 minute load average across the database cluster | database cluster UUID + * `v1/dbaas/alerts/memory_utilization_alerts` | alert on the percent memory utilization average across the database cluster | database cluster UUID + * `v1/dbaas/alerts/disk_utilization_alerts` | alert on the percent disk utilization average across the database cluster | database cluster UUID + * `v1/dbaas/alerts/cpu_alerts` | alert on the percent CPU usage average across the database cluster | database cluster UUID + * `v1/droplet/autoscale_alerts/current_instances` | alert on current pool size | autoscale pool ID + * `v1/droplet/autoscale_alerts/target_instances` | alert on target pool size | autoscale pool ID + * `v1/droplet/autoscale_alerts/current_cpu_utilization` | alert on current average CPU utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/target_cpu_utilization` | alert on target average CPU utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/current_memory_utilization` | alert on current average memory utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/target_memory_utilization` | alert on target average memory utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/scale_up` | alert on scale up event | autoscale pool ID + * `v1/droplet/autoscale_alerts/scale_down` | alert on scale down event | autoscale pool ID + * */ requestBody: { content: { - "application/json": components["schemas"]["cluster"]; + "application/json": components["schemas"]["alert_policy_request"]; }; }; responses: { - 201: components["responses"]["cluster_create"]; + 200: components["responses"]["alert_policy_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_cluster: { + monitoring_get_alertPolicy: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for an alert policy. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + alert_uuid: components["parameters"]["alert_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_cluster"]; + 200: components["responses"]["alert_policy_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23824,26 +27113,67 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_update_cluster: { + monitoring_update_alertPolicy: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for an alert policy. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + alert_uuid: components["parameters"]["alert_uuid"]; }; cookie?: never; }; + /** @description The `type` field dictates what type of entity that the alert policy applies to and hence what type of entity is passed in the `entities` array. If both the `tags` array and `entities` array are empty the alert policy applies to all entities of the relevant type that are owned by the user account. Otherwise the following table shows the valid entity types for each type of alert policy: + * + * Type | Description | Valid Entity Type + * -----|-------------|-------------------- + * `v1/insights/droplet/memory_utilization_percent` | alert on the percent of memory utilization | Droplet ID + * `v1/insights/droplet/disk_read` | alert on the rate of disk read I/O in MBps | Droplet ID + * `v1/insights/droplet/load_5` | alert on the 5 minute load average | Droplet ID + * `v1/insights/droplet/load_15` | alert on the 15 minute load average | Droplet ID + * `v1/insights/droplet/disk_utilization_percent` | alert on the percent of disk utilization | Droplet ID + * `v1/insights/droplet/cpu` | alert on the percent of CPU utilization | Droplet ID + * `v1/insights/droplet/disk_write` | alert on the rate of disk write I/O in MBps | Droplet ID + * `v1/insights/droplet/public_outbound_bandwidth` | alert on the rate of public outbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/public_inbound_bandwidth` | alert on the rate of public inbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/private_outbound_bandwidth` | alert on the rate of private outbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/private_inbound_bandwidth` | alert on the rate of private inbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/load_1` | alert on the 1 minute load average | Droplet ID + * `v1/insights/lbaas/avg_cpu_utilization_percent`|alert on the percent of CPU utilization|load balancer ID + * `v1/insights/lbaas/connection_utilization_percent`|alert on the percent of connection utilization|load balancer ID + * `v1/insights/lbaas/droplet_health`|alert on Droplet health status changes|load balancer ID + * `v1/insights/lbaas/tls_connections_per_second_utilization_percent`|alert on the percent of TLS connections per second utilization (requires at least one HTTPS forwarding rule)|load balancer ID + * `v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx`|alert on the percent increase of 5xx level http errors over 5m|load balancer ID + * `v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx`|alert on the percent increase of 4xx level http errors over 5m|load balancer ID + * `v1/insights/lbaas/increase_in_http_error_rate_count_5xx`|alert on the count of 5xx level http errors over 5m|load balancer ID + * `v1/insights/lbaas/increase_in_http_error_rate_count_4xx`|alert on the count of 4xx level http errors over 5m|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time`|alert on high average http response time|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time_50p`|alert on high 50th percentile http response time|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time_95p`|alert on high 95th percentile http response time|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time_99p`|alert on high 99th percentile http response time|load balancer ID + * `v1/dbaas/alerts/load_15_alerts` | alert on 15 minute load average across the database cluster | database cluster UUID + * `v1/dbaas/alerts/memory_utilization_alerts` | alert on the percent memory utilization average across the database cluster | database cluster UUID + * `v1/dbaas/alerts/disk_utilization_alerts` | alert on the percent disk utilization average across the database cluster | database cluster UUID + * `v1/dbaas/alerts/cpu_alerts` | alert on the percent CPU usage average across the database cluster | database cluster UUID + * `v1/droplet/autoscale_alerts/current_instances` | alert on current pool size | autoscale pool ID + * `v1/droplet/autoscale_alerts/target_instances` | alert on target pool size | autoscale pool ID + * `v1/droplet/autoscale_alerts/current_cpu_utilization` | alert on current average CPU utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/target_cpu_utilization` | alert on target average CPU utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/current_memory_utilization` | alert on current average memory utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/target_memory_utilization` | alert on target average memory utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/scale_up` | alert on scale up event | autoscale pool ID + * `v1/droplet/autoscale_alerts/scale_down` | alert on scale down event | autoscale pool ID + * */ requestBody: { content: { - "application/json": components["schemas"]["cluster_update"]; + "application/json": components["schemas"]["alert_policy_request"]; }; }; responses: { - 202: components["responses"]["updated_cluster"]; + 200: components["responses"]["alert_policy_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23851,595 +27181,840 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_delete_cluster: { + monitoring_delete_alertPolicy: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for an alert policy. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + alert_uuid: components["parameters"]["alert_uuid"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_get_dropletBandwidthMetrics: { + parameters: { + query: { + /** + * @description The droplet ID. + * @example 17209102 + */ + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description The network interface. + * @example private + */ + interface: components["parameters"]["network_interface"]; + /** + * @description The traffic direction. + * @example inbound + */ + direction: components["parameters"]["network_direction"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["droplet_bandwidth_metric_response"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_get_DropletCpuMetrics: { + parameters: { + query: { + /** + * @description The droplet ID. + * @example 17209102 + */ + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["droplet_cpu_metric_response"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_get_dropletFilesystemFreeMetrics: { + parameters: { + query: { + /** + * @description The droplet ID. + * @example 17209102 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["droplet_filesystem_metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_list_associatedResources: { + monitoring_get_dropletFilesystemSizeMetrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description The droplet ID. + * @example 17209102 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["associated_kubernetes_resources_list"]; + 200: components["responses"]["droplet_filesystem_metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_destroy_associatedResourcesSelective: { + monitoring_get_dropletLoad1Metrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description The droplet ID. + * @example 17209102 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["destroy_associated_kubernetes_resources"]; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_destroy_associatedResourcesDangerous: { + monitoring_get_dropletLoad5Metrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description The droplet ID. + * @example 17209102 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_kubeconfig: { + monitoring_get_dropletLoad15Metrics: { parameters: { - query?: { + query: { /** - * @description The duration in seconds that the returned Kubernetes credentials will be valid. If not set or 0, the credentials will have a 7 day expiry. - * @example 300 + * @description The droplet ID. + * @example 17209102 */ - expiry_seconds?: components["parameters"]["kubernetes_expiry_seconds"]; - }; - header?: never; - path: { + host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["kubeconfig"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_credentials: { + monitoring_get_dropletMemoryCachedMetrics: { parameters: { - query?: { + query: { /** - * @description The duration in seconds that the returned Kubernetes credentials will be valid. If not set or 0, the credentials will have a 7 day expiry. - * @example 300 + * @description The droplet ID. + * @example 17209102 */ - expiry_seconds?: components["parameters"]["kubernetes_expiry_seconds"]; - }; - header?: never; - path: { + host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["credentials"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_availableUpgrades: { + monitoring_get_dropletMemoryFreeMetrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description The droplet ID. + * @example 17209102 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["available_upgrades"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_upgrade_cluster: { + monitoring_get_dropletMemoryTotalMetrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description The droplet ID. + * @example 17209102 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description The slug identifier for the version of Kubernetes that the cluster will be upgraded to. - * @example 1.16.13-do.0 - */ - version?: string; - }; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_list_nodePools: { + monitoring_get_dropletMemoryAvailableMetrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description The droplet ID. + * @example 17209102 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_node_pools"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_add_nodePool: { + monitoring_get_appMemoryPercentageMetrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description The app UUID. + * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + app_id: components["parameters"]["parameters_app_id"]; + /** + * @description The app component name. + * @example sample-application + */ + app_component?: components["parameters"]["app_component"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - /** @example { - * "size": "s-1vcpu-2gb", - * "count": 3, - * "name": "new-pool", - * "tags": [ - * "frontend" - * ], - * "auto_scale": true, - * "min_nodes": 3, - * "max_nodes": 6 - * } */ - "application/json": components["schemas"]["kubernetes_node_pool"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["node_pool_create"]; + 200: components["responses"]["app_metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_nodePool: { + monitoring_get_appCPUPercentageMetrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description The app UUID. + * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + app_id: components["parameters"]["parameters_app_id"]; /** - * @description A unique ID that can be used to reference a Kubernetes node pool. - * @example cdda885e-7663-40c8-bc74-3a036c66545d + * @description The app component name. + * @example sample-application */ - node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; + app_component?: components["parameters"]["app_component"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_node_pool"]; + 200: components["responses"]["app_metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_update_nodePool: { + "monitoring_get_appRestartCountMetrics.yml": { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description The app UUID. + * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + app_id: components["parameters"]["parameters_app_id"]; /** - * @description A unique ID that can be used to reference a Kubernetes node pool. - * @example cdda885e-7663-40c8-bc74-3a036c66545d + * @description The app component name. + * @example sample-application */ - node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; + app_component?: components["parameters"]["app_component"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["kubernetes_node_pool_update"]; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["node_pool_update"]; + 200: components["responses"]["app_metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_delete_nodePool: { + monitoring_get_lb_frontend_connections_current: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description A unique ID that can be used to reference a Kubernetes node pool. - * @example cdda885e-7663-40c8-bc74-3a036c66545d + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_delete_node: { + monitoring_get_lb_frontend_connections_limit: { parameters: { - query?: { + query: { /** - * @description Specifies whether or not to drain workloads from a node before it is deleted. Setting it to `1` causes node draining to be skipped. Omitting the query parameter or setting its value to `0` carries out draining prior to deletion. - * @example 1 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - skip_drain?: components["parameters"]["kubernetes_node_skip_drain"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description Specifies whether or not to replace a node after it has been deleted. Setting it to `1` causes the node to be replaced by a new one after deletion. Omitting the query parameter or setting its value to `0` deletes without replacement. - * @example 1 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - replace?: components["parameters"]["kubernetes_node_replace"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; header?: never; - path: { + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["metric_response"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_get_lb_frontend_cpu_utilization: { + parameters: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description A unique ID that can be used to reference a Kubernetes node pool. - * @example cdda885e-7663-40c8-bc74-3a036c66545d + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; + start: components["parameters"]["metric_timestamp_start"]; /** - * @description A unique ID that can be used to reference a node in a Kubernetes node pool. - * @example 478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - node_id: components["parameters"]["kubernetes_node_id"]; + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_recycle_node_pool: { + monitoring_get_lb_frontend_firewall_dropped_bytes: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description A unique ID that can be used to reference a Kubernetes node pool. - * @example cdda885e-7663-40c8-bc74-3a036c66545d + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @example [ - * "d8db5e1a-6103-43b5-a7b3-8a948210a9fc" - * ] */ - nodes?: string[]; - }; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_clusterUser: { + monitoring_get_lb_frontend_firewall_dropped_packets: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["cluster_user"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_list_options: { + monitoring_get_lb_frontend_http_responses: { parameters: { - query?: never; + query: { + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; + }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_options"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_clusterLintResults: { + monitoring_get_lb_frontend_http_requests_per_second: { parameters: { - query?: { + query: { /** - * @description Specifies the clusterlint run whose results will be retrieved. - * @example 50c2f44c-011d-493e-aee5-361a4a0d1844 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - run_id?: components["parameters"]["clusterlint_run_id"]; - }; - header?: never; - path: { + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["clusterlint_results"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_run_clusterLint: { + monitoring_get_lb_frontend_network_throughput_http: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["clusterlint_request"]; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["clusterlint_run"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_add_registry: { + monitoring_get_lb_frontend_network_throughput_udp: { parameters: { - query?: never; + query: { + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; + }; header?: never; path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["cluster_registries"]; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_remove_registry: { + monitoring_get_lb_frontend_network_throughput_tcp: { parameters: { - query?: never; + query: { + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; + }; header?: never; path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["cluster_registries"]; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_list: { + monitoring_get_lb_frontend_nlb_tcp_network_throughput: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - per_page?: components["parameters"]["per_page"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - page?: components["parameters"]["page"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; header?: never; path?: never; @@ -24447,249 +28022,287 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_load_balancers"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_create: { + monitoring_get_lb_frontend_nlb_udp_network_throughput: { parameters: { - query?: never; + query: { + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; + }; header?: never; path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["load_balancer_create"]; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["load_balancer_create"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_get: { + monitoring_get_lb_frontend_tls_connections_current: { parameters: { - query?: never; - header?: never; - path: { + query: { /** * @description A unique identifier for a load balancer. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - lb_id: components["parameters"]["load_balancer_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_load_balancer"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_update: { + monitoring_get_lb_frontend_tls_connections_limit: { parameters: { - query?: never; - header?: never; - path: { + query: { /** * @description A unique identifier for a load balancer. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - lb_id: components["parameters"]["load_balancer_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["load_balancer_create"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["updated_load_balancer"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_delete: { + monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit: { parameters: { - query?: never; - header?: never; - path: { + query: { /** * @description A unique identifier for a load balancer. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - lb_id: components["parameters"]["load_balancer_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_add_droplets: { + monitoring_get_lb_droplets_http_session_duration_avg: { parameters: { - query?: never; - header?: never; - path: { + query: { /** * @description A unique identifier for a load balancer. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - lb_id: components["parameters"]["load_balancer_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description An array containing the IDs of the Droplets assigned to the load balancer. - * @example [ - * 3164444, - * 3164445 - * ] - */ - droplet_ids: number[]; - }; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_remove_droplets: { + monitoring_get_lb_droplets_http_session_duration_50p: { parameters: { - query?: never; - header?: never; - path: { + query: { /** * @description A unique identifier for a load balancer. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - lb_id: components["parameters"]["load_balancer_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description An array containing the IDs of the Droplets assigned to the load balancer. - * @example [ - * 3164444, - * 3164445 - * ] - */ - droplet_ids: number[]; - }; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_add_forwardingRules: { + monitoring_get_lb_droplets_http_session_duration_95p: { parameters: { - query?: never; - header?: never; - path: { + query: { /** * @description A unique identifier for a load balancer. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - lb_id: components["parameters"]["load_balancer_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": { - forwarding_rules: components["schemas"]["forwarding_rule"][]; - }; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_remove_forwardingRules: { + monitoring_get_lb_droplets_http_response_time_avg: { parameters: { - query?: never; - header?: never; - path: { + query: { /** * @description A unique identifier for a load balancer. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - lb_id: components["parameters"]["load_balancer_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": { - forwarding_rules: components["schemas"]["forwarding_rule"][]; - }; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_list_alertPolicy: { + monitoring_get_lb_droplets_http_response_time_50p: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - per_page?: components["parameters"]["per_page"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - page?: components["parameters"]["page"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; header?: never; path?: never; @@ -24697,190 +28310,149 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["list_alert_policy_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_create_alertPolicy: { + monitoring_get_lb_droplets_http_response_time_95p: { parameters: { - query?: never; + query: { + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; + }; header?: never; path?: never; - cookie?: never; - }; - /** @description The `type` field dictates what type of entity that the alert policy applies to and hence what type of entity is passed in the `entities` array. If both the `tags` array and `entities` array are empty the alert policy applies to all entities of the relevant type that are owned by the user account. Otherwise the following table shows the valid entity types for each type of alert policy: - * - * Type | Description | Valid Entity Type - * -----|-------------|-------------------- - * `v1/insights/droplet/memory_utilization_percent` | alert on the percent of memory utilization | Droplet ID - * `v1/insights/droplet/disk_read` | alert on the rate of disk read I/O in MBps | Droplet ID - * `v1/insights/droplet/load_5` | alert on the 5 minute load average | Droplet ID - * `v1/insights/droplet/load_15` | alert on the 15 minute load average | Droplet ID - * `v1/insights/droplet/disk_utilization_percent` | alert on the percent of disk utilization | Droplet ID - * `v1/insights/droplet/cpu` | alert on the percent of CPU utilization | Droplet ID - * `v1/insights/droplet/disk_write` | alert on the rate of disk write I/O in MBps | Droplet ID - * `v1/insights/droplet/public_outbound_bandwidth` | alert on the rate of public outbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/public_inbound_bandwidth` | alert on the rate of public inbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/private_outbound_bandwidth` | alert on the rate of private outbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/private_inbound_bandwidth` | alert on the rate of private inbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/load_1` | alert on the 1 minute load average | Droplet ID - * `v1/insights/lbaas/avg_cpu_utilization_percent`|alert on the percent of CPU utilization|load balancer ID - * `v1/insights/lbaas/connection_utilization_percent`|alert on the percent of connection utilization|load balancer ID - * `v1/insights/lbaas/droplet_health`|alert on Droplet health status changes|load balancer ID - * `v1/insights/lbaas/tls_connections_per_second_utilization_percent`|alert on the percent of TLS connections per second utilization (requires at least one HTTPS forwarding rule)|load balancer ID - * `v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx`|alert on the percent increase of 5xx level http errors over 5m|load balancer ID - * `v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx`|alert on the percent increase of 4xx level http errors over 5m|load balancer ID - * `v1/insights/lbaas/increase_in_http_error_rate_count_5xx`|alert on the count of 5xx level http errors over 5m|load balancer ID - * `v1/insights/lbaas/increase_in_http_error_rate_count_4xx`|alert on the count of 4xx level http errors over 5m|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time`|alert on high average http response time|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time_50p`|alert on high 50th percentile http response time|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time_95p`|alert on high 95th percentile http response time|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time_99p`|alert on high 99th percentile http response time|load balancer ID - * `v1/dbaas/alerts/load_15_alerts` | alert on 15 minute load average across the database cluster | database cluster UUID - * `v1/dbaas/alerts/memory_utilization_alerts` | alert on the percent memory utilization average across the database cluster | database cluster UUID - * `v1/dbaas/alerts/disk_utilization_alerts` | alert on the percent disk utilization average across the database cluster | database cluster UUID - * `v1/dbaas/alerts/cpu_alerts` | alert on the percent CPU usage average across the database cluster | database cluster UUID - * */ - requestBody: { - content: { - "application/json": components["schemas"]["alert_policy_request"]; - }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["alert_policy_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_alertPolicy: { + monitoring_get_lb_droplets_http_response_time_99p: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for an alert policy. + * @description A unique identifier for a load balancer. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - alert_uuid: components["parameters"]["alert_uuid"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["alert_policy_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_update_alertPolicy: { + monitoring_get_lb_droplets_queue_size: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for an alert policy. + * @description A unique identifier for a load balancer. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - alert_uuid: components["parameters"]["alert_uuid"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - /** @description The `type` field dictates what type of entity that the alert policy applies to and hence what type of entity is passed in the `entities` array. If both the `tags` array and `entities` array are empty the alert policy applies to all entities of the relevant type that are owned by the user account. Otherwise the following table shows the valid entity types for each type of alert policy: - * - * Type | Description | Valid Entity Type - * -----|-------------|-------------------- - * `v1/insights/droplet/memory_utilization_percent` | alert on the percent of memory utilization | Droplet ID - * `v1/insights/droplet/disk_read` | alert on the rate of disk read I/O in MBps | Droplet ID - * `v1/insights/droplet/load_5` | alert on the 5 minute load average | Droplet ID - * `v1/insights/droplet/load_15` | alert on the 15 minute load average | Droplet ID - * `v1/insights/droplet/disk_utilization_percent` | alert on the percent of disk utilization | Droplet ID - * `v1/insights/droplet/cpu` | alert on the percent of CPU utilization | Droplet ID - * `v1/insights/droplet/disk_write` | alert on the rate of disk write I/O in MBps | Droplet ID - * `v1/insights/droplet/public_outbound_bandwidth` | alert on the rate of public outbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/public_inbound_bandwidth` | alert on the rate of public inbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/private_outbound_bandwidth` | alert on the rate of private outbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/private_inbound_bandwidth` | alert on the rate of private inbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/load_1` | alert on the 1 minute load average | Droplet ID - * `v1/insights/lbaas/avg_cpu_utilization_percent`|alert on the percent of CPU utilization|load balancer ID - * `v1/insights/lbaas/connection_utilization_percent`|alert on the percent of connection utilization|load balancer ID - * `v1/insights/lbaas/droplet_health`|alert on Droplet health status changes|load balancer ID - * `v1/insights/lbaas/tls_connections_per_second_utilization_percent`|alert on the percent of TLS connections per second utilization (requires at least one HTTPS forwarding rule)|load balancer ID - * `v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx`|alert on the percent increase of 5xx level http errors over 5m|load balancer ID - * `v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx`|alert on the percent increase of 4xx level http errors over 5m|load balancer ID - * `v1/insights/lbaas/increase_in_http_error_rate_count_5xx`|alert on the count of 5xx level http errors over 5m|load balancer ID - * `v1/insights/lbaas/increase_in_http_error_rate_count_4xx`|alert on the count of 4xx level http errors over 5m|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time`|alert on high average http response time|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time_50p`|alert on high 50th percentile http response time|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time_95p`|alert on high 95th percentile http response time|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time_99p`|alert on high 99th percentile http response time|load balancer ID - * `v1/dbaas/alerts/load_15_alerts` | alert on 15 minute load average across the database cluster | database cluster UUID - * `v1/dbaas/alerts/memory_utilization_alerts` | alert on the percent memory utilization average across the database cluster | database cluster UUID - * `v1/dbaas/alerts/disk_utilization_alerts` | alert on the percent disk utilization average across the database cluster | database cluster UUID - * `v1/dbaas/alerts/cpu_alerts` | alert on the percent CPU usage average across the database cluster | database cluster UUID - * */ - requestBody: { - content: { - "application/json": components["schemas"]["alert_policy_request"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["alert_policy_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_delete_alertPolicy: { + monitoring_get_lb_droplets_http_responses: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for an alert policy. + * @description A unique identifier for a load balancer. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - alert_uuid: components["parameters"]["alert_uuid"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletBandwidthMetrics: { + monitoring_get_lb_droplets_connections: { parameters: { query: { /** - * @description The droplet ID. - * @example 17209102 - */ - host_id: components["parameters"]["parameters_droplet_id"]; - /** - * @description The network interface. - * @example private - */ - interface: components["parameters"]["network_interface"]; - /** - * @description The traffic direction. - * @example inbound + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - direction: components["parameters"]["network_direction"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** * @description UNIX timestamp to start metric window. * @example 1620683817 @@ -24898,21 +28470,21 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["droplet_bandwidth_metric_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_DropletCpuMetrics: { + monitoring_get_lb_droplets_health_checks: { parameters: { query: { /** - * @description The droplet ID. - * @example 17209102 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - host_id: components["parameters"]["parameters_droplet_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** * @description UNIX timestamp to start metric window. * @example 1620683817 @@ -24930,21 +28502,21 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["droplet_cpu_metric_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletFilesystemFreeMetrics: { + monitoring_get_lb_droplets_downtime: { parameters: { query: { /** - * @description The droplet ID. - * @example 17209102 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - host_id: components["parameters"]["parameters_droplet_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** * @description UNIX timestamp to start metric window. * @example 1620683817 @@ -24962,21 +28534,21 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["droplet_filesystem_metric_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletFilesystemSizeMetrics: { + monitoring_get_droplet_autoscale_current_instances: { parameters: { query: { /** - * @description The droplet ID. - * @example 17209102 + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - host_id: components["parameters"]["parameters_droplet_id"]; + autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; /** * @description UNIX timestamp to start metric window. * @example 1620683817 @@ -24994,21 +28566,21 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["droplet_filesystem_metric_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletLoad1Metrics: { + monitoring_get_droplet_autoscale_target_instances: { parameters: { query: { /** - * @description The droplet ID. - * @example 17209102 + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - host_id: components["parameters"]["parameters_droplet_id"]; + autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; /** * @description UNIX timestamp to start metric window. * @example 1620683817 @@ -25033,14 +28605,14 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletLoad5Metrics: { + "monitoring_get_droplet_autoscale_current_cpu_utilization.yml": { parameters: { query: { /** - * @description The droplet ID. - * @example 17209102 + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - host_id: components["parameters"]["parameters_droplet_id"]; + autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; /** * @description UNIX timestamp to start metric window. * @example 1620683817 @@ -25065,14 +28637,14 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletLoad15Metrics: { + monitoring_get_droplet_autoscale_target_cpu_utilization: { parameters: { query: { /** - * @description The droplet ID. - * @example 17209102 + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - host_id: components["parameters"]["parameters_droplet_id"]; + autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; /** * @description UNIX timestamp to start metric window. * @example 1620683817 @@ -25097,14 +28669,14 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletMemoryCachedMetrics: { + monitoring_get_droplet_autoscale_current_memory_utilization: { parameters: { query: { /** - * @description The droplet ID. - * @example 17209102 + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - host_id: components["parameters"]["parameters_droplet_id"]; + autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; /** * @description UNIX timestamp to start metric window. * @example 1620683817 @@ -25129,125 +28701,157 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletMemoryFreeMetrics: { + monitoring_get_droplet_autoscale_target_memory_utilization: { parameters: { query: { /** - * @description The droplet ID. - * @example 17209102 + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - host_id: components["parameters"]["parameters_droplet_id"]; + autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; /** * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["metric_response"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_list_destinations: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["monitoring_list_destinations"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_create_destination: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["destination_request"]; + }; + }; + responses: { + 200: components["responses"]["destination"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + monitoring_get_destination: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a destination. + * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 */ - end: components["parameters"]["metric_timestamp_end"]; + destination_uuid: components["parameters"]["destination_uuid"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["destination"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletMemoryTotalMetrics: { + monitoring_update_destination: { parameters: { - query: { - /** - * @description The droplet ID. - * @example 17209102 - */ - host_id: components["parameters"]["parameters_droplet_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A unique identifier for a destination. + * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 */ - end: components["parameters"]["metric_timestamp_end"]; + destination_uuid: components["parameters"]["destination_uuid"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["destination_request"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletMemoryAvailableMetrics: { + monitoring_delete_destination: { parameters: { - query: { - /** - * @description The droplet ID. - * @example 17209102 - */ - host_id: components["parameters"]["parameters_droplet_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A unique identifier for a destination. + * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 */ - end: components["parameters"]["metric_timestamp_end"]; + destination_uuid: components["parameters"]["destination_uuid"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_appMemoryPercentageMetrics: { + monitoring_list_sinks: { parameters: { - query: { - /** - * @description The app UUID. - * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 - */ - app_id: components["parameters"]["parameters_app_id"]; - /** - * @description The app component name. - * @example sample-application - */ - app_component?: components["parameters"]["app_component"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A unique URN for a resource. + * @example do:kubernetes:5ba4518b-b9e2-4978-aa92-2d4c727e8824 */ - end: components["parameters"]["metric_timestamp_end"]; + resource_id?: components["parameters"]["resource_id"]; }; header?: never; path?: never; @@ -25255,137 +28859,102 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["app_metric_response"]; + 200: components["responses"]["list_sinks"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_appCPUPercentageMetrics: { + monitoring_create_sink: { parameters: { - query: { - /** - * @description The app UUID. - * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 - */ - app_id: components["parameters"]["parameters_app_id"]; - /** - * @description The app component name. - * @example sample-application - */ - app_component?: components["parameters"]["app_component"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description A unique identifier for an already-existing destination. + * @example 9df2b7e9-3fb2-4577-b60a-e9c0d53f9a99 + */ + destination_uuid?: string; + /** @description List of resources identified by their URNs. */ + resources?: components["schemas"]["sink_resource"][]; + }; + }; + }; responses: { - 200: components["responses"]["app_metric_response"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - "monitoring_get_appRestartCountMetrics.yml": { + monitoring_get_sink: { parameters: { - query: { - /** - * @description The app UUID. - * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 - */ - app_id: components["parameters"]["parameters_app_id"]; - /** - * @description The app component name. - * @example sample-application - */ - app_component?: components["parameters"]["app_component"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A unique identifier for a sink. + * @example 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c */ - end: components["parameters"]["metric_timestamp_end"]; + sink_uuid: components["parameters"]["sink_uuid"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["app_metric_response"]; + 200: components["responses"]["sinks"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_connections_current: { + monitoring_delete_sink: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A unique identifier for a sink. + * @example 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c */ - end: components["parameters"]["metric_timestamp_end"]; + sink_uuid: components["parameters"]["sink_uuid"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_connections_limit: { + projects_list: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + query?: { /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Number of items returned per page + * @example 2 */ - start: components["parameters"]["metric_timestamp_start"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Which 'page' of paginated results to return. + * @example 1 */ - end: components["parameters"]["metric_timestamp_end"]; + page?: components["parameters"]["page"]; }; header?: never; path?: never; @@ -25393,351 +28962,311 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["projects_list"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_cpu_utilization: { + projects_create: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": WithRequired; }; + }; + responses: { + 201: components["responses"]["existing_project"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + projects_get_default: { + parameters: { + query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["default_project"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_firewall_dropped_bytes: { + projects_update_default: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["project"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["existing_project"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_firewall_dropped_packets: { + projects_patch_default: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** @example { + * "name": "my-web-api" + * } */ + "application/json": components["schemas"]["project"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["existing_project"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_http_responses: { + projects_get: { parameters: { - query: { + query?: never; + header?: never; + path: { /** - * @description A unique identifier for a load balancer. + * @description A unique identifier for a project. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; + project_id: components["parameters"]["project_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["existing_project"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_http_requests_per_second: { + projects_update: { parameters: { - query: { + query?: never; + header?: never; + path: { /** - * @description A unique identifier for a load balancer. + * @description A unique identifier for a project. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; + project_id: components["parameters"]["project_id"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["project"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["existing_project"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_network_throughput_http: { + projects_delete: { parameters: { - query: { + query?: never; + header?: never; + path: { /** - * @description A unique identifier for a load balancer. + * @description A unique identifier for a project. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; + project_id: components["parameters"]["project_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 412: components["responses"]["precondition_failed"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_network_throughput_udp: { + projects_patch: { parameters: { - query: { + query?: never; + header?: never; + path: { /** - * @description A unique identifier for a load balancer. + * @description A unique identifier for a project. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; + project_id: components["parameters"]["project_id"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** @example { + * "name": "my-web-api" + * } */ + "application/json": components["schemas"]["project"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["existing_project"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_network_throughput_tcp: { + projects_list_resources: { parameters: { - query: { + query?: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Number of items returned per page + * @example 2 */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Which 'page' of paginated results to return. + * @example 1 */ - start: components["parameters"]["metric_timestamp_start"]; + page?: components["parameters"]["page"]; + }; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A unique identifier for a project. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - end: components["parameters"]["metric_timestamp_end"]; + project_id: components["parameters"]["project_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["resources_list"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_nlb_tcp_network_throughput: { + projects_assign_resources: { parameters: { - query: { + query?: never; + header?: never; + path: { /** - * @description A unique identifier for a load balancer. + * @description A unique identifier for a project. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; + project_id: components["parameters"]["project_id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["project_assignment"]; }; + }; + responses: { + 200: components["responses"]["assigned_resources_list"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + projects_list_resources_default: { + parameters: { + query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["resources_list"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_nlb_udp_network_throughput: { + projects_assign_resources_default: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["project_assignment"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["assigned_resources_list"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_tls_connections_current: { + regions_list: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + query?: { /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Number of items returned per page + * @example 2 */ - start: components["parameters"]["metric_timestamp_start"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Which 'page' of paginated results to return. + * @example 1 */ - end: components["parameters"]["metric_timestamp_end"]; + page?: components["parameters"]["page"]; }; header?: never; path?: never; @@ -25745,191 +29274,122 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["all_regions"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_tls_connections_limit: { + registry_get: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["registry_info"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit: { + registry_create: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["registry_create"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 201: components["responses"]["registry_info"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_http_session_duration_avg: { + registry_delete: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_http_session_duration_50p: { + registry_get_subscription: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["subscription_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_http_session_duration_95p: { + registry_update_subscription: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description The slug of the subscription tier to sign up for. + * @example basic + * @enum {string} + */ + tier_slug?: "starter" | "basic" | "professional"; + }; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["subscription_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_http_response_time_avg: { + registry_get_dockerCredentials: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + query?: { /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description The duration in seconds that the returned registry credentials will be valid. If not set or 0, the credentials will not expire. + * @example 3600 */ - start: components["parameters"]["metric_timestamp_start"]; + expiry_seconds?: components["parameters"]["registry_expiry_seconds"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description By default, the registry credentials allow for read-only access. Set this query parameter to `true` to obtain read-write credentials. + * @example true */ - end: components["parameters"]["metric_timestamp_end"]; + read_write?: components["parameters"]["registry_read_write"]; }; header?: never; path?: never; @@ -25937,279 +29397,291 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["docker_credentials"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_http_response_time_50p: { + registry_validate_name: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["validate_registry"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 409: components["responses"]["conflict"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_http_response_time_95p: { + registry_list_repositories: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + query?: { /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Number of items returned per page + * @example 2 */ - start: components["parameters"]["metric_timestamp_start"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Which 'page' of paginated results to return. + * @example 1 */ - end: components["parameters"]["metric_timestamp_end"]; + page?: components["parameters"]["page"]; }; header?: never; - path?: never; + path: { + /** + * @description The name of a container registry. + * @example example + */ + registry_name: components["parameters"]["registry_name"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["all_repositories"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_http_response_time_99p: { + registry_list_repositoriesV2: { parameters: { - query: { + query?: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Number of items returned per page + * @example 2 */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Which 'page' of paginated results to return. Ignored when 'page_token' is provided. + * @example 1 */ - start: components["parameters"]["metric_timestamp_start"]; + page?: components["parameters"]["token_pagination_page"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Token to retrieve of the next or previous set of results more quickly than using 'page'. + * @example eyJUb2tlbiI6IkNnZGpiMjlz */ - end: components["parameters"]["metric_timestamp_end"]; + page_token?: components["parameters"]["token_pagination_page_token"]; }; header?: never; - path?: never; + path: { + /** + * @description The name of a container registry. + * @example example + */ + registry_name: components["parameters"]["registry_name"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["all_repositories_v2"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_queue_size: { + registry_list_repositoryTags: { parameters: { - query: { + query?: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Number of items returned per page + * @example 2 */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Which 'page' of paginated results to return. + * @example 1 */ - start: components["parameters"]["metric_timestamp_start"]; + page?: components["parameters"]["page"]; + }; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of a container registry. + * @example example */ - end: components["parameters"]["metric_timestamp_end"]; + registry_name: components["parameters"]["registry_name"]; + /** + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 + */ + repository_name: components["parameters"]["registry_repository_name"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["repository_tags"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_http_responses: { + registry_delete_repositoryTag: { parameters: { - query: { + query?: never; + header?: never; + path: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The name of a container registry. + * @example example */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + registry_name: components["parameters"]["registry_name"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 */ - start: components["parameters"]["metric_timestamp_start"]; + repository_name: components["parameters"]["registry_repository_name"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of a container registry repository tag. + * @example 06a447a */ - end: components["parameters"]["metric_timestamp_end"]; + repository_tag: components["parameters"]["registry_repository_tag"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_connections: { + registry_list_repositoryManifests: { parameters: { - query: { + query?: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Number of items returned per page + * @example 2 */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Which 'page' of paginated results to return. + * @example 1 */ - start: components["parameters"]["metric_timestamp_start"]; + page?: components["parameters"]["page"]; + }; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of a container registry. + * @example example */ - end: components["parameters"]["metric_timestamp_end"]; + registry_name: components["parameters"]["registry_name"]; + /** + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 + */ + repository_name: components["parameters"]["registry_repository_name"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["repository_manifests"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_health_checks: { + registry_delete_repositoryManifest: { parameters: { - query: { + query?: never; + header?: never; + path: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The name of a container registry. + * @example example */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + registry_name: components["parameters"]["registry_name"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 */ - start: components["parameters"]["metric_timestamp_start"]; + repository_name: components["parameters"]["registry_repository_name"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The manifest digest of a container registry repository tag. + * @example sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221 */ - end: components["parameters"]["metric_timestamp_end"]; + manifest_digest: components["parameters"]["registry_manifest_digest"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_downtime: { + registry_get_garbageCollection: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of a container registry. + * @example example */ - end: components["parameters"]["metric_timestamp_end"]; + registry_name: components["parameters"]["registry_name"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["garbage_collection"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_list_destinations: { + registry_run_garbageCollection: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description The name of a container registry. + * @example example + */ + registry_name: components["parameters"]["registry_name"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["monitoring_list_destinations"]; + 201: components["responses"]["garbage_collection"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26217,20 +29689,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_create_destination: { + registry_list_garbageCollections: { parameters: { - query?: never; + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["destination_request"]; + path: { + /** + * @description The name of a container registry. + * @example example + */ + registry_name: components["parameters"]["registry_name"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["destination"]; + 200: components["responses"]["garbage_collections"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26238,22 +29723,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_destination: { + registry_update_garbageCollection: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a destination. - * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 + * @description The name of a container registry. + * @example example + */ + registry_name: components["parameters"]["registry_name"]; + /** + * @description The UUID of a garbage collection run. + * @example eff0feee-49c7-4e8f-ba5c-a320c109c8a8 */ - destination_uuid: components["parameters"]["destination_uuid"]; + garbage_collection_uuid: components["parameters"]["garbage_collection_uuid"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["update_registry"]; + }; + }; responses: { - 200: components["responses"]["destination"]; + 200: components["responses"]["garbage_collection"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26261,49 +29755,32 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_update_destination: { + registry_get_options: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a destination. - * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 - */ - destination_uuid: components["parameters"]["destination_uuid"]; - }; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["destination_request"]; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["registry_options_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_delete_destination: { + droplets_list_neighborsIds: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a destination. - * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 - */ - destination_uuid: components["parameters"]["destination_uuid"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["droplet_neighbors_ids"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26311,14 +29788,19 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_list_sinks: { + reservedIPs_list: { parameters: { query?: { /** - * @description A unique URN for a resource. - * @example do:kubernetes:5ba4518b-b9e2-4978-aa92-2d4c727e8824 + * @description Number of items returned per page + * @example 2 */ - resource_id?: components["parameters"]["resource_id"]; + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; }; header?: never; path?: never; @@ -26326,15 +29808,14 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["list_sinks"]; + 200: components["responses"]["reserved_ip_list"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_create_sink: { + reservedIPs_create: { parameters: { query?: never; header?: never; @@ -26343,42 +29824,33 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** - * @description A unique identifier for an already-existing destination. - * @example 9df2b7e9-3fb2-4577-b60a-e9c0d53f9a99 - */ - destination_uuid?: string; - /** @description List of resources identified by their URNs. */ - resources?: components["schemas"]["sink_resource"][]; - }; + "application/json": components["schemas"]["reserved_ip_create"]; }; }; responses: { - 202: components["responses"]["accepted"]; + 202: components["responses"]["reserved_ip_created"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_sink: { + reservedIPs_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a sink. - * @example 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c + * @description A reserved IP address. + * @example 45.55.96.47 */ - sink_uuid: components["parameters"]["sink_uuid"]; + reserved_ip: components["parameters"]["reserved_ip"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["sinks"]; + 200: components["responses"]["reserved_ip"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26386,16 +29858,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_delete_sink: { + reservedIPs_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a sink. - * @example 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c + * @description A reserved IP address. + * @example 45.55.96.47 */ - sink_uuid: components["parameters"]["sink_uuid"]; + reserved_ip: components["parameters"]["reserved_ip"]; }; cookie?: never; }; @@ -26409,63 +29881,80 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_list: { + reservedIPsActions_list: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; + query?: never; + header?: never; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A reserved IP address. + * @example 45.55.96.47 */ - page?: components["parameters"]["page"]; + reserved_ip: components["parameters"]["reserved_ip"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["projects_list"]; + 200: components["responses"]["reserved_ip_actions"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - projects_create: { + reservedIPsActions_post: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A reserved IP address. + * @example 45.55.96.47 + */ + reserved_ip: components["parameters"]["reserved_ip"]; + }; cookie?: never; }; - requestBody: { + /** @description The `type` attribute set in the request body will specify the action that + * will be taken on the reserved IP. + * */ + requestBody?: { content: { - "application/json": WithRequired; + "application/json": components["schemas"]["reserved_ip_action_unassign"] | components["schemas"]["reserved_ip_action_assign"]; }; }; responses: { - 201: components["responses"]["existing_project"]; + 201: components["responses"]["reserved_ip_action"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - projects_get_default: { + reservedIPsActions_get: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A reserved IP address. + * @example 45.55.96.47 + */ + reserved_ip: components["parameters"]["reserved_ip"]; + /** + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 + */ + action_id: components["parameters"]["action_id"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["default_project"]; + 200: components["responses"]["reserved_ip_action"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26473,67 +29962,82 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_update_default: { + sizes_list: { parameters: { - query?: never; + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; header?: never; path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["project"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["existing_project"]; + 200: components["responses"]["all_sizes"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - projects_patch_default: { + snapshots_list: { parameters: { - query?: never; + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + /** + * @description Used to filter snapshots by a resource type. + * @example droplet + */ + resource_type?: components["parameters"]["snapshot_resource_type"]; + }; header?: never; path?: never; cookie?: never; }; - requestBody: { - content: { - /** @example { - * "name": "my-web-api" - * } */ - "application/json": components["schemas"]["project"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["existing_project"]; + 200: components["responses"]["snapshots"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - projects_get: { + snapshots_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a project. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. + * @example 6372321 */ - project_id: components["parameters"]["project_id"]; + snapshot_id: components["parameters"]["snapshot_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_project"]; + 200: components["responses"]["snapshots_existing"]; + 400: components["responses"]["not_a_snapshot"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26541,26 +30045,23 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_update: { + snapshots_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a project. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. + * @example 6372321 */ - project_id: components["parameters"]["project_id"]; + snapshot_id: components["parameters"]["snapshot_id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["project"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["existing_project"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["not_a_snapshot"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26568,87 +30069,70 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_delete: { + tags_list: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a project. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Number of items returned per page + * @example 2 */ - project_id: components["parameters"]["project_id"]; + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["tags_all"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; - 412: components["responses"]["precondition_failed"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - projects_patch: { + tags_create: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a project. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - project_id: components["parameters"]["project_id"]; - }; + path?: never; cookie?: never; }; requestBody: { content: { - /** @example { - * "name": "my-web-api" - * } */ - "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["tags"]; }; }; responses: { - 200: components["responses"]["existing_project"]; + 201: components["responses"]["tags_new"]; + 400: components["responses"]["tags_bad_request"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - projects_list_resources: { + tags_get: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** - * @description A unique identifier for a project. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. + * @example awesome */ - project_id: components["parameters"]["project_id"]; + tag_id: components["parameters"]["tag_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["resources_list"]; + 200: components["responses"]["tags_existing"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26656,26 +30140,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_assign_resources: { + tags_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a project. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. + * @example awesome */ - project_id: components["parameters"]["project_id"]; + tag_id: components["parameters"]["tag_id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["project_assignment"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["assigned_resources_list"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26683,16 +30163,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_list_resources_default: { + tags_assign_resources: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. + * @example awesome + */ + tag_id: components["parameters"]["tag_id"]; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["tags_resource"]; + }; + }; responses: { - 200: components["responses"]["resources_list"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26700,20 +30190,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_assign_resources_default: { + tags_unassign_resources: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. + * @example awesome + */ + tag_id: components["parameters"]["tag_id"]; + }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["project_assignment"]; + "application/json": components["schemas"]["tags_resource"]; }; }; responses: { - 200: components["responses"]["assigned_resources_list"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26721,9 +30217,19 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - regions_list: { + volumes_list: { parameters: { query?: { + /** + * @description The block storage volume's name. + * @example example + */ + name?: components["parameters"]["volume_name"]; + /** + * @description The slug identifier for the region where the resource is available. + * @example nyc3 + */ + region?: components["parameters"]["region"]; /** * @description Number of items returned per page * @example 2 @@ -26741,30 +30247,14 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_regions"]; - 401: components["responses"]["unauthorized"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - registry_get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: components["responses"]["registry_info"]; + 200: components["responses"]["volumes"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - registry_create: { + volumes_create: { parameters: { query?: never; header?: never; @@ -26773,20 +30263,33 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["registry_create"]; + "application/json": components["schemas"]["volumes_ext4"] | components["schemas"]["volumes_xfs"]; }; }; responses: { - 201: components["responses"]["registry_info"]; + 201: components["responses"]["volume"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - registry_delete: { + volumes_delete_byName: { parameters: { - query?: never; + query?: { + /** + * @description The block storage volume's name. + * @example example + */ + name?: components["parameters"]["volume_name"]; + /** + * @description The slug identifier for the region where the resource is available. + * @example nyc3 + */ + region?: components["parameters"]["region"]; + }; header?: never; path?: never; cookie?: never; @@ -26801,124 +30304,123 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_get_subscription: { + volumeActions_post: { parameters: { - query?: never; + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["volume_action_post_attach"] | components["schemas"]["volume_action_post_detach"]; + }; + }; responses: { - 200: components["responses"]["subscription_response"]; + 202: components["responses"]["volumeAction"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - registry_update_subscription: { + volumeSnapshots_get_byId: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The slug of the subscription tier to sign up for. - * @example basic - * @enum {string} - */ - tier_slug?: "starter" | "basic" | "professional"; - }; + path: { + /** + * @description The unique identifier for the snapshot. + * @example fbe805e8-866b-11e6-96bf-000f53315a41 + */ + snapshot_id: components["parameters"]["volume_snapshot_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["subscription_response"]; + 200: components["responses"]["volumeSnapshot"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - registry_get_dockerCredentials: { + volumeSnapshots_delete_byId: { parameters: { - query?: { - /** - * @description The duration in seconds that the returned registry credentials will be valid. If not set or 0, the credentials will not expire. - * @example 3600 - */ - expiry_seconds?: components["parameters"]["registry_expiry_seconds"]; + query?: never; + header?: never; + path: { /** - * @description By default, the registry credentials allow for read-only access. Set this query parameter to `true` to obtain read-write credentials. - * @example true + * @description The unique identifier for the snapshot. + * @example fbe805e8-866b-11e6-96bf-000f53315a41 */ - read_write?: components["parameters"]["registry_read_write"]; + snapshot_id: components["parameters"]["volume_snapshot_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["docker_credentials"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - registry_validate_name: { + volumes_get: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["validate_registry"]; + path: { + /** + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 + */ + volume_id: components["parameters"]["volume_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["volume"]; 401: components["responses"]["unauthorized"]; - 409: components["responses"]["conflict"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - registry_list_repositories: { + volumes_delete: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** - * @description The name of a container registry. - * @example example + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 */ - registry_name: components["parameters"]["registry_name"]; + volume_id: components["parameters"]["volume_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_repositories"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26926,7 +30428,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_list_repositoriesV2: { + volumeActions_list: { parameters: { query?: { /** @@ -26935,30 +30437,24 @@ export interface operations { */ per_page?: components["parameters"]["per_page"]; /** - * @description Which 'page' of paginated results to return. Ignored when 'page_token' is provided. + * @description Which 'page' of paginated results to return. * @example 1 */ - page?: components["parameters"]["token_pagination_page"]; - /** - * @description Token to retrieve of the next or previous set of results more quickly than using 'page'. - * @example eyJUb2tlbiI6IkNnZGpiMjlz - */ - page_token?: components["parameters"]["token_pagination_page_token"]; + page?: components["parameters"]["page"]; }; header?: never; path: { /** - * @description The name of a container registry. - * @example example + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 */ - registry_name: components["parameters"]["registry_name"]; + volume_id: components["parameters"]["volume_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_repositories_v2"]; - 400: components["responses"]["bad_request"]; + 200: components["responses"]["volumeActions"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -26966,7 +30462,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_list_repositoryTags: { + volumeActions_post_byId: { parameters: { query?: { /** @@ -26983,54 +30479,20 @@ export interface operations { header?: never; path: { /** - * @description The name of a container registry. - * @example example - */ - registry_name: components["parameters"]["registry_name"]; - /** - * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. - * @example repo-1 + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 */ - repository_name: components["parameters"]["registry_repository_name"]; + volume_id: components["parameters"]["volume_id"]; }; cookie?: never; }; - requestBody?: never; - responses: { - 200: components["responses"]["repository_tags"]; - 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - registry_delete_repositoryTag: { - parameters: { - query?: never; - header?: never; - path: { - /** - * @description The name of a container registry. - * @example example - */ - registry_name: components["parameters"]["registry_name"]; - /** - * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. - * @example repo-1 - */ - repository_name: components["parameters"]["registry_repository_name"]; - /** - * @description The name of a container registry repository tag. - * @example 06a447a - */ - repository_tag: components["parameters"]["registry_repository_tag"]; + requestBody: { + content: { + "application/json": components["schemas"]["volume_action_post_attach"] | components["schemas"]["volume_action_post_detach"] | components["schemas"]["volume_action_post_resize"]; }; - cookie?: never; }; - requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 202: components["responses"]["volumeAction"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27038,7 +30500,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_list_repositoryManifests: { + volumeActions_get: { parameters: { query?: { /** @@ -27055,21 +30517,21 @@ export interface operations { header?: never; path: { /** - * @description The name of a container registry. - * @example example + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 */ - registry_name: components["parameters"]["registry_name"]; + volume_id: components["parameters"]["volume_id"]; /** - * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. - * @example repo-1 + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 */ - repository_name: components["parameters"]["registry_repository_name"]; + action_id: components["parameters"]["action_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["repository_manifests"]; + 200: components["responses"]["volumeAction"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27077,55 +30539,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_delete_repositoryManifest: { + volumeSnapshots_list: { parameters: { - query?: never; - header?: never; - path: { - /** - * @description The name of a container registry. - * @example example - */ - registry_name: components["parameters"]["registry_name"]; + query?: { /** - * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. - * @example repo-1 + * @description Number of items returned per page + * @example 2 */ - repository_name: components["parameters"]["registry_repository_name"]; + per_page?: components["parameters"]["per_page"]; /** - * @description The manifest digest of a container registry repository tag. - * @example sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221 + * @description Which 'page' of paginated results to return. + * @example 1 */ - manifest_digest: components["parameters"]["registry_manifest_digest"]; + page?: components["parameters"]["page"]; }; - cookie?: never; - }; - requestBody?: never; - responses: { - 204: components["responses"]["no_content"]; - 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - registry_get_garbageCollection: { - parameters: { - query?: never; header?: never; path: { /** - * @description The name of a container registry. - * @example example + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 */ - registry_name: components["parameters"]["registry_name"]; + volume_id: components["parameters"]["volume_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["garbage_collection"]; + 200: components["responses"]["volumeSnapshots"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27133,22 +30573,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_run_garbageCollection: { + volumeSnapshots_create: { parameters: { query?: never; header?: never; path: { /** - * @description The name of a container registry. - * @example example + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 */ - registry_name: components["parameters"]["registry_name"]; + volume_id: components["parameters"]["volume_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** @example { + * "name": "big-data-snapshot1475261774" + * } */ + "application/json": { + /** + * @description A human-readable name for the volume snapshot. + * @example big-data-snapshot1475261774 + */ + name: string; + tags?: components["schemas"]["tags_array"]; + }; + }; + }; responses: { - 201: components["responses"]["garbage_collection"]; + 201: components["responses"]["volumeSnapshot"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27156,7 +30611,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_list_garbageCollections: { + vpcs_list: { parameters: { query?: { /** @@ -27171,18 +30626,12 @@ export interface operations { page?: components["parameters"]["page"]; }; header?: never; - path: { - /** - * @description The name of a container registry. - * @example example - */ - registry_name: components["parameters"]["registry_name"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["garbage_collections"]; + 200: components["responses"]["all_vpcs"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27190,134 +30639,119 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_update_garbageCollection: { + vpcs_create: { parameters: { query?: never; header?: never; - path: { - /** - * @description The name of a container registry. - * @example example - */ - registry_name: components["parameters"]["registry_name"]; - /** - * @description The UUID of a garbage collection run. - * @example eff0feee-49c7-4e8f-ba5c-a320c109c8a8 - */ - garbage_collection_uuid: components["parameters"]["garbage_collection_uuid"]; - }; + path?: never; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["update_registry"]; + "application/json": WithRequired & WithRequired; }; }; responses: { - 200: components["responses"]["garbage_collection"]; + 201: components["responses"]["existing_vpc"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - registry_get_options: { + vpcs_get: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique identifier for a VPC. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + vpc_id: components["parameters"]["vpc_id"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["registry_options_response"]; + 200: components["responses"]["existing_vpc"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - droplets_list_neighborsIds: { + vpcs_update: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: components["responses"]["droplet_neighbors_ids"]; - 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - reservedIPs_list: { - parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A unique identifier for a VPC. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - page?: components["parameters"]["page"]; + vpc_id: components["parameters"]["vpc_id"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": WithRequired & components["schemas"]["vpc_default"]; + }; + }; responses: { - 200: components["responses"]["reserved_ip_list"]; + 200: components["responses"]["existing_vpc"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - reservedIPs_create: { + vpcs_delete: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["reserved_ip_create"]; + path: { + /** + * @description A unique identifier for a VPC. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + vpc_id: components["parameters"]["vpc_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 202: components["responses"]["reserved_ip_created"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - reservedIPs_get: { + vpcs_patch: { parameters: { query?: never; header?: never; path: { /** - * @description A reserved IP address. - * @example 45.55.96.47 + * @description A unique identifier for a VPC. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - reserved_ip: components["parameters"]["reserved_ip"]; + vpc_id: components["parameters"]["vpc_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["vpc_updatable"] & components["schemas"]["vpc_default"]; + }; + }; responses: { - 200: components["responses"]["reserved_ip"]; + 200: components["responses"]["existing_vpc"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27325,22 +30759,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - reservedIPs_delete: { + vpcs_list_members: { parameters: { - query?: never; + query?: { + /** + * @description Used to filter VPC members by a resource type. + * @example droplet + */ + resource_type?: components["parameters"]["vpc_resource_type"]; + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; header?: never; path: { /** - * @description A reserved IP address. - * @example 45.55.96.47 + * @description A unique identifier for a VPC. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - reserved_ip: components["parameters"]["reserved_ip"]; + vpc_id: components["parameters"]["vpc_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["vpc_members"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27348,22 +30798,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - reservedIPsActions_list: { + vpcs_list_peerings: { parameters: { - query?: never; + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; header?: never; path: { /** - * @description A reserved IP address. - * @example 45.55.96.47 + * @description A unique identifier for a VPC. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - reserved_ip: components["parameters"]["reserved_ip"]; + vpc_id: components["parameters"]["vpc_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["reserved_ip_actions"]; + 200: components["responses"]["vpc_peerings"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27371,29 +30832,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - reservedIPsActions_post: { + vpcs_create_peerings: { parameters: { query?: never; header?: never; path: { /** - * @description A reserved IP address. - * @example 45.55.96.47 + * @description A unique identifier for a VPC. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - reserved_ip: components["parameters"]["reserved_ip"]; + vpc_id: components["parameters"]["vpc_id"]; }; cookie?: never; }; - /** @description The `type` attribute set in the request body will specify the action that - * will be taken on the reserved IP. - * */ - requestBody?: { + requestBody: { content: { - "application/json": components["schemas"]["reserved_ip_action_unassign"] | components["schemas"]["reserved_ip_action_assign"]; + "application/json": { + /** + * @description The name of the VPC peering. Must be unique and may only contain alphanumeric characters, dashes, and periods. + * @example nyc1-blr1-peering + */ + name: string; + /** + * Format: uuid + * @description The ID of the VPC to peer with. + * @example c140286f-e6ce-4131-8b7b-df4590ce8d6a + */ + vpc_id: string; + }; }; }; responses: { - 201: components["responses"]["reserved_ip_action"]; + 202: components["responses"]["vpc_peering"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27401,27 +30871,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - reservedIPsActions_get: { + vpcs_patch_peerings: { parameters: { query?: never; header?: never; path: { /** - * @description A reserved IP address. - * @example 45.55.96.47 + * @description A unique identifier for a VPC. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - reserved_ip: components["parameters"]["reserved_ip"]; + vpc_id: components["parameters"]["vpc_id"]; /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 + * @description A unique identifier for a VPC peering. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 */ - action_id: components["parameters"]["action_id"]; + vpc_peering_id: components["parameters"]["vpc_peering_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": WithRequired; + }; + }; responses: { - 200: components["responses"]["reserved_ip_action"]; + 200: components["responses"]["vpc_peering"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27429,7 +30903,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - sizes_list: { + vpcPeerings_list: { parameters: { query?: { /** @@ -27442,6 +30916,11 @@ export interface operations { * @example 1 */ page?: components["parameters"]["page"]; + /** + * @description The slug identifier for the region where the resource is available. + * @example nyc3 + */ + region?: components["parameters"]["region"]; }; header?: never; path?: never; @@ -27449,62 +30928,73 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_sizes"]; + 200: components["responses"]["all_vpc_peerings"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - snapshots_list: { + vpcPeerings_create: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": WithRequired & WithRequired; + }; + }; + responses: { + 202: components["responses"]["provisioning_vpc_peering"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + vpcPeerings_get: { + parameters: { + query?: never; + header?: never; + path: { /** - * @description Used to filter snapshots by a resource type. - * @example droplet + * @description A unique identifier for a VPC peering. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 */ - resource_type?: components["parameters"]["snapshot_resource_type"]; + vpc_peering_id: components["parameters"]["vpc_peering_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["snapshots"]; + 200: components["responses"]["active_vpc_peering"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - snapshots_get: { + vpcPeerings_delete: { parameters: { query?: never; header?: never; path: { /** - * @description Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. - * @example 6372321 + * @description A unique identifier for a VPC peering. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 */ - snapshot_id: components["parameters"]["snapshot_id"]; + vpc_peering_id: components["parameters"]["vpc_peering_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["snapshots_existing"]; - 400: components["responses"]["not_a_snapshot"]; + 202: components["responses"]["deleting_vpc_peering"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27512,23 +31002,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - snapshots_delete: { + vpcPeerings_patch: { parameters: { query?: never; header?: never; path: { /** - * @description Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. - * @example 6372321 + * @description A unique identifier for a VPC peering. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 */ - snapshot_id: components["parameters"]["snapshot_id"]; + vpc_peering_id: components["parameters"]["vpc_peering_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": WithRequired; + }; + }; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["not_a_snapshot"]; + 200: components["responses"]["active_vpc_peering"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27536,7 +31029,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - tags_list: { + uptime_list_checks: { parameters: { query?: { /** @@ -27556,14 +31049,15 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["tags_all"]; + 200: components["responses"]["all_checks"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - tags_create: { + uptime_create_check: { parameters: { query?: never; header?: never; @@ -27572,34 +31066,33 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["tags"]; + "application/json": WithRequired; }; }; responses: { - 201: components["responses"]["tags_new"]; - 400: components["responses"]["tags_bad_request"]; + 201: components["responses"]["existing_check"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - tags_get: { + uptime_get_check: { parameters: { query?: never; header?: never; path: { /** - * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. - * @example awesome + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - tag_id: components["parameters"]["tag_id"]; + check_id: components["parameters"]["check_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["tags_existing"]; + 200: components["responses"]["existing_check"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27607,22 +31100,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - tags_delete: { + uptime_update_check: { parameters: { query?: never; header?: never; path: { /** - * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. - * @example awesome + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - tag_id: components["parameters"]["tag_id"]; + check_id: components["parameters"]["check_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["check_updatable"]; + }; + }; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["existing_check"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27630,24 +31127,20 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - tags_assign_resources: { + uptime_delete_check: { parameters: { query?: never; header?: never; path: { - /** - * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. - * @example awesome + /** + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - tag_id: components["parameters"]["tag_id"]; + check_id: components["parameters"]["check_id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["tags_resource"]; - }; - }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; @@ -27657,26 +31150,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - tags_unassign_resources: { + uptime_get_checkState: { parameters: { query?: never; header?: never; path: { /** - * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. - * @example awesome + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - tag_id: components["parameters"]["tag_id"]; + check_id: components["parameters"]["check_id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["tags_resource"]; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["existing_check_state"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27684,19 +31173,9 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumes_list: { + uptime_list_alerts: { parameters: { query?: { - /** - * @description The block storage volume's name. - * @example example - */ - name?: components["parameters"]["volume_name"]; - /** - * @description The slug identifier for the region where the resource is available. - * @example nyc3 - */ - region?: components["parameters"]["region"]; /** * @description Number of items returned per page * @example 2 @@ -27709,33 +31188,53 @@ export interface operations { page?: components["parameters"]["page"]; }; header?: never; - path?: never; + path: { + /** + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + check_id: components["parameters"]["check_id"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["volumes"]; + 200: components["responses"]["all_alerts"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - volumes_create: { + uptime_create_alert: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + check_id: components["parameters"]["check_id"]; + }; cookie?: never; }; + /** @description The ''type'' field dictates the type of alert, and hence what type of value to pass into the threshold property. + * Type | Description | Threshold Value + * -----|-------------|-------------------- + * `latency` | alerts on the response latency | milliseconds + * `down` | alerts on a target registering as down in any region | N/A (Not required) + * `down_global` | alerts on a target registering as down globally | N/A (Not required) + * `ssl_expiry` | alerts on a SSL certificate expiring within $threshold days | days + * */ requestBody: { content: { - "application/json": components["schemas"]["volumes_ext4"] | components["schemas"]["volumes_xfs"]; + "application/json": components["schemas"]["alert"]; }; }; responses: { - 201: components["responses"]["volume"]; - 400: components["responses"]["bad_request"]; + 201: components["responses"]["existing_alert"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27743,27 +31242,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumes_delete_byName: { + uptime_get_alert: { parameters: { - query?: { + query?: never; + header?: never; + path: { /** - * @description The block storage volume's name. - * @example example + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - name?: components["parameters"]["volume_name"]; + check_id: components["parameters"]["check_id"]; /** - * @description The slug identifier for the region where the resource is available. - * @example nyc3 + * @description A unique identifier for an alert. + * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 */ - region?: components["parameters"]["region"]; + alert_id: components["parameters"]["parameters_alert_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["existing_alert"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27771,31 +31270,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeActions_post: { + uptime_update_alert: { parameters: { - query?: { + query?: never; + header?: never; + path: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - per_page?: components["parameters"]["per_page"]; + check_id: components["parameters"]["check_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A unique identifier for an alert. + * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 */ - page?: components["parameters"]["page"]; + alert_id: components["parameters"]["parameters_alert_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["volume_action_post_attach"] | components["schemas"]["volume_action_post_detach"]; + "application/json": WithRequired; }; }; responses: { - 202: components["responses"]["volumeAction"]; + 200: components["responses"]["existing_alert"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27803,22 +31302,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeSnapshots_get_byId: { + uptime_delete_alert: { parameters: { query?: never; header?: never; path: { /** - * @description The unique identifier for the snapshot. - * @example fbe805e8-866b-11e6-96bf-000f53315a41 + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - snapshot_id: components["parameters"]["volume_snapshot_id"]; + check_id: components["parameters"]["check_id"]; + /** + * @description A unique identifier for an alert. + * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 + */ + alert_id: components["parameters"]["parameters_alert_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["volumeSnapshot"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27826,22 +31330,43 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeSnapshots_delete_byId: { + genai_list_agents: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description The unique identifier for the snapshot. - * @example fbe805e8-866b-11e6-96bf-000f53315a41 + * @description Only list agents that are deployed. + * @example true */ - snapshot_id: components["parameters"]["volume_snapshot_id"]; + only_deployed?: boolean; + /** + * @description Page number. + * @example 1 + */ + page?: number; + /** + * @description Items per page. + * @example 1 + */ + per_page?: number; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiListAgentsOutputPublic"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27849,22 +31374,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumes_get: { + genai_create_agent: { parameters: { query?: never; header?: never; - path: { - /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 - */ - volume_id: components["parameters"]["volume_id"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiCreateAgentInputPublic"]; + }; + }; responses: { - 200: components["responses"]["volume"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiCreateAgentOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27872,22 +31406,44 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumes_delete: { + genai_list_agent_api_keys: { parameters: { - query?: never; + query?: { + /** + * @description Page number. + * @example 1 + */ + page?: number; + /** + * @description Items per page. + * @example 1 + */ + per_page?: number; + }; header?: never; path: { /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - volume_id: components["parameters"]["volume_id"]; + agent_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiListAgentAPIKeysOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27895,33 +31451,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeActions_list: { + genai_create_agent_api_key: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - volume_id: components["parameters"]["volume_id"]; + agent_uuid: string; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiCreateAgentAPIKeyInputPublic"]; + }; + }; responses: { - 200: components["responses"]["volumeActions"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiCreateAgentAPIKeyOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27929,37 +31489,81 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeActions_post_byId: { + genai_update_agent_api_key: { parameters: { - query?: { + query?: never; + header?: never; + path: { /** - * @description Number of items returned per page - * @example 2 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - per_page?: components["parameters"]["per_page"]; + agent_uuid: string; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description Api key id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - page?: components["parameters"]["page"]; + api_key_uuid: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["apiUpdateAgentAPIKeyInputPublic"]; }; + }; + responses: { + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiUpdateAgentAPIKeyOutput"]; + }; + }; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + genai_delete_agent_api_key: { + parameters: { + query?: never; header?: never; path: { /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 + * @description A unique identifier for your agent. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - volume_id: components["parameters"]["volume_id"]; + agent_uuid: string; + /** + * @description API key for an agent. + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + api_key_uuid: string; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["volume_action_post_attach"] | components["schemas"]["volume_action_post_detach"] | components["schemas"]["volume_action_post_resize"]; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["volumeAction"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiDeleteAgentAPIKeyOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27967,38 +31571,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeActions_get: { + genai_regenerate_agent_api_key: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - volume_id: components["parameters"]["volume_id"]; + agent_uuid: string; /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 + * @description Api key id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - action_id: components["parameters"]["action_id"]; + api_key_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["volumeAction"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiRegenerateAgentAPIKeyOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28006,33 +31610,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeSnapshots_list: { + genai_attach_agent_function: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - volume_id: components["parameters"]["volume_id"]; + agent_uuid: string; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiLinkAgentFunctionInputPublic"]; + }; + }; responses: { - 200: components["responses"]["volumeSnapshots"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiLinkAgentFunctionOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28040,37 +31648,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeSnapshots_create: { + genai_update_agent_function: { parameters: { query?: never; header?: never; path: { /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - volume_id: components["parameters"]["volume_id"]; + agent_uuid: string; + /** + * @description Function id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + function_uuid: string; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - /** @example { - * "name": "big-data-snapshot1475261774" - * } */ - "application/json": { - /** - * @description A human-readable name for the volume snapshot. - * @example big-data-snapshot1475261774 - */ - name: string; - tags?: components["schemas"]["tags_array"]; - }; + "application/json": components["schemas"]["apiUpdateAgentFunctionInputPublic"]; }; }; responses: { - 201: components["responses"]["volumeSnapshot"]; - 400: components["responses"]["bad_request"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiUpdateAgentFunctionOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28078,27 +31691,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_list: { + genai_detach_agent_function: { parameters: { - query?: { + query?: never; + header?: never; + path: { /** - * @description Number of items returned per page - * @example 2 + * @description The id of the agent the function route belongs to. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - per_page?: components["parameters"]["per_page"]; + agent_uuid: string; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description The function route to be destroyed. This does not destroy the function itself. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - page?: components["parameters"]["page"]; + function_uuid: string; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_vpcs"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiUnlinkAgentFunctionOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28106,42 +31730,77 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_create: { + genai_attach_knowledge_base: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": WithRequired & WithRequired; + path: { + /** + * @description A unique identifier for an agent. + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + agent_uuid: string; + /** + * @description A unique identifier for a knowledge base. + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + knowledge_base_uuid: string; }; + cookie?: never; }; + requestBody?: never; responses: { - 201: components["responses"]["existing_vpc"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiLinkKnowledgeBaseOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - vpcs_get: { + genai_detach_knowledge_base: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_id: components["parameters"]["vpc_id"]; + agent_uuid: string; + /** + * @description Knowledge base id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + knowledge_base_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_vpc"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiUnlinkKnowledgeBaseOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28149,26 +31808,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_update: { + genai_update_attached_agent: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description A unique identifier for the parent agent. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_id: components["parameters"]["vpc_id"]; + parent_agent_uuid: string; + /** + * @description Routed agent id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + child_agent_uuid: string; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": WithRequired & components["schemas"]["vpc_default"]; + "application/json": components["schemas"]["apiUpdateLinkedAgentInputPublic"]; }; }; responses: { - 200: components["responses"]["existing_vpc"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiUpdateLinkedAgentOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28176,22 +31851,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_delete: { + genai_attach_agent: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description A unique identifier for the parent agent. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_id: components["parameters"]["vpc_id"]; + parent_agent_uuid: string; + /** + * @description Routed agent id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + child_agent_uuid: string; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiLinkAgentInputPublic"]; + }; + }; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiLinkAgentOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28199,26 +31894,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_patch: { + genai_detach_agent: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Pagent agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_id: components["parameters"]["vpc_id"]; + parent_agent_uuid: string; + /** + * @description Routed agent id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + child_agent_uuid: string; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["vpc_updatable"] & components["schemas"]["vpc_default"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["existing_vpc"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiUnlinkAgentOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28226,38 +31933,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_list_members: { + genai_get_agent: { parameters: { - query?: { - /** - * @description Used to filter VPC members by a resource type. - * @example droplet - */ - resource_type?: components["parameters"]["vpc_resource_type"]; - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Unique agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_id: components["parameters"]["vpc_id"]; + uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["vpc_members"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiGetAgentOutputPublic"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28265,33 +31967,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_list_peerings: { + genai_update_agent: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Unique agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_id: components["parameters"]["vpc_id"]; + uuid: string; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiUpdateAgentInputPublic"]; + }; + }; responses: { - 200: components["responses"]["vpc_peerings"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiUpdateAgentOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28299,38 +32005,67 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_create_peerings: { + genai_delete_agent: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Unique agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_id: components["parameters"]["vpc_id"]; + uuid: string; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description The name of the VPC peering. Must be unique and may only contain alphanumeric characters, dashes, and periods. - * @example nyc1-blr1-peering - */ - name: string; - /** - * Format: uuid - * @description The ID of the VPC to peer with. - * @example c140286f-e6ce-4131-8b7b-df4590ce8d6a - */ - vpc_id: string; + requestBody?: never; + responses: { + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiDeleteAgentOutput"]; }; }; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + genai_get_agent_children: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid: string; + }; + cookie?: never; }; + requestBody?: never; responses: { - 202: components["responses"]["vpc_peering"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiGetChildrenOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28338,31 +32073,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_patch_peerings: { + genai_update_agent_deployment_visibility: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - vpc_id: components["parameters"]["vpc_id"]; - /** - * @description A unique identifier for a VPC peering. - * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @description Unique id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_peering_id: components["parameters"]["vpc_peering_id"]; + uuid: string; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": WithRequired; + "application/json": components["schemas"]["apiUpdateAgentDeploymentVisibilityInputPublic"]; }; }; responses: { - 200: components["responses"]["vpc_peering"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiUpdateAgentDeploymentVisbilityOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28370,24 +32111,19 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcPeerings_list: { + genai_list_indexing_jobs: { parameters: { query?: { /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. + * @description Page number. * @example 1 */ - page?: components["parameters"]["page"]; + page?: number; /** - * @description The slug identifier for the region where the resource is available. - * @example nyc3 + * @description Items per page. + * @example 1 */ - region?: components["parameters"]["region"]; + per_page?: number; }; header?: never; path?: never; @@ -28395,7 +32131,18 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_vpc_peerings"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiListKnowledgeBaseIndexingJobsOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28403,42 +32150,65 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcPeerings_create: { + genai_create_indexing_job: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": WithRequired & WithRequired; + "application/json": components["schemas"]["apiStartKnowledgeBaseIndexingJobInputPublic"]; }; }; responses: { - 202: components["responses"]["provisioning_vpc_peering"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiStartKnowledgeBaseIndexingJobOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - vpcPeerings_get: { + genai_list_indexing_job_data_sources: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC peering. - * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @description Uuid of the indexing job + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_peering_id: components["parameters"]["vpc_peering_id"]; + indexing_job_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["active_vpc_peering"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiListIndexingJobDataSourcesOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28446,22 +32216,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcPeerings_delete: { + genai_get_indexing_job: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC peering. - * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @description Indexing job id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_peering_id: components["parameters"]["vpc_peering_id"]; + uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["deleting_vpc_peering"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiGetKnowledgeBaseIndexingJobOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28469,26 +32250,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcPeerings_patch: { + genai_cancel_indexing_job: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC peering. - * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @description A unique identifier for an indexing job. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_peering_id: components["parameters"]["vpc_peering_id"]; + uuid: string; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": WithRequired; + "application/json": components["schemas"]["apiCancelKnowledgeBaseIndexingJobInputPublic"]; }; }; responses: { - 200: components["responses"]["active_vpc_peering"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiCancelKnowledgeBaseIndexingJobOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28496,19 +32288,19 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_list_checks: { + genai_list_knowledge_bases: { parameters: { query?: { /** - * @description Number of items returned per page - * @example 2 + * @description Page number. + * @example 1 */ - per_page?: components["parameters"]["per_page"]; + page?: number; /** - * @description Which 'page' of paginated results to return. + * @description Items per page. * @example 1 */ - page?: components["parameters"]["page"]; + per_page?: number; }; header?: never; path?: never; @@ -28516,7 +32308,18 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_checks"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiListKnowledgeBasesOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28524,42 +32327,76 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_create_check: { + genai_create_knowledge_base: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": WithRequired; + "application/json": components["schemas"]["apiCreateKnowledgeBaseInputPublic"]; }; }; responses: { - 201: components["responses"]["existing_check"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiCreateKnowledgeBaseOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - uptime_get_check: { + genai_list_knowledge_base_data_sources: { parameters: { - query?: never; + query?: { + /** + * @description Page number. + * @example 1 + */ + page?: number; + /** + * @description Items per page. + * @example 1 + */ + per_page?: number; + }; header?: never; path: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Knowledge base id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - check_id: components["parameters"]["check_id"]; + knowledge_base_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_check"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiListKnowledgeBaseDataSourcesOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28567,26 +32404,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_update_check: { + genai_create_knowledge_base_data_source: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Knowledge base id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - check_id: components["parameters"]["check_id"]; + knowledge_base_uuid: string; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["check_updatable"]; + "application/json": components["schemas"]["apiCreateKnowledgeBaseDataSourceInputPublic"]; }; }; responses: { - 200: components["responses"]["existing_check"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiCreateKnowledgeBaseDataSourceOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28594,45 +32442,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_delete_check: { + genai_delete_knowledge_base_data_source: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Knowledge base id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - check_id: components["parameters"]["check_id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - 204: components["responses"]["no_content"]; - 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - uptime_get_checkState: { - parameters: { - query?: never; - header?: never; - path: { + knowledge_base_uuid: string; /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Data source id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - check_id: components["parameters"]["check_id"]; + data_source_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_check_state"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiDeleteKnowledgeBaseDataSourceOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28640,33 +32481,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_list_alerts: { + genai_get_knowledge_base: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; - /** - * @description Which 'page' of paginated results to return. - * @example 1 - */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Knowledge base id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - check_id: components["parameters"]["check_id"]; + uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_alerts"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiGetKnowledgeBaseOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28674,34 +32515,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_create_alert: { + genai_update_knowledge_base: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Knowledge base id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - check_id: components["parameters"]["check_id"]; + uuid: string; }; cookie?: never; }; - /** @description The ''type'' field dictates the type of alert, and hence what type of value to pass into the threshold property. - * Type | Description | Threshold Value - * -----|-------------|-------------------- - * `latency` | alerts on the response latency | milliseconds - * `down` | alerts on a target registering as down in any region | N/A (Not required) - * `down_global` | alerts on a target registering as down globally | N/A (Not required) - * `ssl_expiry` | alerts on a SSL certificate expiring within $threshold days | days - * */ - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["alert"]; + "application/json": components["schemas"]["apiUpdateKnowledgeBaseInputPublic"]; }; }; responses: { - 201: components["responses"]["existing_alert"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiUpdateKnowledgeBaseOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28709,27 +32553,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_get_alert: { + genai_delete_knowledge_base: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - check_id: components["parameters"]["check_id"]; - /** - * @description A unique identifier for an alert. - * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 + * @description Knowledge base id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - alert_id: components["parameters"]["parameters_alert_id"]; + uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_alert"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiDeleteKnowledgeBaseOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28737,31 +32587,56 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_update_alert: { + genai_list_models: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Include only models defined for the listed usecases. + * + * - MODEL_USECASE_UNKNOWN: The use case of the model is unknown + * - MODEL_USECASE_AGENT: The model maybe used in an agent + * - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning + * - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models) + * - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails + * @example [ + * "MODEL_USECASE_UNKNOWN" + * ] */ - check_id: components["parameters"]["check_id"]; + usecases?: ("MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | "MODEL_USECASE_KNOWLEDGEBASE" | "MODEL_USECASE_GUARDRAIL")[]; /** - * @description A unique identifier for an alert. - * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 + * @description Only include models that are publicly available. + * @example true */ - alert_id: components["parameters"]["parameters_alert_id"]; + public_only?: boolean; + /** + * @description Page number. + * @example 1 + */ + page?: number; + /** + * @description Items per page. + * @example 1 + */ + per_page?: number; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": WithRequired; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["existing_alert"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiListModelsOutputPublic"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28769,27 +32644,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_delete_alert: { + genai_list_datacenter_regions: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Include datacenters that serve inference. + * @example true */ - check_id: components["parameters"]["check_id"]; + serves_inference?: boolean; /** - * @description A unique identifier for an alert. - * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 + * @description Include datacenters that are capable of running batch jobs. + * @example true */ - alert_id: components["parameters"]["parameters_alert_id"]; + serves_batch?: boolean; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["apiListRegionsOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; diff --git a/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml b/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml index d29ec984c..f5dfdfa43 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml +++ b/packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml @@ -291,6 +291,14 @@ tags: The Serverless Functions API currently only supports creating and managing namespaces. + + - name: GenAI Platform (Public Preview) + description: |- + **The GenAI Platform API is in [public preview](https://docs.digitalocean.com/platform/product-lifecycle/#public-preview) for select customers.** + + The API lets you build GPU-powered AI agents with pre-built or custom foundation models, function and agent routes, and RAG pipelines with knowledge bases. + + - name: Image Actions description: |- Image actions are commands that can be given to a DigitalOcean image. In @@ -1249,6 +1257,10 @@ paths: delete: $ref: 'resources/load_balancers/loadBalancers_delete.yml' + /v2/load_balancers/{lb_id}/cache: + delete: + $ref: 'resources/load_balancers/loadBalancers_delete_cache.yml' + /v2/load_balancers/{lb_id}/droplets: post: $ref: 'resources/load_balancers/loadBalancers_add_droplets.yml' @@ -1444,6 +1456,30 @@ paths: get: $ref: 'resources/monitoring/monitoring_get_lb_droplets_downtime.yml' + /v2/monitoring/metrics/droplet_autoscale/current_instances: + get: + $ref: 'resources/monitoring/monitoring_get_droplet_autoscale_current_instances.yml' + + /v2/monitoring/metrics/droplet_autoscale/target_instances: + get: + $ref: 'resources/monitoring/monitoring_get_droplet_autoscale_target_instances.yml' + + /v2/monitoring/metrics/droplet_autoscale/current_cpu_utilization: + get: + $ref: 'resources/monitoring/monitoring_get_droplet_autoscale_current_cpu_utilization.yml' + + /v2/monitoring/metrics/droplet_autoscale/target_cpu_utilization: + get: + $ref: 'resources/monitoring/monitoring_get_droplet_autoscale_target_cpu_utilization.yml' + + /v2/monitoring/metrics/droplet_autoscale/current_memory_utilization: + get: + $ref: 'resources/monitoring/monitoring_get_droplet_autoscale_current_memory_utilization.yml' + + /v2/monitoring/metrics/droplet_autoscale/target_memory_utilization: + get: + $ref: 'resources/monitoring/monitoring_get_droplet_autoscale_target_memory_utilization.yml' + /v2/monitoring/sinks/destinations: post: $ref: 'resources/monitoring/monitoring_create_destination.yml' @@ -1779,6 +1815,155 @@ paths: $ref: 'resources/uptime/delete_alert.yml' + + /v2/gen-ai/agents: + get: + $ref: 'resources/gen-ai/genai_list_agents.yml' + + post: + $ref: 'resources/gen-ai/genai_create_agent.yml' + + + /v2/gen-ai/agents/{agent_uuid}/api_keys: + get: + $ref: 'resources/gen-ai/genai_list_agent_api_keys.yml' + + post: + $ref: 'resources/gen-ai/genai_create_agent_api_key.yml' + + + /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}: + put: + $ref: 'resources/gen-ai/genai_update_agent_api_key.yml' + + delete: + $ref: 'resources/gen-ai/genai_delete_agent_api_key.yml' + + + /v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate: + put: + $ref: 'resources/gen-ai/genai_regenerate_agent_api_key.yml' + + + /v2/gen-ai/agents/{agent_uuid}/functions: + post: + $ref: 'resources/gen-ai/genai_attach_agent_function.yml' + + + /v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}: + delete: + $ref: 'resources/gen-ai/genai_detach_agent_function.yml' + + put: + $ref: 'resources/gen-ai/genai_update_agent_function.yml' + + + /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}: + delete: + $ref: 'resources/gen-ai/genai_detach_knowledge_base.yml' + + post: + $ref: 'resources/gen-ai/genai_attach_knowledge_base.yml' + + + /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}: + delete: + $ref: 'resources/gen-ai/genai_detach_agent.yml' + + post: + $ref: 'resources/gen-ai/genai_attach_agent.yml' + + put: + $ref: 'resources/gen-ai/genai_update_attached_agent.yml' + + + /v2/gen-ai/agents/{uuid}: + delete: + $ref: 'resources/gen-ai/genai_delete_agent.yml' + + get: + $ref: 'resources/gen-ai/genai_get_agent.yml' + + put: + $ref: 'resources/gen-ai/genai_update_agent.yml' + + + /v2/gen-ai/agents/{uuid}/child_agents: + get: + $ref: 'resources/gen-ai/genai_get_agent_children.yml' + + + /v2/gen-ai/agents/{uuid}/deployment_visibility: + put: + $ref: 'resources/gen-ai/genai_update_agent_deployment_visibility.yml' + + + /v2/gen-ai/indexing_jobs: + get: + $ref: 'resources/gen-ai/genai_list_indexing_jobs.yml' + + post: + $ref: 'resources/gen-ai/genai_create_indexing_job.yml' + + + /v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources: + get: + $ref: 'resources/gen-ai/genai_list_indexing_job_data_sources.yml' + + + /v2/gen-ai/indexing_jobs/{uuid}: + get: + $ref: 'resources/gen-ai/genai_get_indexing_job.yml' + + + /v2/gen-ai/indexing_jobs/{uuid}/cancel: + put: + $ref: 'resources/gen-ai/genai_cancel_indexing_job.yml' + + + /v2/gen-ai/knowledge_bases: + get: + $ref: 'resources/gen-ai/genai_list_knowledge_bases.yml' + + post: + $ref: 'resources/gen-ai/genai_create_knowledge_base.yml' + + + /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources: + post: + $ref: 'resources/gen-ai/genai_create_knowledge_base_data_source.yml' + + get: + $ref: 'resources/gen-ai/genai_list_knowledge_base_data_sources.yml' + + + /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}: + delete: + $ref: 'resources/gen-ai/genai_delete_knowledge_base_data_source.yml' + + + /v2/gen-ai/knowledge_bases/{uuid}: + get: + $ref: 'resources/gen-ai/genai_get_knowledge_base.yml' + + put: + $ref: 'resources/gen-ai/genai_update_knowledge_base.yml' + + delete: + $ref: 'resources/gen-ai/genai_delete_knowledge_base.yml' + + + /v2/gen-ai/models: + get: + $ref: 'resources/gen-ai/genai_list_models.yml' + + + /v2/gen-ai/regions: + get: + $ref: 'resources/gen-ai/genai_list_datacenter_regions.yml' + + + components: securitySchemes: bearer_auth: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_maintenance_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_maintenance_spec.yml index 2c8a92304..af01cb0b3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_maintenance_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_maintenance_spec.yml @@ -9,3 +9,7 @@ properties: type: boolean description: Indicates whether the app should be archived. Setting this to true implies that enabled is set to true. Note that this feature is currently in closed beta. example: true + offline_page_url: + type: string + description: A custom offline page to display when maintenance mode is enabled or the app is archived. + example: https://example.com/offline.html diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_get.yml index 70e0a9db1..31315d1d2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_get.yml @@ -38,4 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'firewall:read' + - 'reserved_ip:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_list.yml index a3ef73cb3..5747b0f62 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_list.yml @@ -37,4 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'firewall:read' + - 'reserved_ip:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_get.yml index 4a724e78a..88e0a33a5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_get.yml @@ -37,4 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'firewall:read' + - 'reserved_ip:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_list.yml index 109148593..ca9f59903 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_list.yml @@ -35,4 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'firewall:read' + - 'reserved_ip:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/definitions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/definitions.yml new file mode 100644 index 000000000..a0f707a0e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/definitions.yml @@ -0,0 +1,2665 @@ +apiAcceptAgreementOutput: + description: AcceptAgreementOutput Description + properties: + team_agreement: + $ref: '#/apiTeamAgreement' + type: object +apiAgent: + description: An Agent + properties: + anthropic_api_key: + $ref: '#/apiAnthropicAPIKeyInfo' + api_key_infos: + description: Api key infos + items: + $ref: '#/apiAgentAPIKeyInfo' + type: array + api_keys: + description: Api keys + items: + $ref: '#/apiAgentAPIKey' + type: array + chatbot: + $ref: '#/apiChatbot' + chatbot_identifiers: + description: Chatbot identifiers + items: + $ref: '#/apiAgentChatbotIdentifier' + type: array + child_agents: + description: Child agents + items: + $ref: '#/apiAgent' + type: array + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + deployment: + $ref: '#/apiDeployment' + description: + description: Description of agent + example: '"example string"' + type: string + functions: + items: + $ref: '#/apiAgentFunction' + type: array + guardrails: + description: The guardrails the agent is attached to + items: + $ref: '#/apiAgentGuardrail' + type: array + if_case: + example: '"example string"' + type: string + instruction: + description: Agent instruction. Instructions help your agent to perform its + job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) + for best practices. + example: '"example string"' + type: string + k: + example: 123 + format: int64 + type: integer + knowledge_bases: + description: Knowledge bases + items: + $ref: '#/apiKnowledgeBase' + type: array + max_tokens: + example: 123 + format: int64 + type: integer + model: + $ref: '#/apiModel' + name: + description: Agent name + example: '"example name"' + type: string + parent_agents: + description: Parent agents + items: + $ref: '#/apiAgent' + type: array + project_id: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + region: + description: Region code + example: '"example string"' + type: string + route_created_at: + description: Creation of route date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + route_created_by: + example: '"12345"' + format: uint64 + type: string + route_name: + description: Route name + example: '"example name"' + type: string + route_uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + tags: + description: Agent tag to organize related resources + example: + - example string + items: + example: '"example string"' + type: string + type: array + temperature: + example: 123 + format: float + type: number + template: + $ref: '#/apiAgentTemplate' + top_p: + example: 123 + format: float + type: number + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + url: + description: Access your agent under this url + example: '"example string"' + type: string + user_id: + description: Id of user that created the agent + example: '"12345"' + format: uint64 + type: string + uuid: + description: Unique agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiAgentAPIKey: + description: Agent API Key + properties: + api_key: + description: Api key + example: '"example string"' + type: string + type: object +apiAgentAPIKeyInfo: + description: Agent API Key Info + properties: + created_at: + description: Creation date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_by: + description: Created by + example: '"12345"' + format: uint64 + type: string + deleted_at: + description: Deleted date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + name: + description: Name + example: '"example name"' + type: string + secret_key: + example: '"example string"' + type: string + uuid: + description: Uuid + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiAgentChatbotIdentifier: + description: Agent Chatbot Identifier + properties: + agent_chatbot_identifier: + description: Agent chatbot identifier + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiAgentFunction: + description: Description missing + properties: + api_key: + description: Api key + example: '"example string"' + type: string + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + description: + description: Agent description + example: '"example string"' + type: string + faas_name: + example: '"example name"' + type: string + faas_namespace: + example: '"example name"' + type: string + input_schema: + type: object + name: + description: Name + example: '"example name"' + type: string + output_schema: + type: object + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + url: + description: Download your agent here + example: '"example string"' + type: string + uuid: + description: Unique id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiAgentGuardrail: + description: A Agent Guardrail + properties: + agent_uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + created_at: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + default_response: + example: '"example string"' + type: string + description: + example: '"example string"' + type: string + guardrail_uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + is_attached: + example: true + type: boolean + is_default: + example: true + type: boolean + metadata: + type: object + name: + example: '"example name"' + type: string + priority: + example: 123 + format: int32 + type: integer + type: + $ref: '#/apiGuardrailType' + updated_at: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiAgentModelUsage: + properties: + agent_name: + description: Agent name + example: '"example name"' + type: string + agent_uuid: + description: Agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + requests_used: + description: Requests used + example: '"12345"' + format: uint64 + type: string + tokens_used: + description: Tokens used + example: '"12345"' + format: uint64 + type: string + type: object +apiAgentPrice: + properties: + attributes: + items: + $ref: '#/apiBillingAttribute' + type: array + display_name: + example: '"example name"' + type: string + model_uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + prices: + items: + $ref: '#/apiBillingPrice' + type: array + type: object +apiAgentPublic: + description: A GenAI Agent's configuration + properties: + chatbot: + $ref: '#/apiChatbot' + chatbot_identifiers: + description: Chatbot identifiers + items: + $ref: '#/apiAgentChatbotIdentifier' + type: array + created_at: + description: Creation date / time + example: "2021-01-01T00:00:00Z" + format: date-time + type: string + deployment: + $ref: '#/apiDeployment' + description: + description: Description of agent + example: This is a chatbot that can help you with your questions. + type: string + if_case: + description: Instructions to the agent on how to use the route + example: if talking about the weather use this route + type: string + instruction: + description: Agent instruction. Instructions help your agent to perform its + job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) + for best practices. + example: Hello, how can I help you? + type: string + k: + description: How many results should be considered from an attached knowledge + base + example: 5 + format: int64 + type: integer + max_tokens: + description: Specifies the maximum number of tokens the model can process in + a single input or output, set as a number between 1 and 512. This determines + the length of each response. + example: 100 + format: int64 + type: integer + model: + $ref: '#/apiModel' + name: + description: Agent name + example: My Agent + type: string + project_id: + description: The DigitalOcean project ID associated with the agent + example: 12345678-1234-1234-1234-123456789012 + type: string + region: + description: Region code + example: '"tor1"' + type: string + route_created_at: + description: Creation of route date / time + example: "2021-01-01T00:00:00Z" + format: date-time + type: string + route_created_by: + description: Id of user that created the route + example: "12345678" + format: uint64 + type: string + route_name: + description: Route name + example: Route Name + type: string + route_uuid: + description: Route uuid + example: '"12345678-1234-1234-1234-123456789012"' + type: string + tags: + description: A set of abitrary tags to organize your agent + example: + - example string + items: + example: '"example string"' + type: string + type: array + temperature: + description: Controls the model’s creativity, specified as a number between + 0 and 1. Lower values produce more predictable and conservative responses, + while higher values encourage creativity and variation. + example: 0.5 + format: float + type: number + template: + $ref: '#/apiAgentTemplate' + top_p: + description: Defines the cumulative probability threshold for word selection, + specified as a number between 0 and 1. Higher values allow for more diverse + outputs, while lower values ensure focused and coherent responses. + example: 0.9 + format: float + type: number + updated_at: + description: Last modified + example: "2021-01-01T00:00:00Z" + format: date-time + type: string + url: + description: Access your agent under this url + example: https://example.com/agent + type: string + user_id: + description: Id of user that created the agent + example: "12345678" + format: uint64 + type: string + uuid: + description: Unique agent id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + type: object +apiAgentTemplate: + description: Represents an AgentTemplate entity + properties: + created_at: + description: The agent template's creation date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + description: + description: Description of the agent template + example: '"example string"' + type: string + instruction: + description: Instructions for the agent template + example: '"example string"' + type: string + k: + description: The 'k' value for the agent template + example: 123 + format: int64 + type: integer + knowledge_bases: + description: List of knowledge bases associated with the agent template + items: + $ref: '#/apiKnowledgeBase' + type: array + max_tokens: + description: The max_tokens setting for the agent template + example: 123 + format: int64 + type: integer + model: + $ref: '#/apiModel' + name: + description: Name of the agent template + example: '"example name"' + type: string + temperature: + description: The temperature setting for the agent template + example: 123 + format: float + type: number + top_p: + description: The top_p setting for the agent template + example: 123 + format: float + type: number + updated_at: + description: The agent template's last updated date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + description: Unique id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiAgreement: + description: Agreement Description + properties: + description: + example: '"example string"' + type: string + name: + example: '"example name"' + type: string + url: + example: '"example string"' + type: string + uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiAnthropicAPIKeyInfo: + description: Anthropic API Key Info + properties: + created_at: + description: Key creation date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_by: + description: Created by user id from DO + example: '"12345"' + format: uint64 + type: string + deleted_at: + description: Key deleted date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + name: + description: Name + example: '"example name"' + type: string + updated_at: + description: Key last updated date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + description: Uuid + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiAuditHeader: + description: An alternative way to provide auth information. for internal use only. + properties: + actor_id: + example: '"12345"' + format: uint64 + type: string + actor_ip: + example: '"example string"' + type: string + actor_uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + context_urn: + example: '"example string"' + type: string + origin_application: + example: '"example string"' + type: string + user_id: + example: '"12345"' + format: uint64 + type: string + user_uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiBatchJobPhase: + default: BATCH_JOB_PHASE_UNKNOWN + enum: + - BATCH_JOB_PHASE_UNKNOWN + - BATCH_JOB_PHASE_PENDING + - BATCH_JOB_PHASE_RUNNING + - BATCH_JOB_PHASE_SUCCEEDED + - BATCH_JOB_PHASE_FAILED + - BATCH_JOB_PHASE_ERROR + example: BATCH_JOB_PHASE_UNKNOWN + type: string +apiBillingAttribute: + properties: + name: + example: '"example name"' + type: string + value: + example: '"example string"' + type: string + type: object +apiBillingPrice: + properties: + rate: + example: '"example string"' + type: string + region: + example: '"example string"' + type: string + type: object +apiCancelKnowledgeBaseIndexingJobInputPublic: + description: CancelKnowledgeBaseIndexingJobInputPublic description + properties: + uuid: + description: A unique identifier for an indexing job. + example: '"12345678-1234-1234-1234-123456789012"' + type: string + type: object +apiCancelKnowledgeBaseIndexingJobOutput: + description: CancelKnowledgeBaseIndexingJobOutput description + properties: + job: + $ref: '#/apiIndexingJob' + type: object +apiChatbot: + description: A Chatbot + properties: + button_background_color: + example: '"example string"' + type: string + logo: + example: '"example string"' + type: string + name: + description: Name of chatbot + example: '"example name"' + type: string + primary_color: + example: '"example string"' + type: string + secondary_color: + example: '"example string"' + type: string + starting_message: + example: '"example string"' + type: string + type: object +apiCreateAgentAPIKeyInputPublic: + properties: + agent_uuid: + description: Agent id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + name: + description: A human friendly name to identify the key + example: Production Key + type: string + type: object +apiCreateAgentAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiAgentAPIKeyInfo' + type: object +apiCreateAgentFromTemplateInputPublic: + properties: + project_id: + example: '"12345678-1234-1234-1234-123456789012"' + region: + example: '"tor1"' + template_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiCreateAgentFromTemplateOutput: + properties: + agent: + $ref: '#/apiAgent' + type: object +apiCreateAgentInputPublic: + description: Parameters for Agent Creation + properties: + description: + description: A text description of the agent, not used in inference + example: '"My Agent Description"' + type: string + instruction: + description: Agent instruction. Instructions help your agent to perform its + job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) + for best practices. + example: '"You are an agent who thinks deeply about the world"' + type: string + knowledge_base_uuid: + description: Ids of the knowledge base(s) to attach to the agent + example: + - example string + items: + example: '"example string"' + type: string + type: array + model_uuid: + description: Identifier for the foundation model. + example: '"12345678-1234-1234-1234-123456789012"' + type: string + name: + description: Agent name + example: '"My Agent"' + type: string + project_id: + description: The id of the DigitalOcean project this agent will belong to + example: '"12345678-1234-1234-1234-123456789012"' + type: string + region: + description: The DigitalOcean region to deploy your agent in + example: '"tor1"' + type: string + tags: + description: Agent tag to organize related resources + example: + - example string + items: + example: '"example string"' + type: string + type: array + type: object +apiCreateAgentOutput: + description: Information about a newly created Agent + properties: + agent: + $ref: '#/apiAgent' + type: object +apiCreateAnthropicAPIKeyOutput: + description: CreateAnthropicAPIKeyOutput is used to return the newly created Anthropic + API key. + properties: + api_key_info: + $ref: '#/apiAnthropicAPIKeyInfo' + type: object +apiCreateChatbotInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiCreateChatbotOutput: + description: Info about a newly created chatbot + properties: + chatbot: + $ref: '#/apiChatbot' + type: object +apiCreateDataSourceFileUploadPresignedUrlsOutput: + description: Response with pre-signed urls to upload files. + properties: + request_id: + description: The ID generated for the request for Presigned URLs. + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + uploads: + description: A list of generated presigned URLs and object keys, one per file. + items: + $ref: '#/apiFilePresignedUrlResponse' + type: array + type: object +apiCreateGuardrailOutput: + description: CreateGuardrailOutput description + properties: + guardrail: + $ref: '#/apiGuardrail' + type: object +apiCreateKnowledgeBaseDataSourceInputPublic: + description: Data to create a knowledge base data source + properties: + file_upload_data_source: + $ref: '#/apiFileUploadDataSource' + knowledge_base_uuid: + description: Knowledge base id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + spaces_data_source: + $ref: '#/apiSpacesDataSource' + type: object +apiCreateKnowledgeBaseDataSourceOutput: + description: Information about a newly created knowldege base data source + properties: + knowledge_base_data_source: + $ref: '#/apiKnowledgeBaseDataSource' + type: object +apiCreateKnowledgeBaseInputPublic: + description: Data to create a new knowledge base. + properties: + database_id: + description: |- + Identifier of the DigitalOcean OpenSearch database this knowledge base will use, optional. + If not provided, we create a new database for the knowledge base in + the same region as the knowledge base. + example: '"12345678-1234-1234-1234-123456789012"' + type: string + datasources: + description: The data sources to use for this knowledge base. See [Organize + Data Sources](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#spaces-buckets) + for more information on data sources best practices. + items: + $ref: '#/apiKBDataSource' + type: array + embedding_model_uuid: + description: Identifier for the [embedding model](https://docs.digitalocean.com/products/genai-platform/details/models/#embedding-models). + example: '"12345678-1234-1234-1234-123456789012"' + type: string + name: + description: Name of the knowledge base. + example: '"My Knowledge Base"' + type: string + project_id: + description: Identifier of the DigitalOcean project this knowledge base will + belong to. + example: '"12345678-1234-1234-1234-123456789012"' + type: string + region: + description: The datacenter region to deploy the knowledge base in. + example: '"tor1"' + type: string + tags: + description: Tags to organize your knowledge base. + example: + - example string + items: + example: '"example string"' + type: string + type: array + vpc_uuid: + description: The VPC to deploy the knowledge base database in + example: '"12345678-1234-1234-1234-123456789012"' + type: string + type: object +apiCreateKnowledgeBaseOutput: + description: Information about a newly created knowledge base + properties: + knowledge_base: + $ref: '#/apiKnowledgeBase' + type: object +apiCreateModelOutput: + description: Information about a newly created model + properties: + model: + $ref: '#/apiModel' + type: object +apiDeleteAgentAPIKeyInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteAgentAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiAgentAPIKeyInfo' + type: object +apiDeleteAgentInputPublic: + properties: + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteAgentOutput: + description: Info about a deleted agent + properties: + agent: + $ref: '#/apiAgent' + type: object +apiDeleteAnthropicAPIKeyOutput: + description: DeleteAnthropicAPIKeyOutput is used to return the deleted Anthropic + API key. + properties: + api_key_info: + $ref: '#/apiAnthropicAPIKeyInfo' + type: object +apiDeleteChatbotInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteChatbotOutput: + description: Information about a delete chatbot + properties: + agent_uuid: + description: Agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiDeleteGuardrailOutput: + description: DeleteGuardrailOutput description + properties: + uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiDeleteKnowledgeBaseDataSourceInputPublic: + properties: + data_source_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + knowledge_base_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteKnowledgeBaseDataSourceOutput: + description: Information about a newly deleted knowledge base data source + properties: + data_source_uuid: + description: Data source id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + knowledge_base_uuid: + description: Knowledge base id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiDeleteKnowledgeBaseInputPublic: + properties: + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteKnowledgeBaseOutput: + description: Information about a deleted knowledge base + properties: + uuid: + description: The id of the deleted knowledge base + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiDeployment: + description: Description of deployment + properties: + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + name: + description: Name + example: '"example name"' + type: string + status: + $ref: '#/apiDeploymentStatus' + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + url: + description: Access your deployed agent here + example: '"example string"' + type: string + uuid: + description: Unique id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + visibility: + $ref: '#/apiDeploymentVisibility' + type: object +apiDeploymentStatus: + default: STATUS_UNKNOWN + enum: + - STATUS_UNKNOWN + - STATUS_WAITING_FOR_DEPLOYMENT + - STATUS_DEPLOYING + - STATUS_RUNNING + - STATUS_FAILED + - STATUS_WAITING_FOR_UNDEPLOYMENT + - STATUS_UNDEPLOYING + - STATUS_UNDEPLOYMENT_FAILED + - STATUS_DELETED + example: STATUS_UNKNOWN + type: string +apiDeploymentVisibility: + default: VISIBILITY_UNKNOWN + description: |- + - VISIBILITY_UNKNOWN: The status of the deployment is unknown + - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests + - VISIBILITY_PLAYGROUND: Deprecated: No longer a valid state + - VISIBILITY_PUBLIC: The deployment is public and will service requests from the public internet + - VISIBILITY_PRIVATE: The deployment is private and will only service requests from other agents, or through API keys + enum: + - VISIBILITY_UNKNOWN + - VISIBILITY_DISABLED + - VISIBILITY_PLAYGROUND + - VISIBILITY_PUBLIC + - VISIBILITY_PRIVATE + example: VISIBILITY_UNKNOWN + type: string +apiFilePresignedUrlResponse: + description: Detailed info about each presigned URL returned to the client. + properties: + expires_at: + description: The time the url expires at. + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + object_key: + description: The unique object key to store the file as. + example: '"example string"' + type: string + original_file_name: + description: The original file name. + example: '"example name"' + type: string + presigned_url: + description: The actual presigned URL the client can use to upload the file + directly. + example: '"example string"' + type: string + type: object +apiFileUploadDataSource: + description: File to upload as data source for knowledge base. + properties: + original_file_name: + description: The original file name + example: '"example name"' + type: string + size_in_bytes: + description: The size of the file in bytes + example: '"12345"' + format: uint64 + type: string + stored_object_key: + description: The object key the file was stored as + example: '"example string"' + type: string + type: object +apiGetAgentInputPublic: + properties: + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetAgentOutput: + description: One Agent + properties: + agent: + $ref: '#/apiAgent' + type: object +apiGetAgentOutputPublic: + description: One Agent + properties: + agent: + $ref: '#/apiAgentPublic' + type: object +apiGetAgentTemplateInputPublic: + properties: + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetAgentTemplateOutput: + properties: + template: + $ref: '#/apiAgentTemplate' + type: object +apiGetAgentUsageInputPublic: + properties: + start: + example: '"2021-01-01T00:00:00Z"' + stop: + example: '"2021-01-02T00:00:00Z"' + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetAgentUsageOutput: + description: Agent usage + properties: + usage: + $ref: '#/apiResourceUsage' + type: object +apiGetAnthropicAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiAnthropicAPIKeyInfo' + type: object +apiGetChildrenInputPublic: + properties: + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetChildrenOutput: + description: Child list for an agent + properties: + children: + description: Child agents + items: + $ref: '#/apiAgent' + type: array + type: object +apiGetGuardrailOutput: + properties: + guardrail: + $ref: '#/apiGuardrail' + type: object +apiGetGuardrailUsageOutput: + description: Guardrail usage output + properties: + usage: + $ref: '#/apiResourceUsage' + type: object +apiGetKnowledgeBaseIndexingJobInputPublic: + properties: + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetKnowledgeBaseIndexingJobOutput: + description: GetKnowledgeBaseIndexingJobOutput description + properties: + job: + $ref: '#/apiIndexingJob' + type: object +apiGetKnowledgeBaseIndexingJobUsageInputPublic: + properties: + start: + example: '"2021-01-01T00:00:00Z"' + stop: + example: '"2021-01-02T00:00:00Z"' + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetKnowledgeBaseIndexingJobUsageOutput: + description: Knowledge base indexing job usage + properties: + usage: + $ref: '#/apiResourceUsage' + type: object +apiGetKnowledgeBaseInputPublic: + properties: + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetKnowledgeBaseOutput: + description: The knowledge base + properties: + database_status: + $ref: '#/dbaasClusterStatus' + knowledge_base: + $ref: '#/apiKnowledgeBase' + type: object +apiGetModelInputPublic: + properties: + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetModelOutput: + description: A specific model + properties: + model: + $ref: '#/apiModel' + type: object +apiGetModelPlaygroundTokensInputPublic: + properties: + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetModelPlaygroundTokensOutput: + description: GetModelPlaygroundTokensOutput description + properties: + token_limit_per_day: + description: Daily token limit + example: '"12345"' + format: uint64 + type: string + tokens_remaining: + description: Tokens remaining + example: 123 + format: int64 + type: integer + type: object +apiGetModelUsageInputPublic: + properties: + start: + example: '"2021-01-01T00:00:00Z"' + stop: + example: '"2021-01-02T00:00:00Z"' + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetModelUsageOutput: + description: Information about model usage + properties: + usage: + $ref: '#/apiResourceUsage' + type: object +apiGetModelVersionsInputPublic: + properties: + name: + example: '"My Model"' +apiGetPreferredRegionOutput: + description: Region code of preferred Regions + properties: + region: + $ref: '#/genaiapiRegion' + type: object +apiGetResourceLimitsOutput: + properties: + agent_count: + description: Total agents used + example: 123 + format: int64 + type: integer + agent_limit: + description: Total permitted agents + example: 123 + format: int64 + type: integer + guardrail_count: + description: Total guardrails used + example: 123 + format: int64 + type: integer + guardrail_limit: + description: Total permitted guardrails + example: 123 + format: int64 + type: integer + knowledge_base_count: + description: Total knowledge bases used + example: 123 + format: int64 + type: integer + knowledge_base_limit: + description: Total permitted knowledge bases + example: 123 + format: int64 + type: integer + type: object +apiGetTeamAgreementOutput: + description: GetTeamAgreementOutput Output + properties: + team_agreement: + $ref: '#/apiTeamAgreement' + type: object +apiGuardrail: + description: Guardrail description + properties: + agent_uuids: + description: List of attached agents uuids + example: + - example string + items: + example: '"example string"' + type: string + type: array + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + default_response: + example: '"example string"' + type: string + description: + example: '"example string"' + type: string + is_default: + example: true + type: boolean + metadata: + type: object + name: + example: '"example name"' + type: string + template_uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: + $ref: '#/apiGuardrailType' + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiGuardrailPrice: + properties: + attributes: + items: + $ref: '#/apiBillingAttribute' + type: array + display_name: + example: '"example name"' + type: string + guardrail_template_uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + prices: + items: + $ref: '#/apiBillingPrice' + type: array + type: object +apiGuardrailTemplate: + description: GuardrailTemplate description + properties: + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + default_response: + example: '"example string"' + type: string + description: + example: '"example string"' + type: string + metadata: + type: object + name: + example: '"example name"' + type: string + type: + $ref: '#/apiGuardrailType' + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiGuardrailType: + default: GUARDRAIL_TYPE_UNKNOWN + enum: + - GUARDRAIL_TYPE_UNKNOWN + - GUARDRAIL_TYPE_JAILBREAK + - GUARDRAIL_TYPE_SENSITIVE_DATA + - GUARDRAIL_TYPE_CONTENT_MODERATION + example: GUARDRAIL_TYPE_UNKNOWN + type: string +apiIndexedDataSource: + properties: + completed_at: + description: Timestamp when data source completed indexing + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + data_source_uuid: + description: Uuid of the indexed data source + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + indexed_file_count: + description: Total count of files that have been indexed + example: '"12345"' + format: uint64 + type: string + started_at: + description: Timestamp when data source started indexing + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + total_bytes: + description: Total size of files in data source in bytes + example: '"12345"' + format: uint64 + type: string + total_bytes_indexed: + description: Total size of files in data source in bytes that have been indexed + example: '"12345"' + format: uint64 + type: string + total_file_count: + description: Total file count in the data source + example: '"12345"' + format: uint64 + type: string + type: object +apiIndexingJob: + description: IndexingJob description + properties: + completed_datasources: + description: Number of datasources indexed completed + example: 123 + format: int64 + type: integer + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + data_source_uuids: + example: + - example string + items: + example: '"example string"' + type: string + type: array + finished_at: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + knowledge_base_uuid: + description: Knowledge base id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + phase: + $ref: '#/apiBatchJobPhase' + started_at: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + tokens: + description: Number of tokens + example: 123 + format: int64 + type: integer + total_datasources: + description: Number of datasources being indexed + example: 123 + format: int64 + type: integer + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + description: Unique id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiIssueAgentTokenInputPublic: + description: Input for issuing a token for an agent + properties: + agent_uuid: + description: Agent ID + example: '"12345678-1234-1234-1234-123456789012"' + type: string + type: object +apiIssueAgentTokenOutput: + description: Information about a newly issued token + properties: + access_token: + description: The token + example: '"example string"' + type: string + refresh_token: + description: The token used to refresh + example: '"example string"' + type: string + type: object +apiIssueModelPlaygroundTokenOutput: + description: IssueModelPlaygroundTokenOutput description + properties: + access_token: + example: '"example string"' + type: string + refresh_token: + example: '"example string"' + type: string + type: object +apiKBDataSource: + properties: + bucket_name: + description: Deprecated, moved to data_source_details + example: '"example name"' + type: string + bucket_region: + description: Deprecated, moved to data_source_details + example: '"example string"' + type: string + file_upload_data_source: + $ref: '#/apiFileUploadDataSource' + item_path: + example: '"example string"' + type: string + spaces_data_source: + $ref: '#/apiSpacesDataSource' + type: object +apiKnowledgeBase: + description: Knowledgebase Description + properties: + added_to_agent_at: + description: Time when the knowledge base was added to the agent + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + database_id: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + embedding_model_uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + is_public: + description: Whether the knowledge base is public or not + example: true + type: boolean + last_indexing_job: + $ref: '#/apiIndexingJob' + name: + description: Name of knowledge base + example: '"example name"' + type: string + project_id: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + region: + description: Region code + example: '"example string"' + type: string + tags: + description: Tags to organize related resources + example: + - example string + items: + example: '"example string"' + type: string + type: array + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + user_id: + description: Id of user that created the knowledge base + example: '"12345"' + format: int64 + type: string + uuid: + description: Unique id for knowledge base + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiKnowledgeBaseDataSource: + description: Data Source configuration for Knowledge Bases + properties: + bucket_name: + description: Name of storage bucket - Deprecated, moved to data_source_details + example: '"example name"' + type: string + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + file_upload_data_source: + $ref: '#/apiFileUploadDataSource' + item_path: + description: Path of folder or object in bucket - Deprecated, moved to data_source_details + example: '"example string"' + type: string + last_indexing_job: + $ref: '#/apiIndexingJob' + region: + description: Region code - Deprecated, moved to data_source_details + example: '"example string"' + type: string + spaces_data_source: + $ref: '#/apiSpacesDataSource' + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + description: Unique id of knowledge base + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiKnowledgeBasePrice: + properties: + attributes: + items: + $ref: '#/apiBillingAttribute' + type: array + display_name: + example: '"example name"' + type: string + model_uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + prices: + items: + $ref: '#/apiBillingPrice' + type: array + type: object +apiLinkAgentFunctionInputPublic: + description: Information for a agent function link + properties: + agent_uuid: + description: Agent id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + description: + description: Function description + example: '"My Function Description"' + type: string + faas_name: + description: The name of the function in the DigitalOcean functions platform + example: '"my-function"' + type: string + faas_namespace: + description: The namespace of the function in the DigitalOcean functions platform + example: '"default"' + type: string + function_name: + description: Function name + example: '"My Function"' + type: string + input_schema: + description: Describe the input schema for the function so the agent may call + it + type: object + output_schema: + description: Describe the output schema for the function so the agent handle + its response + type: object + type: object +apiLinkAgentFunctionOutput: + description: Information about a newly function linked agent + properties: + agent: + $ref: '#/apiAgent' + type: object +apiLinkAgentGuardrailOutput: + description: Information about an updated agent + properties: + agent: + $ref: '#/apiAgent' + type: object +apiLinkAgentInputPublic: + description: Information for linking an agent + properties: + child_agent_uuid: + description: Routed agent id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + if_case: + example: '"use this to get weather information"' + type: string + parent_agent_uuid: + description: A unique identifier for the parent agent. + example: '"12345678-1234-1234-1234-123456789012"' + type: string + route_name: + description: Name of route + example: '"weather_route"' + type: string + type: object +apiLinkAgentOutput: + description: Information about a newly linked agent + properties: + child_agent_uuid: + description: Routed agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + parent_agent_uuid: + description: A unique identifier for the parent agent. + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiLinkKnowledgeBaseInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + knowledge_base_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiLinkKnowledgeBaseOutput: + description: Information about a linked knowledge base + properties: + agent: + $ref: '#/apiAgent' + type: object +apiLinks: + description: Links to other pages + properties: + pages: + $ref: '#/apiPages' + type: object +apiListAgentAPIKeysInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + page: + example: "1" + per_page: + example: "20" +apiListAgentAPIKeysOutput: + properties: + api_key_infos: + description: Api key infos + items: + $ref: '#/apiAgentAPIKeyInfo' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListAgentPricesOutput: + properties: + agent_prices: + items: + $ref: '#/apiAgentPrice' + type: array + type: object +apiListAgentTemplatesInputPublic: + properties: + page: + example: "1" + per_page: + example: "20" +apiListAgentTemplatesOutput: + properties: + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + templates: + items: + $ref: '#/apiAgentTemplate' + type: array + type: object +apiListAgentsByAnthropicKeyOutput: + description: List of Agents that linked to a specific Anthropic Key + properties: + agents: + items: + $ref: '#/apiAgent' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListAgentsInputPublic: + properties: + only_deployed: + example: "true" + page: + example: "1" + per_page: + example: "20" +apiListAgentsOutput: + description: List of Agents + properties: + agents: + description: Agents + items: + $ref: '#/apiAgent' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListAgentsOutputPublic: + description: List of Agents + properties: + agents: + description: Agents + items: + $ref: '#/apiAgentPublic' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListAnthropicAPIKeysOutput: + description: ListAnthropicAPIKeysOutput is used to return the list of Anthropic + API keys for a specific agent. + properties: + api_key_infos: + description: Api key infos + items: + $ref: '#/apiAnthropicAPIKeyInfo' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListGuardrailAgentsOutput: + properties: + agents: + items: + $ref: '#/apiAgent' + type: array + type: object +apiListGuardrailPricesOutput: + properties: + guardrail_prices: + items: + $ref: '#/apiGuardrailPrice' + type: array + type: object +apiListGuardrailTemplatesOutput: + description: ListGuardrailTemplatesOutput description + properties: + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + templates: + items: + $ref: '#/apiGuardrailTemplate' + type: array + type: object +apiListGuardrailsOutput: + description: ListGuardrailsOutput description + properties: + guardrails: + items: + $ref: '#/apiGuardrail' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListIndexingJobDataSourcesInputPublic: + properties: + indexing_job_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiListIndexingJobDataSourcesOutput: + properties: + indexed_data_sources: + items: + $ref: '#/apiIndexedDataSource' + type: array + type: object +apiListKnowledgeBaseAgentsInputPublic: + properties: + knowledge_base_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiListKnowledgeBaseAgentsOutput: + description: List of agents + properties: + agents: + description: The agents + items: + $ref: '#/apiAgent' + type: array + type: object +apiListKnowledgeBaseDataSourcesInputPublic: + properties: + knowledge_base_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + page: + example: "1" + per_page: + example: "20" +apiListKnowledgeBaseDataSourcesOutput: + description: A list of knowledge base data sources + properties: + knowledge_base_data_sources: + description: The data sources + items: + $ref: '#/apiKnowledgeBaseDataSource' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListKnowledgeBaseIndexingJobsInputPublic: + properties: + page: + example: "1" + per_page: + example: "20" +apiListKnowledgeBaseIndexingJobsOutput: + description: Indexing jobs + properties: + jobs: + description: The indexing jobs + items: + $ref: '#/apiIndexingJob' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListKnowledgeBasePricesOutput: + properties: + knowledge_base_prices: + items: + $ref: '#/apiKnowledgeBasePrice' + type: array + type: object +apiListKnowledgeBasesInputPublic: + properties: + page: + example: "1" + per_page: + example: "20" +apiListKnowledgeBasesOutput: + description: List of knowledge bases + properties: + knowledge_bases: + description: The knowledge bases + items: + $ref: '#/apiKnowledgeBase' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListModelPricesOutput: + properties: + model_prices: + items: + $ref: '#/apiModelPrice' + type: array + type: object +apiListModelUsagesByAgentOutput: + description: ListModelUsagesByAgentOutput description + properties: + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + request_limit_per_minute: + description: Total request limit per minute + example: '"12345"' + format: uint64 + type: string + token_limit_per_day: + description: Total token limit per day + example: '"12345"' + format: uint64 + type: string + token_limit_per_minute: + description: Total token limit per minute + example: '"12345"' + format: uint64 + type: string + usages: + description: The model's usage by agent + items: + $ref: '#/apiAgentModelUsage' + type: array + type: object +apiListModelsInputPublic: + properties: + page: + example: "1" + per_page: + example: "20" + public_only: + example: "true" + usecases: + example: AGENT +apiListModelsOutput: + description: A list of models + properties: + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + models: + description: The models + items: + $ref: '#/apiModel' + type: array + type: object +apiListModelsOutputPublic: + description: A list of models + properties: + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + models: + description: The models + items: + $ref: '#/apiModelPublic' + type: array + type: object +apiListRegionsOutput: + description: Region Codes + properties: + regions: + description: Region code + items: + $ref: '#/genaiapiRegion' + type: array + type: object +apiMeta: + description: Meta information about the data set + properties: + page: + description: The current page + example: 123 + format: int64 + type: integer + pages: + description: Total number of pages + example: 123 + format: int64 + type: integer + total: + description: Total amount of items over all pages + example: 123 + format: int64 + type: integer + type: object +apiModel: + description: Description of a Model + properties: + agreement: + $ref: '#/apiAgreement' + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + inference_name: + description: Internally used name + example: '"example name"' + type: string + inference_version: + description: Internally used version + example: '"example string"' + type: string + is_foundational: + description: True if it is a foundational model provided by do + example: true + type: boolean + metadata: + description: Additional meta data + type: object + name: + description: Name of the model + example: '"example name"' + type: string + parent_uuid: + description: Unique id of the model, this model is based on + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + provider: + $ref: '#/apiModelProvider' + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + upload_complete: + description: Model has been fully uploaded + example: true + type: boolean + url: + description: Download url + example: '"example string"' + type: string + uuid: + description: Unique id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + version: + $ref: '#/apiModelVersion' + type: object +apiModelPrice: + properties: + attributes: + items: + $ref: '#/apiBillingAttribute' + type: array + display_name: + example: '"example name"' + type: string + model_uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + prices: + items: + $ref: '#/apiBillingPrice' + type: array + type: object +apiModelProvider: + default: MODEL_PROVIDER_DIGITALOCEAN + enum: + - MODEL_PROVIDER_DIGITALOCEAN + - MODEL_PROVIDER_ANTHROPIC + example: MODEL_PROVIDER_DIGITALOCEAN + type: string +apiModelPublic: + description: A machine learning model stored on the GenAI platform + properties: + agreement: + $ref: '#/apiAgreement' + created_at: + description: Creation date / time + example: "2021-01-01T00:00:00Z" + format: date-time + type: string + is_foundational: + description: True if it is a foundational model provided by do + example: true + type: boolean + name: + description: Name of the model + example: Llama 3.3 (70b) + type: string + parent_uuid: + description: Unique id of the model, this model is based on + example: '"12345678-1234-1234-1234-123456789012"' + type: string + updated_at: + description: Last modified + example: "2021-01-01T00:00:00Z" + format: date-time + type: string + upload_complete: + description: Model has been fully uploaded + example: true + type: boolean + url: + description: Download url + example: https://example.com/model.zip + type: string + uuid: + description: Unique id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + version: + $ref: '#/apiModelVersion' + type: object +apiModelUploadCompleteOutput: + description: Information about an updated model + properties: + model: + $ref: '#/apiModel' + type: object +apiModelUsecase: + default: MODEL_USECASE_UNKNOWN + description: |- + - MODEL_USECASE_UNKNOWN: The use case of the model is unknown + - MODEL_USECASE_AGENT: The model maybe used in an agent + - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning + - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models) + - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails + enum: + - MODEL_USECASE_UNKNOWN + - MODEL_USECASE_AGENT + - MODEL_USECASE_FINETUNED + - MODEL_USECASE_KNOWLEDGEBASE + - MODEL_USECASE_GUARDRAIL + example: MODEL_USECASE_UNKNOWN + type: string +apiModelVersion: + description: Version Information about a Model + properties: + major: + description: Major version number + example: 123 + format: int64 + type: integer + minor: + description: Minor version number + example: 123 + format: int64 + type: integer + patch: + description: Patch version number + example: 123 + format: int64 + type: integer + type: object +apiPages: + description: Information about how to reach other pages + properties: + first: + description: First page + example: '"example string"' + type: string + last: + description: Last page + example: '"example string"' + type: string + next: + description: Next page + example: '"example string"' + type: string + previous: + description: Previous page + example: '"example string"' + type: string + type: object +apiPresignedUrlFile: + description: A single file’s metadata in the request. + properties: + file_name: + description: Local filename + example: '"example name"' + type: string + file_size: + description: The size of the file in bytes. + example: '"12345"' + format: int64 + type: string + type: object +apiRefreshAgentTokenInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + refresh_token: + example: '"12345678-1234-1234-1234-123456789012"' +apiRefreshAgentTokenOutput: + description: Information about a refreshed token + properties: + access_token: + description: The token + example: '"example string"' + type: string + refresh_token: + description: Rhe refreshed token + example: '"example string"' + type: string + type: object +apiRefreshModelPlaygroundTokenOutput: + description: RefreshModelPlaygroundTokenOutput description + properties: + access_token: + example: '"example string"' + type: string + refresh_token: + example: '"example string"' + type: string + type: object +apiRegenerateAgentAPIKeyInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiRegenerateAgentAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiAgentAPIKeyInfo' + type: object +apiResourceUsage: + description: Resource Usage Description + properties: + measurements: + items: + $ref: '#/apiUsageMeasurement' + type: array + start: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + stop: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + type: object +apiSpacesDataSource: + description: Spaces Bucket Data Source + properties: + bucket_name: + description: Spaces bucket name + example: '"example name"' + type: string + item_path: + example: '"example string"' + type: string + region: + description: Region of bucket + example: '"example string"' + type: string + type: object +apiStartKnowledgeBaseIndexingJobInputPublic: + description: StartKnowledgeBaseIndexingJobInputPublic description + properties: + data_source_uuids: + description: List of data source ids to index, if none are provided, all data + sources will be indexed + example: + - example string + items: + example: '"example string"' + type: string + type: array + knowledge_base_uuid: + description: Knowledge base id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + type: object +apiStartKnowledgeBaseIndexingJobOutput: + description: StartKnowledgeBaseIndexingJobOutput description + properties: + job: + $ref: '#/apiIndexingJob' + type: object +apiTeamAgreement: + description: Team Agreement Description + properties: + accepted_at: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + agreement_uuid: + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiTeamModelURLOutput: + description: Model url output + properties: + url: + description: The signed url that can be used to upload one file + example: '"example string"' + type: string + type: object +apiUnlinkAgentFunctionInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + function_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiUnlinkAgentFunctionOutput: + description: Information about a newly unlinked agent + properties: + agent: + $ref: '#/apiAgent' + type: object +apiUnlinkAgentGuardrailOutput: + description: UnlinkAgentGuardrailOutput description + properties: + agent: + $ref: '#/apiAgent' + type: object +apiUnlinkAgentInputPublic: + properties: + child_agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + parent_agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiUnlinkAgentOutput: + description: Information about a removed linkage + properties: + child_agent_uuid: + description: Routed agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + parent_agent_uuid: + description: Pagent agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiUnlinkKnowledgeBaseInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + knowledge_base_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiUnlinkKnowledgeBaseOutput: + description: Informatinon about a unlinked knowledge base + properties: + agent: + $ref: '#/apiAgent' + type: object +apiUpdateAgentAPIKeyInputPublic: + properties: + agent_uuid: + description: Agent id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + api_key_uuid: + description: Api key id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + name: + description: Name + example: '"Production Key"' + type: string + type: object +apiUpdateAgentAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiAgentAPIKeyInfo' + type: object +apiUpdateAgentDeploymentVisbilityOutput: + description: UpdateAgentDeploymentVisbilityOutput description + properties: + agent: + $ref: '#/apiAgent' + type: object +apiUpdateAgentDeploymentVisibilityInputPublic: + description: UpdateAgentDeploymentVisibilityInputPublic description + properties: + uuid: + description: Unique id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + visibility: + $ref: '#/apiDeploymentVisibility' + type: object +apiUpdateAgentFunctionInputPublic: + description: Information about updating an agent function + properties: + agent_uuid: + description: Agent id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + description: + description: Funciton description + example: '"My Function Description"' + type: string + faas_name: + description: The name of the function in the DigitalOcean functions platform + example: '"my-function"' + type: string + faas_namespace: + description: The namespace of the function in the DigitalOcean functions platform + example: '"default"' + type: string + function_name: + description: Function name + example: '"My Function"' + type: string + function_uuid: + description: Function id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + input_schema: + description: Describe the input schema for the function so the agent may call + it + type: object + output_schema: + description: Describe the output schema for the function so the agent handle + its response + type: object + type: object +apiUpdateAgentFunctionOutput: + description: The updated agent + properties: + agent: + $ref: '#/apiAgent' + type: object +apiUpdateAgentInputPublic: + description: Data to modify an existing Agent + properties: + description: + description: Agent description + example: '"My Agent Description"' + type: string + instruction: + description: Agent instruction. Instructions help your agent to perform its + job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) + for best practices. + example: '"You are an agent who thinks deeply about the world"' + type: string + k: + description: How many results should be considered from an attached knowledge + base + example: 5 + format: int64 + type: integer + max_tokens: + description: Specifies the maximum number of tokens the model can process in + a single input or output, set as a number between 1 and 512. This determines + the length of each response. + example: 100 + format: int64 + type: integer + model_uuid: + description: Identifier for the foundation model. + example: '"12345678-1234-1234-1234-123456789012"' + type: string + name: + description: Agent name + example: '"My New Agent Name"' + type: string + project_id: + description: The id of the DigitalOcean project this agent will belong to + example: '"12345678-1234-1234-1234-123456789012"' + type: string + tags: + description: A set of abitrary tags to organize your agent + example: + - example string + items: + example: '"example string"' + type: string + type: array + temperature: + description: Controls the model’s creativity, specified as a number between + 0 and 1. Lower values produce more predictable and conservative responses, + while higher values encourage creativity and variation. + example: 0.7 + format: float + type: number + top_p: + description: Defines the cumulative probability threshold for word selection, + specified as a number between 0 and 1. Higher values allow for more diverse + outputs, while lower values ensure focused and coherent responses. + example: 0.9 + format: float + type: number + uuid: + description: Unique agent id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + type: object +apiUpdateAgentOutput: + description: Information about an updated agent + properties: + agent: + $ref: '#/apiAgent' + type: object +apiUpdateAnthropicAPIKeyOutput: + description: UpdateAnthropicAPIKeyOutput is used to return the updated Anthropic + API key. + properties: + api_key_info: + $ref: '#/apiAnthropicAPIKeyInfo' + type: object +apiUpdateChatbotInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + button_background_color: + example: '"#0000FF"' + logo: + example: '"https://example.com/logo.png"' + name: + example: '"My Chatbot"' + primary_color: + example: '"#FF0000"' + secondary_color: + example: '"#00FF00"' + starting_message: + example: '"Hello, how can I help you today?"' +apiUpdateChatbotOutput: + description: Info about an updated chatbot + properties: + chatbot: + $ref: '#/apiChatbot' + type: object +apiUpdateGuardrailOutput: + description: UpdateGuardrailOutput description + properties: + guardrail: + $ref: '#/apiGuardrail' + type: object +apiUpdateKnowledgeBaseInputPublic: + description: Information about updating a knowledge base + properties: + database_id: + description: The id of the DigitalOcean database this knowledge base will use, + optiona. + example: '"12345678-1234-1234-1234-123456789012"' + type: string + embedding_model_uuid: + description: Identifier for the foundation model. + example: '"12345678-1234-1234-1234-123456789012"' + type: string + name: + description: Knowledge base name + example: '"My Knowledge Base"' + type: string + project_id: + description: The id of the DigitalOcean project this knowledge base will belong + to + example: '"12345678-1234-1234-1234-123456789012"' + type: string + tags: + description: Tags to organize your knowledge base. + example: + - example string + items: + example: '"example string"' + type: string + type: array + uuid: + description: Knowledge base id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + type: object +apiUpdateKnowledgeBaseOutput: + description: Information about an updated knowledge base + properties: + knowledge_base: + $ref: '#/apiKnowledgeBase' + type: object +apiUpdateLinkedAgentInputPublic: + description: Information about updating the linkage of an agent + properties: + child_agent_uuid: + description: Routed agent id + example: '"12345678-1234-1234-1234-123456789012"' + type: string + if_case: + description: Describes the case in which the child agent should be used + example: '"use this to get weather information"' + type: string + parent_agent_uuid: + description: A unique identifier for the parent agent. + example: '"12345678-1234-1234-1234-123456789012"' + type: string + route_name: + description: Route name + example: '"weather_route"' + type: string + uuid: + description: Unique id of linkage + example: '"12345678-1234-1234-1234-123456789012"' + type: string + type: object +apiUpdateLinkedAgentOutput: + description: Information about an updated linkage + properties: + child_agent_uuid: + description: Routed agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + parent_agent_uuid: + description: A unique identifier for the parent agent. + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + uuid: + description: Unique id of linkage + example: '"123e4567-e89b-12d3-a456-426614174000"' + type: string + type: object +apiUpdateModelMetadataOutput: + description: Information about updated meta data for a model + properties: + model: + $ref: '#/apiModel' + type: object +apiUsageMeasurement: + description: Usage Measurement Description + properties: + tokens: + example: 123 + format: int64 + type: integer + usage_type: + example: '"example string"' + type: string + type: object +dbaasClusterStatus: + default: CREATING + enum: + - CREATING + - ONLINE + - POWEROFF + - REBUILDING + - REBALANCING + - DECOMMISSIONED + - FORKING + - MIGRATING + - RESIZING + - RESTORING + - POWERING_ON + - UNHEALTHY + example: CREATING + type: string +genaiapiRegion: + description: Description for a specific Region + properties: + inference_url: + description: Url for inference server + example: '"example string"' + type: string + region: + description: Region code + example: '"example string"' + type: string + serves_batch: + description: This datacenter is capable of running batch jobs + example: true + type: boolean + serves_inference: + description: This datacenter is capable of serving inference + example: true + type: boolean + stream_inference_url: + description: The url for the inference streaming server + example: '"example string"' + type: string + type: object +protobufNullValue: + default: NULL_VALUE + description: |- + `NullValue` is a singleton enumeration to represent the null value for the + `Value` type union. + + The JSON representation for `NullValue` is JSON `null`. + + - NULL_VALUE: Null value. + enum: + - NULL_VALUE + example: NULL_VALUE + type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent.yml new file mode 100644 index 000000000..24b5af558 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent.yml @@ -0,0 +1,13 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/child_agents/6a09d603-b68d-11ef-bf8f-4e013e2ddde4" \ + -d '{ + "parent_agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "child_agent_uuid": "6a09d603-b68d-11ef-bf8f-4e013e2ddde4", + "route_name": "route-token-stat", + "if_case": "for any token related statistics, use this route" + }' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent_function.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent_function.yml new file mode 100644 index 000000000..07cf075a0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent_function.yml @@ -0,0 +1,27 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/functions" \ + -d '{ + "agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "function_name": "funzip", + "description": "Use when you need the zipcode for a city", + "input_schema": { + "city": { + "description": "the city you want a zipcode for", + "required": true, + "type": "string" + } + }, + "output_schema": { + "zip_code": { + "description": "The zipcode of the desired city", + "type": "number" + } + }, + "faas_namespace": "fn-2014dc98-faa1-45f4-ba1f-59910cb3d399", + "faas_name": "default/get-zipcode" + }' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_knowledge_base.yml new file mode 100644 index 000000000..6bfdbe3ef --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_knowledge_base.yml @@ -0,0 +1,12 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/knowledge_bases/9a6e3975-b0c6-11ef-bf8f-4e013e2ddde4" \ + -d '{ + "agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "agent_uuid": "9a6e3975-b0c6-11ef-bf8f-4e013e2ddde4" + }' + + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_cancel_indexing_job.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_cancel_indexing_job.yml new file mode 100644 index 000000000..638e73ec2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_cancel_indexing_job.yml @@ -0,0 +1,9 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/indexing_jobs/79ca9798-cf7d-11ef-bf8f-4e013e2ddde4/cancel" \ + -d '{ + "uuid": "79ca9798-cf7d-11ef-bf8f-4e013e2ddde4" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent.yml new file mode 100644 index 000000000..5b67f4a81 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent.yml @@ -0,0 +1,20 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents" \ + -d '{ + "name": "api-create", + "model_uuid": "95ea6652-75ed-11ef-bf8f-4e013e2ddde4", + "instruction": "be a weather reporter", + "description": "weather-agent", + "project_id": "37455431-84bd-4fa2-94cf-e8486f8f8c5e", + "tags": [ + "tag1" + ], + "region": "tor1", + "knowledge_base_uuid": [ + "9758a232-b351-11ef-bf8f-4e013e2ddde4" + ] + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent_api_key.yml new file mode 100644 index 000000000..1b124dcec --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent_api_key.yml @@ -0,0 +1,10 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/api_keys" \ + -d '{ + "agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "name": "test-key" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_indexing_job.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_indexing_job.yml new file mode 100644 index 000000000..c9ef00b4b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_indexing_job.yml @@ -0,0 +1,13 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/indexing_jobs" \ + -d '{ + "knowledge_base_uuid": "9758a232-b351-11ef-bf8f-4e013e2ddde4", + "data_source_uuids": [ + "9a825ee0-bbb1-11ef-bf8f-4e013e2ddde4" + ] + }' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml new file mode 100644 index 000000000..09712babf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml @@ -0,0 +1,24 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases" \ + -d '{ + "name": "kb-api-create", + "embedding_model_uuid": "05700391-7aa8-11ef-bf8f-4e013e2ddde4", + "project_id": "37455431-84bd-4fa2-94cf-e8486f8f8c5e", + "tags": [ + "tag1" + ], + "database_id": "abf1055a-745d-4c24-a1db-1959ea819264", + "datasources": [ + { + "bucket_name": "test-public-gen-ai", + "bucket_region": "tor1" + } + ], + "region": "tor1", + "vpc_uuid": "f7176e0b-8c5e-4e32-948e-79327e56225a" + }' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base_data_source.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base_data_source.yml new file mode 100644 index 000000000..b8d728877 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base_data_source.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/9a6e3975-b0c6-11ef-bf8f-4e013e2ddde4/data_sources/bd2a2db5-b8b0-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent.yml new file mode 100644 index 000000000..4daac8053 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agent/5581a586-a745-11ef-bf8f-4e013e2ddde4" + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent_api_key.yml new file mode 100644 index 000000000..047989c46 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent_api_key.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/api_keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base.yml new file mode 100644 index 000000000..d2c413ff2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/8241f44e-b0da-11ef-bf8f-4e013e2ddde4" + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base_data_source.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base_data_source.yml new file mode 100644 index 000000000..c8b107535 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base_data_source.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/9a6e3975-b0c6-11ef-bf8f-4e013e2ddde4/data_sources/bd2a2db5-b8b0-11ef-bf8f-4e013e2ddde4" + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent.yml new file mode 100644 index 000000000..0a513e243 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/ff47f5b7-96e5-11ef-bf8f-4e013e2ddde4/child_agents/c441bf77-81d6-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent_function.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent_function.yml new file mode 100644 index 000000000..93c129024 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent_function.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/ff47f5b7-96e5-11ef-bf8f-4e013e2ddde4/functions/6cc5cda5-9ac3-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_knowledge_base.yml new file mode 100644 index 000000000..b8d728877 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_knowledge_base.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/9a6e3975-b0c6-11ef-bf8f-4e013e2ddde4/data_sources/bd2a2db5-b8b0-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent.yml new file mode 100644 index 000000000..7eead19a8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/c441bf77-81d6-11ef-bf8f-4e013e2ddde4" + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent_children.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent_children.yml new file mode 100644 index 000000000..a353b26f5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent_children.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/c441bf77-81d6-11ef-bf8f-4e013e2ddde4/child_agents" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_indexing_job.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_indexing_job.yml new file mode 100644 index 000000000..edc9105ac --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_indexing_job.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/indexing_jobs/9758a232-b351-11ef-bf8f-4e013e2ddde4" + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_knowledge_base.yml new file mode 100644 index 000000000..7fc36438b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_knowledge_base.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/9758a232-b351-11ef-bf8f-4e013e2ddde4" + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agent_api_keys.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agent_api_keys.yml new file mode 100644 index 000000000..82242c275 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agent_api_keys.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/c441bf77-81d6-11ef-bf8f-4e013e2ddde4/api_keys" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents.yml new file mode 100644 index 000000000..4ad02f0ad --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_datacenter_regions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_datacenter_regions.yml new file mode 100644 index 000000000..4ac83b216 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_datacenter_regions.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/regions" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_job_data_sources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_job_data_sources.yml new file mode 100644 index 000000000..38399e656 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_job_data_sources.yml @@ -0,0 +1,8 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/indexing_jobs/9758a232-b351-11ef-bf8f-4e013e2ddde4" + + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_jobs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_jobs.yml new file mode 100644 index 000000000..28b63ab1f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_jobs.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/indexing_jobs" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_base_data_sources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_base_data_sources.yml new file mode 100644 index 000000000..d665882c0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_base_data_sources.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/9758a232-b351-11ef-bf8f-4e013e2ddde4/data_sources" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_bases.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_bases.yml new file mode 100644 index 000000000..529d1960b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_bases.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_models.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_models.yml new file mode 100644 index 000000000..702c08bac --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_models.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/models" + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_regenerate_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_regenerate_agent_api_key.yml new file mode 100644 index 000000000..fb40c0853 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_regenerate_agent_api_key.yml @@ -0,0 +1,8 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/api_keys/11efcf7e-824d-2808-bf8f-4e013e2ddde4/regenerate" + + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent.yml new file mode 100644 index 000000000..94f266dd7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent.yml @@ -0,0 +1,22 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4" \ + -d '{ + "uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "name": "rename-agent-api", + "instruction": "be a weather reporter and act like you are a pro", + "description": "weather-agent2", + "model_uuid": "95ea6652-75ed-11ef-bf8f-4e013e2ddde4", + "project_id": "37455431-84bd-4fa2-94cf-e8486f8f8c5e", + "tags": [ + "tag2" + ], + "k": 5, + "temperature": 1, + "top_p": 1, + "max_tokens": 250 + }' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_api_key.yml new file mode 100644 index 000000000..ed89abf6d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_api_key.yml @@ -0,0 +1,11 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/api_keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" \ + -d '{ + "agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "api_key_uuid": "11efb7d6-cdb5-6388-bf8f-4e013e2ddde4", + "name": "test-key2" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_deployment_visibility.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_deployment_visibility.yml new file mode 100644 index 000000000..4a9debefa --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_deployment_visibility.yml @@ -0,0 +1,11 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/deployment_visibility" \ + -d '{ + "uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "visibility": "VISIBILITY_PUBLIC" + }' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_function.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_function.yml new file mode 100644 index 000000000..df7800e29 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_function.yml @@ -0,0 +1,11 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/functions/b00e74f6-985c-11ef-bf8f-4e013e2ddde4" \ + -d '{ + "agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "function_uuid": "6cc5cda5-9ac3-11ef-bf8f-4e013e2ddde4", + "function_name": "func-rename" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_attached_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_attached_agent.yml new file mode 100644 index 000000000..415ded9c6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_attached_agent.yml @@ -0,0 +1,14 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/child_agents/18c4c90c-cc40-11ef-bf8f-4e013e2ddde4" \ + -d '{ + "parent_agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "child_agent_uuid": "18c4c90c-cc40-11ef-bf8f-4e013e2ddde4", + "route_name": "route-rename-api", + "if_case": "if any token related statistics, use this route only", + "uuid":"a22d2004-bbaa-11ef-bf8f-4e013e2ddde4" + }' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_knowledge_base.yml new file mode 100644 index 000000000..4b9296b44 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_knowledge_base.yml @@ -0,0 +1,10 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/e51dba65-cf7a-11ef-bf8f-4e013e2ddde4" \ + -d '{ + "uuid": "e51dba65-cf7a-11ef-bf8f-4e013e2ddde4", + "name": "kb-api-rename" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent.yml new file mode 100644 index 000000000..99883a33c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent.yml @@ -0,0 +1,54 @@ +description: To add an agent route to an agent, send a POST request to `/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}`. +operationId: genai_attach_agent +parameters: +- description: A unique identifier for the parent agent. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: parent_agent_uuid + required: true + schema: + type: string +- description: Routed agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: child_agent_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiLinkAgentInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiLinkAgentOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Add Agent Route to an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_attach_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent_function.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent_function.yml new file mode 100644 index 000000000..1ca3abf5c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent_function.yml @@ -0,0 +1,47 @@ +description: To create a function route for an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/functions`. +operationId: genai_attach_agent_function +parameters: +- description: Agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiLinkAgentFunctionInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiLinkAgentFunctionOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Add Function Route to an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_attach_agent_function.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_knowledge_base.yml new file mode 100644 index 000000000..6cdf242c4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_knowledge_base.yml @@ -0,0 +1,49 @@ +description: To attach a knowledge base to an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}` +operationId: genai_attach_knowledge_base +parameters: +- description: A unique identifier for an agent. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +- description: A unique identifier for a knowledge base. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: knowledge_base_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiLinkKnowledgeBaseOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Attach Knowledge Base to an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_attach_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_cancel_indexing_job.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_cancel_indexing_job.yml new file mode 100644 index 000000000..9ff4b0113 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_cancel_indexing_job.yml @@ -0,0 +1,48 @@ +description: To cancel an indexing job for a knowledge base, send a PUT request to + `/v2/gen-ai/indexing_jobs/{uuid}/cancel`. +operationId: genai_cancel_indexing_job +parameters: +- description: A unique identifier for an indexing job. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCancelKnowledgeBaseIndexingJobInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCancelKnowledgeBaseIndexingJobOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:update +summary: Cancel Indexing Job for a Knowledge Base +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_cancel_indexing_job.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent.yml new file mode 100644 index 000000000..e8e108bf8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent.yml @@ -0,0 +1,40 @@ +description: To create a new agent, send a POST request to `/v2/gen-ai/agents`. The + response body contains a JSON object with the newly created agent object. +operationId: genai_create_agent +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAgentInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAgentOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Create an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_create_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent_api_key.yml new file mode 100644 index 000000000..dadcb723b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent_api_key.yml @@ -0,0 +1,47 @@ +description: To create an agent API key, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/api_keys`. +operationId: genai_create_agent_api_key +parameters: +- description: Agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAgentAPIKeyInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAgentAPIKeyOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Create an Agent API Key +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_create_agent_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_indexing_job.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_indexing_job.yml new file mode 100644 index 000000000..f61fd1e80 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_indexing_job.yml @@ -0,0 +1,40 @@ +description: To start an indexing job for a knowledge base, send a POST request to + `/v2/gen-ai/indexing_jobs`. +operationId: genai_create_indexing_job +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiStartKnowledgeBaseIndexingJobInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiStartKnowledgeBaseIndexingJobOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Start Indexing Job for a Knowledge Base +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_create_indexing_job.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base.yml new file mode 100644 index 000000000..08575714b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base.yml @@ -0,0 +1,39 @@ +description: To create a knowledge base, send a POST request to `/v2/gen-ai/knowledge_bases`. +operationId: genai_create_knowledge_base +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateKnowledgeBaseInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateKnowledgeBaseOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Create a Knowledge Base +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_create_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base_data_source.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base_data_source.yml new file mode 100644 index 000000000..75dd07ff5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base_data_source.yml @@ -0,0 +1,47 @@ +description: To add a data source to a knowledge base, send a POST request to `/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources`. +operationId: genai_create_knowledge_base_data_source +parameters: +- description: Knowledge base id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: knowledge_base_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateKnowledgeBaseDataSourceInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateKnowledgeBaseDataSourceOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:create +summary: Add Data Source to a Knowledge Base +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_create_knowledge_base_data_source.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent.yml new file mode 100644 index 000000000..e91f6ce04 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent.yml @@ -0,0 +1,42 @@ +description: To delete an agent, send a DELETE request to `/v2/gen-ai/agents/{uuid}`. +operationId: genai_delete_agent +parameters: +- description: Unique agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDeleteAgentOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:delete +summary: Delete an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_delete_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent_api_key.yml new file mode 100644 index 000000000..500bfb271 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent_api_key.yml @@ -0,0 +1,49 @@ +description: To delete an API key for an agent, send a DELETE request to `/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}`. +operationId: genai_delete_agent_api_key +parameters: +- description: A unique identifier for your agent. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +- description: API key for an agent. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDeleteAgentAPIKeyOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:delete +summary: 'Delete API Key for an Agent ' +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_delete_agent_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base.yml new file mode 100644 index 000000000..6f5280a13 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base.yml @@ -0,0 +1,42 @@ +description: To delete a knowledge base, send a DELETE request to `/v2/gen-ai/knowledge_bases/{uuid}`. +operationId: genai_delete_knowledge_base +parameters: +- description: Knowledge base id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDeleteKnowledgeBaseOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:delete +summary: Delete a Knowledge Base +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_delete_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base_data_source.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base_data_source.yml new file mode 100644 index 000000000..3a8458132 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base_data_source.yml @@ -0,0 +1,50 @@ +description: To delete a data source from a knowledge base, send a DELETE request + to `/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}`. +operationId: genai_delete_knowledge_base_data_source +parameters: +- description: Knowledge base id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: knowledge_base_uuid + required: true + schema: + type: string +- description: Data source id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: data_source_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDeleteKnowledgeBaseDataSourceOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:delete +summary: Delete a Data Source from a Knowledge Base +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_delete_knowledge_base_data_source.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent.yml new file mode 100644 index 000000000..5c294647a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent.yml @@ -0,0 +1,50 @@ +description: To delete an agent route from a parent agent, send a DELETE request to + `/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}`. +operationId: genai_detach_agent +parameters: +- description: Pagent agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: parent_agent_uuid + required: true + schema: + type: string +- description: Routed agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: child_agent_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUnlinkAgentOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:delete +summary: Delete Agent Route for an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_detach_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent_function.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent_function.yml new file mode 100644 index 000000000..9babbc422 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent_function.yml @@ -0,0 +1,50 @@ +description: To delete a function route from an agent, send a DELETE request to `/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}`. +operationId: genai_detach_agent_function +parameters: +- description: The id of the agent the function route belongs to. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +- description: The function route to be destroyed. This does not destroy the function + itself. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: function_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUnlinkAgentFunctionOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:delete +summary: Delete Function Route for an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_detach_agent_function.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_knowledge_base.yml new file mode 100644 index 000000000..3434ddf21 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_knowledge_base.yml @@ -0,0 +1,49 @@ +description: To detach a knowledge base from an agent, send a DELETE request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}`. +operationId: genai_detach_knowledge_base +parameters: +- description: Agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +- description: Knowledge base id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: knowledge_base_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUnlinkKnowledgeBaseOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:delete +summary: Detach Knowledge Base from an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_detach_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent.yml new file mode 100644 index 000000000..46dec81a2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent.yml @@ -0,0 +1,43 @@ +description: To retrieve details of an agent, GET request to `/v2/gen-ai/agents/{uuid}`. + The response body is a JSON object containing the agent. +operationId: genai_get_agent +parameters: +- description: Unique agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetAgentOutputPublic + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: Retrieve an Existing Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_get_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent_children.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent_children.yml new file mode 100644 index 000000000..e9d004be6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent_children.yml @@ -0,0 +1,42 @@ +description: To view agent routes for an agent, send a GET requtest to `/v2/gen-ai/agents/{uuid}/child_agents`. +operationId: genai_get_agent_children +parameters: +- description: Agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetChildrenOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: View Agent Routes +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_get_agent_children.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_indexing_job.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_indexing_job.yml new file mode 100644 index 000000000..4e8d47415 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_indexing_job.yml @@ -0,0 +1,43 @@ +description: To get status of an indexing Job for a knowledge base, send a GET request + to `/v2/gen-ai/indexing_jobs/{uuid}`. +operationId: genai_get_indexing_job +parameters: +- description: Indexing job id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetKnowledgeBaseIndexingJobOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: Retrieve Status of Indexing Job for a Knowledge Base +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_get_indexing_job.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_knowledge_base.yml new file mode 100644 index 000000000..c5df4a8de --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_knowledge_base.yml @@ -0,0 +1,43 @@ +description: To retrive information about an existing knowledge base, send a GET request + to `/v2/gen-ai/knowledge_bases/{uuid}`. +operationId: genai_get_knowledge_base +parameters: +- description: Knowledge base id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetKnowledgeBaseOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: Retrieve Information About an Existing Knowledge Base +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_get_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agent_api_keys.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agent_api_keys.yml new file mode 100644 index 000000000..3e7caa799 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agent_api_keys.yml @@ -0,0 +1,54 @@ +description: To list all agent API keys, send a GET request to `/v2/gen-ai/agents/{agent_uuid}/api_keys`. +operationId: genai_list_agent_api_keys +parameters: +- description: Agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListAgentAPIKeysOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List Agent API Keys +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_list_agent_api_keys.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents.yml new file mode 100644 index 000000000..0049e5fa8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents.yml @@ -0,0 +1,53 @@ +description: To list all agents, send a GET request to `/v2/gen-ai/agents`. +operationId: genai_list_agents +parameters: +- description: Only list agents that are deployed. + example: true + in: query + name: only_deployed + schema: + type: boolean +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListAgentsOutputPublic + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List Agents +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_list_agents.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_datacenter_regions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_datacenter_regions.yml new file mode 100644 index 000000000..1bbacbded --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_datacenter_regions.yml @@ -0,0 +1,47 @@ +description: To list all datacenter regions, send a GET request to `/v2/gen-ai/regions`. +operationId: genai_list_datacenter_regions +parameters: +- description: Include datacenters that serve inference. + example: true + in: query + name: serves_inference + schema: + type: boolean +- description: Include datacenters that are capable of running batch jobs. + example: true + in: query + name: serves_batch + schema: + type: boolean +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListRegionsOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List Datacenter Regions +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_list_datacenter_regions.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_job_data_sources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_job_data_sources.yml new file mode 100644 index 000000000..9ea6ccd1d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_job_data_sources.yml @@ -0,0 +1,42 @@ +description: To list all datasources for an indexing job, send a GET request to `/v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources`. +operationId: genai_list_indexing_job_data_sources +parameters: +- description: Uuid of the indexing job + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: indexing_job_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListIndexingJobDataSourcesOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List Data Sources for Indexing Job for a Knowledge Base +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_list_indexing_job_data_sources.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_jobs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_jobs.yml new file mode 100644 index 000000000..f696f409d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_jobs.yml @@ -0,0 +1,48 @@ +description: To list all indexing jobs for a knowledge base, send a GET request to + `/v2/gen-ai/indexing_jobs`. +operationId: genai_list_indexing_jobs +parameters: +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListKnowledgeBaseIndexingJobsOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List Indexing Jobs for a Knowledge Base +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_list_indexing_jobs.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_base_data_sources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_base_data_sources.yml new file mode 100644 index 000000000..7e36d0aa9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_base_data_sources.yml @@ -0,0 +1,55 @@ +description: To list all data sources for a knowledge base, send a GET request to + `/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources`. +operationId: genai_list_knowledge_base_data_sources +parameters: +- description: Knowledge base id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: knowledge_base_uuid + required: true + schema: + type: string +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListKnowledgeBaseDataSourcesOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List Data Sources for a Knowledge Base +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_list_knowledge_base_data_sources.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_bases.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_bases.yml new file mode 100644 index 000000000..0741eea3d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_bases.yml @@ -0,0 +1,47 @@ +description: To attach a knowledge base to an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}`. +operationId: genai_list_knowledge_bases +parameters: +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListKnowledgeBasesOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List Knowledge Bases +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_list_knowledge_bases.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_models.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_models.yml new file mode 100644 index 000000000..4cc7143a3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_models.yml @@ -0,0 +1,75 @@ +description: To list all models, send a GET request to `/v2/gen-ai/models`. +operationId: genai_list_models +parameters: +- description: |- + Include only models defined for the listed usecases. + + - MODEL_USECASE_UNKNOWN: The use case of the model is unknown + - MODEL_USECASE_AGENT: The model maybe used in an agent + - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning + - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models) + - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails + example: + - MODEL_USECASE_UNKNOWN + in: query + name: usecases + schema: + items: + enum: + - MODEL_USECASE_UNKNOWN + - MODEL_USECASE_AGENT + - MODEL_USECASE_FINETUNED + - MODEL_USECASE_KNOWLEDGEBASE + - MODEL_USECASE_GUARDRAIL + type: string + type: array +- description: Only include models that are publicly available. + example: true + in: query + name: public_only + schema: + type: boolean +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListModelsOutputPublic + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:read +summary: List Available Models +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_list_models.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_regenerate_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_regenerate_agent_api_key.yml new file mode 100644 index 000000000..661224a8f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_regenerate_agent_api_key.yml @@ -0,0 +1,49 @@ +description: To regenerate an agent API key, send a PUT request to `/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}/regenerate`. +operationId: genai_regenerate_agent_api_key +parameters: +- description: Agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +- description: Api key id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiRegenerateAgentAPIKeyOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:update +summary: Regenerate API Key for an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_regenerate_agent_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent.yml new file mode 100644 index 000000000..babb31ce9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent.yml @@ -0,0 +1,48 @@ +description: To update an agent, send a PUT request to `/v2/gen-ai/agents/{uuid}`. + The response body is a JSON object containing the agent. +operationId: genai_update_agent +parameters: +- description: Unique agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateAgentInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateAgentOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:update +summary: Update an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_update_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_api_key.yml new file mode 100644 index 000000000..e4f742d5f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_api_key.yml @@ -0,0 +1,54 @@ +description: To update an agent API key, send a PUT request to `/v2/gen-ai/agents/{agent_uuid}/api_keys/{api_key_uuid}`. +operationId: genai_update_agent_api_key +parameters: +- description: Agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +- description: Api key id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateAgentAPIKeyInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateAgentAPIKeyOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:update +summary: Update API Key for an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_update_agent_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_deployment_visibility.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_deployment_visibility.yml new file mode 100644 index 000000000..10d82cf41 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_deployment_visibility.yml @@ -0,0 +1,48 @@ +description: Check whether an agent is public or private. To get the agent status, + send a PUT request to `/v2/gen-ai/agents/{uuid}/deployment_visibility`. +operationId: genai_update_agent_deployment_visibility +parameters: +- description: Unique id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateAgentDeploymentVisibilityInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateAgentDeploymentVisbilityOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:update +summary: Check Agent Status +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_update_agent_deployment_visibility.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_function.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_function.yml new file mode 100644 index 000000000..e335d28c3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_function.yml @@ -0,0 +1,54 @@ +description: To update the function route, send a PUT request to `/v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}`. +operationId: genai_update_agent_function +parameters: +- description: Agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +- description: Function id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: function_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateAgentFunctionInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateAgentFunctionOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:update +summary: Update Function Route for an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_update_agent_function.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_attached_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_attached_agent.yml new file mode 100644 index 000000000..4b0bfd2b1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_attached_agent.yml @@ -0,0 +1,54 @@ +description: To update an agent route for an agent, send a PUT request to `/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}`. +operationId: genai_update_attached_agent +parameters: +- description: A unique identifier for the parent agent. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: parent_agent_uuid + required: true + schema: + type: string +- description: Routed agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: child_agent_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateLinkedAgentInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateLinkedAgentOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:update +summary: Update Agent Route for an Agent +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_update_attached_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_knowledge_base.yml new file mode 100644 index 000000000..ea7f29a87 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_knowledge_base.yml @@ -0,0 +1,47 @@ +description: To update a knowledge base, send a PUT request to `/v2/gen-ai/knowledge_bases/{uuid}`. +operationId: genai_update_knowledge_base +parameters: +- description: Knowledge base id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateKnowledgeBaseInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateKnowledgeBaseOutput + description: A successful response. + headers: + ratelimit-limit: + $ref: ../../shared/headers.yml#/ratelimit-limit + ratelimit-remaining: + $ref: ../../shared/headers.yml#/ratelimit-remaining + ratelimit-reset: + $ref: ../../shared/headers.yml#/ratelimit-reset + "401": + $ref: ../../shared/responses/unauthorized.yml + "404": + $ref: ../../shared/responses/not_found.yml + "429": + $ref: ../../shared/responses/too_many_requests.yml + "500": + $ref: ../../shared/responses/server_error.yml + default: + $ref: ../../shared/responses/unexpected_error.yml +security: +- bearer_auth: + - genai:update +summary: Update a Knowledge Base +tags: +- GenAI Platform (Public Preview) +x-codeSamples: +- $ref: examples/curl/genai_update_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_post.yml index aa2f29241..9476e13e3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_post.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_post.yml @@ -63,4 +63,4 @@ x-codeSamples: security: - bearer_auth: - - 'image:create' + - 'image:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/examples/curl/loadBalancers_delete_cache.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/examples/curl/loadBalancers_delete_cache.yml new file mode 100644 index 000000000..672891ddc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/examples/curl/loadBalancers_delete_cache.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/load_balancers/4de7ac8b-495b-4884-9a69-1050c6793cd6/cache" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/examples/go/loadBalancers_delete_cache.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/examples/go/loadBalancers_delete_cache.yml new file mode 100644 index 000000000..8302b5112 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/examples/go/loadBalancers_delete_cache.yml @@ -0,0 +1,17 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + _, err := client.LoadBalancers.PurgeCache(ctx, "4de7ac8b-495b-4884-9a69-1050c6793cd6") + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_delete_cache.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_delete_cache.yml new file mode 100644 index 000000000..2d4181ed8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_delete_cache.yml @@ -0,0 +1,43 @@ +operationId: loadBalancers_delete_cache + +summary: Delete a Global Load Balancer CDN Cache + +description: | + To delete a Global load balancer CDN cache, send a DELETE request to + `/v2/load_balancers/$LOAD_BALANCER_ID/cache`. + + A successful request will receive a 204 status code with no body in response. + This indicates that the request was processed successfully. + +tags: + - Load Balancers + +parameters: + - $ref: 'parameters.yml#/load_balancer_id' + +responses: + '204': + $ref: '../../shared/responses/no_content.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +x-codeSamples: + - $ref: 'examples/curl/loadBalancers_delete_cache.yml' + - $ref: 'examples/go/loadBalancers_delete_cache.yml' + +security: + - bearer_auth: + - 'load_balancer:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/domains.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/domains.yml new file mode 100644 index 000000000..4be9d4c72 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/domains.yml @@ -0,0 +1,21 @@ +type: object + +description: An object specifying domain configurations for a Global load balancer. + +properties: + name: + type: string + example: example.com + description: FQDN to associate with a Global load balancer. + + is_managed: + type: boolean + example: true + description: A boolean value indicating if the domain is already managed + by DigitalOcean. If true, all A and AAAA records required to enable Global + load balancers will be automatically added. + + certificate_id: + type: string + example: 892071a0-bb95-49bc-8021-3afd67a210bf + description: The ID of the TLS certificate used for SSL termination. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/glb_settings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/glb_settings.yml new file mode 100644 index 000000000..f315fc41c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/glb_settings.yml @@ -0,0 +1,49 @@ +type: object + +description: An object specifying forwarding configurations for a Global load balancer. + +properties: + target_protocol: + type: string + enum: + - http + - https + - http2 + example: http + description: The protocol used for forwarding traffic from the load balancer to the + target backends. The possible values are `http`, `https` and `http2`. + + target_port: + type: integer + example: 80 + description: An integer representing the port on the target backends which the + load balancer will forward traffic to. + + cdn: + type: object + properties: + is_enabled: + type: boolean + example: true + description: A boolean flag to enable CDN caching. + description: An object specifying CDN configurations for a Global load balancer. + + region_priorities: + type: object + additionalProperties: + type: integer + example: + "nyc1": 1 + "fra1": 2 + "sgp1": 3 + description: A map of region string to an integer priority value indicating preference + for which regional target a Global load balancer will forward traffic to. A lower + value indicates a higher priority. + + failover_threshold: + type: integer + example: 50 + description: An integer value as a percentage to indicate failure threshold to decide how + the regional priorities will take effect. A value of `50` would indicate that the Global + load balancer will choose a lower priority region to forward traffic to once this failure + threshold has been reached for the higher priority region. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/load_balancer_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/load_balancer_base.yml index e5a6fb1b5..49bab79d9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/load_balancer_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/models/load_balancer_base.yml @@ -181,5 +181,25 @@ properties: regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer. + domains: + type: array + items: + $ref: 'domains.yml' + description: An array of objects specifying the domain configurations for a + Global load balancer. + + glb_settings: + $ref: 'glb_settings.yml' + + target_load_balancer_ids: + type: array + items: + type: string + example: + - 7dbf91fe-cbdb-48dc-8290-c3a181554905 + - 996fa239-fac3-42a2-b9a1-9fa822268b7a + description: An array containing the UUIDs of the Regional load balancers to be used as target + backends for a Global load balancer. + required: - forwarding_rules diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_current_cpu_utilization.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_current_cpu_utilization.yml new file mode 100644 index 000000000..2a50f3436 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_current_cpu_utilization.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/metrics/droplet_autoscale/current_cpu_utilization?autoscale_pool_id=4de7ac8b-495b-4884-9a69-1050c6793cd6&start=1636051668&end=1636051668" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_current_instances.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_current_instances.yml new file mode 100644 index 000000000..d1e9f118e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_current_instances.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/metrics/droplet_autoscale/current_instances?autoscale_pool_id=4de7ac8b-495b-4884-9a69-1050c6793cd6&start=1636051668&end=1636051668" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_current_memory_utilization.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_current_memory_utilization.yml new file mode 100644 index 000000000..89a34122d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_current_memory_utilization.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/metrics/droplet_autoscale/current_memory_utilization?autoscale_pool_id=4de7ac8b-495b-4884-9a69-1050c6793cd6&start=1636051668&end=1636051668" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_target_cpu_utilization.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_target_cpu_utilization.yml new file mode 100644 index 000000000..aea6f7ee4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_target_cpu_utilization.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/metrics/droplet_autoscale/target_cpu_utilization?autoscale_pool_id=4de7ac8b-495b-4884-9a69-1050c6793cd6&start=1636051668&end=1636051668" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_target_instances.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_target_instances.yml new file mode 100644 index 000000000..12bc90cc7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_target_instances.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/metrics/droplet_autoscale/target_instances?autoscale_pool_id=4de7ac8b-495b-4884-9a69-1050c6793cd6&start=1636051668&end=1636051668" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_target_memory_utilization.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_target_memory_utilization.yml new file mode 100644 index 000000000..88f3343d4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/examples/curl/monitoring_get_droplet_autoscale_target_memory_utilization.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/monitoring/metrics/droplet_autoscale/target_memory_utilization?autoscale_pool_id=4de7ac8b-495b-4884-9a69-1050c6793cd6&start=1636051668&end=1636051668" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/alert_policy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/alert_policy.yml index db3d85cc5..47111da83 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/alert_policy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/alert_policy.yml @@ -70,6 +70,14 @@ properties: - v1/dbaas/alerts/memory_utilization_alerts - v1/dbaas/alerts/disk_utilization_alerts - v1/dbaas/alerts/cpu_alerts + - v1/droplet/autoscale_alerts/current_instances + - v1/droplet/autoscale_alerts/target_instances + - v1/droplet/autoscale_alerts/current_cpu_utilization + - v1/droplet/autoscale_alerts/target_cpu_utilization + - v1/droplet/autoscale_alerts/current_memory_utilization + - v1/droplet/autoscale_alerts/target_memory_utilization + - v1/droplet/autoscale_alerts/scale_up + - v1/droplet/autoscale_alerts/scale_down example: v1/insights/droplet/cpu uuid: type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/alert_policy_request.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/alert_policy_request.yml index 50d1f8078..283750243 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/alert_policy_request.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/models/alert_policy_request.yml @@ -67,6 +67,14 @@ properties: - v1/dbaas/alerts/memory_utilization_alerts - v1/dbaas/alerts/disk_utilization_alerts - v1/dbaas/alerts/cpu_alerts + - v1/droplet/autoscale_alerts/current_instances + - v1/droplet/autoscale_alerts/target_instances + - v1/droplet/autoscale_alerts/current_cpu_utilization + - v1/droplet/autoscale_alerts/target_cpu_utilization + - v1/droplet/autoscale_alerts/current_memory_utilization + - v1/droplet/autoscale_alerts/target_memory_utilization + - v1/droplet/autoscale_alerts/scale_up + - v1/droplet/autoscale_alerts/scale_down example: v1/insights/droplet/cpu value: type: number diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml index 08f871b92..f5b083848 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml @@ -57,6 +57,14 @@ requestBody: `v1/dbaas/alerts/memory_utilization_alerts` | alert on the percent memory utilization average across the database cluster | database cluster UUID `v1/dbaas/alerts/disk_utilization_alerts` | alert on the percent disk utilization average across the database cluster | database cluster UUID `v1/dbaas/alerts/cpu_alerts` | alert on the percent CPU usage average across the database cluster | database cluster UUID + `v1/droplet/autoscale_alerts/current_instances` | alert on current pool size | autoscale pool ID + `v1/droplet/autoscale_alerts/target_instances` | alert on target pool size | autoscale pool ID + `v1/droplet/autoscale_alerts/current_cpu_utilization` | alert on current average CPU utilization | autoscale pool ID + `v1/droplet/autoscale_alerts/target_cpu_utilization` | alert on target average CPU utilization | autoscale pool ID + `v1/droplet/autoscale_alerts/current_memory_utilization` | alert on current average memory utilization | autoscale pool ID + `v1/droplet/autoscale_alerts/target_memory_utilization` | alert on target average memory utilization | autoscale pool ID + `v1/droplet/autoscale_alerts/scale_up` | alert on scale up event | autoscale pool ID + `v1/droplet/autoscale_alerts/scale_down` | alert on scale down event | autoscale pool ID required: true content: application/json: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_current_cpu_utilization.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_current_cpu_utilization.yml new file mode 100644 index 000000000..d29deaacc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_current_cpu_utilization.yml @@ -0,0 +1,38 @@ +operationId: monitoring_get_droplet_autoscale_current_cpu_utilization.yml + +summary: Get Droplet Autoscale Pool Current Average CPU utilization + +description: >- + To retrieve the current average CPU utilization for a given Droplet Autoscale Pool, + send a GET request to `/v2/monitoring/metrics/droplet_autoscale/current_cpu_utilization`. + +tags: + - Monitoring + +responses: + '200': + $ref: 'responses/metric_response.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +parameters: + - $ref: 'parameters.yml#/autoscale_pool_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_droplet_autoscale_current_cpu_utilization.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_current_instances.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_current_instances.yml new file mode 100644 index 000000000..ff778a03d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_current_instances.yml @@ -0,0 +1,38 @@ +operationId: monitoring_get_droplet_autoscale_current_instances + +summary: Get Droplet Autoscale Pool Current Size + +description: >- + To retrieve the current size for a given Droplet Autoscale Pool, + send a GET request to `/v2/monitoring/metrics/droplet_autoscale/current_instances`. + +tags: + - Monitoring + +responses: + '200': + $ref: 'responses/metric_response.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +parameters: + - $ref: 'parameters.yml#/autoscale_pool_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_droplet_autoscale_current_instances.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_current_memory_utilization.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_current_memory_utilization.yml new file mode 100644 index 000000000..7781f7684 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_current_memory_utilization.yml @@ -0,0 +1,38 @@ +operationId: monitoring_get_droplet_autoscale_current_memory_utilization + +summary: Get Droplet Autoscale Pool Current Average Memory utilization + +description: >- + To retrieve the current average memory utilization for a given Droplet Autoscale Pool, + send a GET request to `/v2/monitoring/metrics/droplet_autoscale/current_memory_utilization`. + +tags: + - Monitoring + +responses: + '200': + $ref: 'responses/metric_response.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +parameters: + - $ref: 'parameters.yml#/autoscale_pool_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_droplet_autoscale_current_memory_utilization.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_target_cpu_utilization.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_target_cpu_utilization.yml new file mode 100644 index 000000000..3816679b0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_target_cpu_utilization.yml @@ -0,0 +1,38 @@ +operationId: monitoring_get_droplet_autoscale_target_cpu_utilization + +summary: Get Droplet Autoscale Pool Target Average CPU utilization + +description: >- + To retrieve the target average CPU utilization for a given Droplet Autoscale Pool, + send a GET request to `/v2/monitoring/metrics/droplet_autoscale/target_cpu_utilization`. + +tags: + - Monitoring + +responses: + '200': + $ref: 'responses/metric_response.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +parameters: + - $ref: 'parameters.yml#/autoscale_pool_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_droplet_autoscale_target_cpu_utilization.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_target_instances.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_target_instances.yml new file mode 100644 index 000000000..c305ef438 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_target_instances.yml @@ -0,0 +1,38 @@ +operationId: monitoring_get_droplet_autoscale_target_instances + +summary: Get Droplet Autoscale Pool Target Size + +description: >- + To retrieve the target size for a given Droplet Autoscale Pool, + send a GET request to `/v2/monitoring/metrics/droplet_autoscale/target_instances`. + +tags: + - Monitoring + +responses: + '200': + $ref: 'responses/metric_response.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +parameters: + - $ref: 'parameters.yml#/autoscale_pool_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_droplet_autoscale_target_instances.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_target_memory_utilization.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_target_memory_utilization.yml new file mode 100644 index 000000000..8e1dfb252 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_droplet_autoscale_target_memory_utilization.yml @@ -0,0 +1,38 @@ +operationId: monitoring_get_droplet_autoscale_target_memory_utilization + +summary: Get Droplet Autoscale Pool Target Average Memory utilization + +description: >- + To retrieve the target average memory utilization for a given Droplet Autoscale Pool, + send a GET request to `/v2/monitoring/metrics/droplet_autoscale/target_memory_utilization`. + +tags: + - Monitoring + +responses: + '200': + $ref: 'responses/metric_response.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '429': + $ref: '../../shared/responses/too_many_requests.yml' + + '500': + $ref: '../../shared/responses/server_error.yml' + + default: + $ref: '../../shared/responses/unexpected_error.yml' + +parameters: + - $ref: 'parameters.yml#/autoscale_pool_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +x-codeSamples: + - $ref: 'examples/curl/monitoring_get_droplet_autoscale_target_memory_utilization.yml' + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml index 6d1b99516..a6213f154 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml @@ -62,6 +62,14 @@ requestBody: `v1/dbaas/alerts/memory_utilization_alerts` | alert on the percent memory utilization average across the database cluster | database cluster UUID `v1/dbaas/alerts/disk_utilization_alerts` | alert on the percent disk utilization average across the database cluster | database cluster UUID `v1/dbaas/alerts/cpu_alerts` | alert on the percent CPU usage average across the database cluster | database cluster UUID + `v1/droplet/autoscale_alerts/current_instances` | alert on current pool size | autoscale pool ID + `v1/droplet/autoscale_alerts/target_instances` | alert on target pool size | autoscale pool ID + `v1/droplet/autoscale_alerts/current_cpu_utilization` | alert on current average CPU utilization | autoscale pool ID + `v1/droplet/autoscale_alerts/target_cpu_utilization` | alert on target average CPU utilization | autoscale pool ID + `v1/droplet/autoscale_alerts/current_memory_utilization` | alert on current average memory utilization | autoscale pool ID + `v1/droplet/autoscale_alerts/target_memory_utilization` | alert on target average memory utilization | autoscale pool ID + `v1/droplet/autoscale_alerts/scale_up` | alert on scale up event | autoscale pool ID + `v1/droplet/autoscale_alerts/scale_down` | alert on scale down event | autoscale pool ID required: true content: application/json: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml index f39555717..72f7561eb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml @@ -53,6 +53,7 @@ network_interface: enum: - private - public + network_direction: in: query name: direction @@ -64,6 +65,16 @@ network_direction: enum: - inbound - outbound + +autoscale_pool_id: + in: query + name: autoscale_pool_id + description: A unique identifier for an autoscale pool. + required: true + schema: + type: string + example: 0d3db13e-a604-4944-9827-7ec2642d32ac + metric_timestamp_start: in: query name: start diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_get.yml index ec0572fac..f5216907e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_get.yml @@ -46,3 +46,4 @@ x-codeSamples: security: - bearer_auth: - 'snapshot:read' + - 'block_storage_snapshot:read' diff --git a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts index ef5a93651..699297eb3 100644 --- a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts @@ -1763,6 +1763,164 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/actions/hosted-runners": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List GitHub-hosted runners for an organization + * @description Lists all GitHub-hosted runners configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. + */ + readonly get: operations["actions/list-hosted-runners-for-org"]; + readonly put?: never; + /** + * Create a GitHub-hosted runner for an organization + * @description Creates a GitHub-hosted runner for an organization. + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + readonly post: operations["actions/create-hosted-runner-for-org"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/hosted-runners/images/github-owned": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get GitHub-owned images for GitHub-hosted runners in an organization + * @description Get the list of GitHub-owned images available for GitHub-hosted runners for an organization. + */ + readonly get: operations["actions/get-hosted-runners-github-owned-images-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/hosted-runners/images/partner": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get partner images for GitHub-hosted runners in an organization + * @description Get the list of partner images available for GitHub-hosted runners for an organization. + */ + readonly get: operations["actions/get-hosted-runners-partner-images-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/hosted-runners/limits": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get limits on GitHub-hosted runners for an organization + * @description Get the GitHub-hosted runners limits for an organization. + */ + readonly get: operations["actions/get-hosted-runners-limits-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/hosted-runners/machine-sizes": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get GitHub-hosted runners machine specs for an organization + * @description Get the list of machine specs available for GitHub-hosted runners for an organization. + */ + readonly get: operations["actions/get-hosted-runners-machine-specs-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/hosted-runners/platforms": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get platforms for GitHub-hosted runners in an organization + * @description Get the list of platforms available for GitHub-hosted runners for an organization. + */ + readonly get: operations["actions/get-hosted-runners-platforms-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a GitHub-hosted runner for an organization + * @description Gets a GitHub-hosted runner configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + readonly get: operations["actions/get-hosted-runner-for-org"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a GitHub-hosted runner for an organization + * @description Deletes a GitHub-hosted runner for an organization. + */ + readonly delete: operations["actions/delete-hosted-runner-for-org"]; + readonly options?: never; + readonly head?: never; + /** + * Update a GitHub-hosted runner for an organization + * @description Updates a GitHub-hosted runner for an organization. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + readonly patch: operations["actions/update-hosted-runner-for-org"]; + readonly trace?: never; + }; readonly "/orgs/{org}/actions/oidc/customization/sub": { readonly parameters: { readonly query?: never; @@ -1998,6 +2156,28 @@ export type paths = { readonly patch: operations["actions/update-self-hosted-runner-group-for-org"]; readonly trace?: never; }; + readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List GitHub-hosted runners in a group for an organization + * @description Lists the GitHub-hosted runners in an organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["actions/list-github-hosted-runners-in-group-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { readonly parameters: { readonly query?: never; @@ -5622,6 +5802,90 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/settings/network-configurations": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List hosted compute network configurations for an organization + * @description Lists all hosted compute network configurations configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + readonly get: operations["hosted-compute/list-network-configurations-for-org"]; + readonly put?: never; + /** + * Create a hosted compute network configuration for an organization + * @description Creates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + readonly post: operations["hosted-compute/create-network-configuration-for-org"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a hosted compute network configuration for an organization + * @description Gets a hosted compute network configuration configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + readonly get: operations["hosted-compute/get-network-configuration-for-org"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a hosted compute network configuration from an organization + * @description Deletes a hosted compute network configuration from an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + readonly delete: operations["hosted-compute/delete-network-configuration-from-org"]; + readonly options?: never; + readonly head?: never; + /** + * Update a hosted compute network configuration for an organization + * @description Updates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + readonly patch: operations["hosted-compute/update-network-configuration-for-org"]; + readonly trace?: never; + }; + readonly "/orgs/{org}/settings/network-settings/{network_settings_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a hosted compute network settings resource for an organization + * @description Gets a hosted compute network settings resource configured for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + readonly get: operations["hosted-compute/get-network-settings-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/team/{team_slug}/copilot/metrics": { readonly parameters: { readonly query?: never; @@ -8205,19 +8469,19 @@ export type paths = { readonly cookie?: never; }; /** - * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Check if Dependabot security updates are enabled for a repository + * @description Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ readonly get: operations["repos/check-automated-security-fixes"]; /** - * Enable automated security fixes - * @description Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Enable Dependabot security updates + * @description Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ readonly put: operations["repos/enable-automated-security-fixes"]; readonly post?: never; /** - * Disable automated security fixes - * @description Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Disable Dependabot security updates + * @description Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ readonly delete: operations["repos/disable-automated-security-fixes"]; readonly options?: never; @@ -14299,7 +14563,7 @@ export type paths = { }; /** * Get secret scanning scan history for a repository - * @description Lists the latest incremental and backfill scans by type for a repository. + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -17347,9 +17611,11 @@ export type paths = { * Get a user using their ID * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ readonly get: operations["users/get-by-id"]; readonly put?: never; @@ -17393,9 +17659,11 @@ export type paths = { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ readonly get: operations["users/get-by-username"]; readonly put?: never; @@ -18254,6 +18522,11 @@ export type components = { readonly score: number | null; } | null; } | null; + /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + readonly "security-advisory-epss": { + readonly percentage?: number; + readonly percentile?: number; + } | null; /** * Simple User * @description A GitHub user. @@ -18415,16 +18688,13 @@ export type components = { readonly score: number | null; } | null; readonly cvss_severities?: components["schemas"]["cvss-severities"]; + readonly epss?: components["schemas"]["security-advisory-epss"]; readonly cwes: readonly { /** @description The Common Weakness Enumeration (CWE) identifier. */ readonly cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - readonly epss?: { - readonly percentage?: number; - readonly percentile?: number; - } | null; /** @description The users who contributed to the advisory. */ readonly credits: readonly { readonly user: components["schemas"]["simple-user"]; @@ -18451,79 +18721,52 @@ export type components = { readonly errors?: readonly string[]; }; /** - * Simple User - * @description A GitHub user. + * Enterprise + * @description An enterprise on GitHub. */ - readonly "nullable-simple-user": { - readonly name?: string | null; - readonly email?: string | null; - /** @example octocat */ - readonly login: string; - /** - * Format: int64 - * @example 1 - */ - readonly id: number; - /** @example MDQ6VXNlcjE= */ - readonly node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + readonly enterprise: { + /** @description A short description of the enterprise. */ + readonly description?: string | null; /** * Format: uri - * @example https://api.github.com/users/octocat + * @example https://github.com/enterprises/octo-business */ - readonly url: string; + readonly html_url: string; /** * Format: uri - * @example https://github.com/octocat + * @description The enterprise's website URL. */ - readonly html_url: string; + readonly website_url?: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/followers + * @description Unique identifier of the enterprise + * @example 42 */ - readonly followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + readonly id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + readonly node_id: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions + * @description The name of the enterprise. + * @example Octo Business */ - readonly subscriptions_url: string; + readonly name: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs + * @description The slug url identifier for the enterprise. + * @example octo-business */ - readonly organizations_url: string; + readonly slug: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/repos + * Format: date-time + * @example 2019-01-26T19:01:12Z */ - readonly repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + readonly created_at: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events + * Format: date-time + * @example 2019-01-26T19:14:43Z */ - readonly received_events_url: string; - /** @example User */ - readonly type: string; - readonly site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; - /** @example public */ - readonly user_view_type?: string; - } | null; + readonly updated_at: string | null; + /** Format: uri */ + readonly avatar_url: string; + }; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -18543,7 +18786,7 @@ export type components = { readonly node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ readonly client_id?: string; - readonly owner: components["schemas"]["nullable-simple-user"]; + readonly owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners @@ -18821,53 +19064,6 @@ export type components = { readonly payload: string | null; }; }; - /** - * Enterprise - * @description An enterprise on GitHub. - */ - readonly enterprise: { - /** @description A short description of the enterprise. */ - readonly description?: string | null; - /** - * Format: uri - * @example https://github.com/enterprises/octo-business - */ - readonly html_url: string; - /** - * Format: uri - * @description The enterprise's website URL. - */ - readonly website_url?: string | null; - /** - * @description Unique identifier of the enterprise - * @example 42 - */ - readonly id: number; - /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; - /** - * @description The name of the enterprise. - * @example Octo Business - */ - readonly name: string; - /** - * @description The slug url identifier for the enterprise. - * @example octo-business - */ - readonly slug: string; - /** - * Format: date-time - * @example 2019-01-26T19:01:12Z - */ - readonly created_at: string | null; - /** - * Format: date-time - * @example 2019-01-26T19:14:43Z - */ - readonly updated_at: string | null; - /** Format: uri */ - readonly avatar_url: string; - }; /** * Integration Installation Request * @description Request to install an integration on a target @@ -19140,6 +19336,80 @@ export type components = { */ readonly starring?: "read" | "write"; }; + /** + * Simple User + * @description A GitHub user. + */ + readonly "nullable-simple-user": { + readonly name?: string | null; + readonly email?: string | null; + /** @example octocat */ + readonly login: string; + /** + * Format: int64 + * @example 1 + */ + readonly id: number; + /** @example MDQ6VXNlcjE= */ + readonly node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + readonly avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + readonly gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + readonly url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + readonly html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + readonly followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + readonly following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + readonly gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + readonly starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + readonly subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + readonly organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + readonly repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + readonly events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + readonly received_events_url: string; + /** @example User */ + readonly type: string; + readonly site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + readonly starred_at?: string; + /** @example public */ + readonly user_view_type?: string; + } | null; /** * Installation * @description Installation @@ -20540,6 +20810,7 @@ export type components = { readonly vector_string: string | null; }; readonly cvss_severities?: components["schemas"]["cvss-severities"]; + readonly epss?: components["schemas"]["security-advisory-epss"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: readonly { /** @description The unique CWE ID. */ @@ -20828,7 +21099,7 @@ export type components = { readonly node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ readonly client_id?: string; - readonly owner: components["schemas"]["nullable-simple-user"]; + readonly owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners @@ -21193,6 +21464,7 @@ export type components = { readonly updated_at: string; readonly description: string | null; readonly comments: number; + readonly comments_enabled?: boolean; readonly user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ readonly comments_url: string; @@ -21344,6 +21616,7 @@ export type components = { readonly updated_at: string; readonly description: string | null; readonly comments: number; + readonly comments_enabled?: boolean; readonly user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ readonly comments_url: string; @@ -21381,6 +21654,7 @@ export type components = { readonly updated_at?: string; readonly description?: string | null; readonly comments?: number; + readonly comments_enabled?: boolean; readonly user?: string | null; readonly comments_url?: string; readonly owner?: components["schemas"]["simple-user"]; @@ -22320,6 +22594,186 @@ export type components = { */ readonly active_caches_count: number; }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + readonly "nullable-actions-hosted-runner-pool-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example ubuntu-20.04 + */ + readonly id: string; + /** + * @description Image size in GB. + * @example 86 + */ + readonly size_gb: number; + /** + * @description Display name for this image. + * @example 20.04 + */ + readonly display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + readonly source: "github" | "partner" | "custom"; + /** + * @description The image version of the hosted runner pool. + * @example latest + */ + readonly version: string; + } | null; + /** + * Github-owned VM details. + * @description Provides details of a particular machine spec. + */ + readonly "actions-hosted-runner-machine-spec": { + /** + * @description The ID used for the `size` parameter when creating a new runner. + * @example 8-core + */ + readonly id: string; + /** + * @description The number of cores. + * @example 8 + */ + readonly cpu_cores: number; + /** + * @description The available RAM for the machine spec. + * @example 32 + */ + readonly memory_gb: number; + /** + * @description The available SSD storage for the machine spec. + * @example 300 + */ + readonly storage_gb: number; + }; + /** + * Public IP for a GitHub-hosted larger runners. + * @description Provides details of Public IP for a GitHub-hosted larger runners + */ + readonly "public-ip": { + /** + * @description Whether public IP is enabled. + * @example true + */ + readonly enabled?: boolean; + /** + * @description The prefix for the public IP. + * @example 20.80.208.150 + */ + readonly prefix?: string; + /** + * @description The length of the IP prefix. + * @example 28 + */ + readonly length?: number; + }; + /** + * GitHub-hosted hosted runner + * @description A Github-hosted hosted runner. + */ + readonly "actions-hosted-runner": { + /** + * @description The unique identifier of the hosted runner. + * @example 5 + */ + readonly id: number; + /** + * @description The name of the hosted runner. + * @example my-github-hosted-runner + */ + readonly name: string; + /** + * @description The unique identifier of the group that the hosted runner belongs to. + * @example 2 + */ + readonly runner_group_id?: number; + readonly image_details: components["schemas"]["nullable-actions-hosted-runner-pool-image"]; + readonly machine_size_details: components["schemas"]["actions-hosted-runner-machine-spec"]; + /** + * @description The status of the runner. + * @example Ready + * @enum {string} + */ + readonly status: "Ready" | "Provisioning" | "Shutdown" | "Deleting" | "Stuck"; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + readonly platform: string; + /** + * @description The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. + * @default 10 + * @example 5 + */ + readonly maximum_runners: number; + /** + * @description Whether public IP is enabled for the hosted runners. + * @example true + */ + readonly public_ip_enabled: boolean; + /** @description The public IP ranges when public IP is enabled for the hosted runners. */ + readonly public_ips?: readonly components["schemas"]["public-ip"][]; + /** + * Format: date-time + * @description The time at which the runner was last used, in ISO 8601 format. + * @example 2022-10-09T23:39:01Z + */ + readonly last_active_on?: string | null; + }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + readonly "actions-hosted-runner-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example ubuntu-20.04 + */ + readonly id: string; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + readonly platform: string; + /** + * @description Image size in GB. + * @example 86 + */ + readonly size_gb: number; + /** + * @description Display name for this image. + * @example 20.04 + */ + readonly display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + readonly source: "github" | "partner" | "custom"; + }; + readonly "actions-hosted-runner-limits": { + /** + * Static public IP Limits for GitHub-hosted Hosted Runners. + * @description Provides details of static public IP limits for GitHub-hosted Hosted Runners + */ + readonly public_ips: { + /** + * @description The maximum number of static public IP addresses that can be used for Hosted Runners. + * @example 50 + */ + readonly maximum: number; + /** + * @description The current number of static public IP addresses in use by Hosted Runners. + * @example 17 + */ + readonly current_usage: number; + }; + }; /** * Actions OIDC Subject customization * @description Actions OIDC Subject customization @@ -22387,6 +22841,8 @@ export type components = { readonly selected_repositories_url?: string; readonly runners_url: string; readonly hosted_runners_url?: string; + /** @description The identifier of a hosted compute network configuration. */ + readonly network_configuration_id?: string; readonly inherited: boolean; readonly inherited_allows_public_repositories?: boolean; readonly allows_public_repositories: boolean; @@ -23163,6 +23619,8 @@ export type components = { readonly sync_to_organizations: string; /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ readonly group_id?: string | null; + /** @example Justice League */ + readonly group_name?: string | null; /** * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league @@ -26009,6 +26467,69 @@ export type components = { /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ readonly estimated_storage_for_month: number; }; + /** + * Hosted compute network configuration + * @description A hosted compute network configuration. + */ + readonly "network-configuration": { + /** + * @description The unique identifier of the network configuration. + * @example 123ABC456DEF789 + */ + readonly id: string; + /** + * @description The name of the network configuration. + * @example my-network-configuration + */ + readonly name: string; + /** + * @description The hosted compute service the network configuration supports. + * @enum {string} + */ + readonly compute_service?: "none" | "actions" | "codespaces"; + /** + * @description The unique identifier of each network settings in the configuration. + * @example 123ABC456DEF789 + */ + readonly network_settings_ids?: readonly string[]; + /** + * Format: date-time + * @description The time at which the network configuration was created, in ISO 8601 format. + * @example 2024-04-26T11:31:07Z + */ + readonly created_on: string | null; + }; + /** + * Hosted compute network settings resource + * @description A hosted compute network settings resource. + */ + readonly "network-settings": { + /** + * @description The unique identifier of the network settings resource. + * @example 220F78DACB92BBFBC5E6F22DE1CCF52309D + */ + readonly id: string; + /** + * @description The identifier of the network configuration that is using this settings resource. + * @example 934E208B3EE0BD60CF5F752C426BFB53562 + */ + readonly network_configuration_id?: string; + /** + * @description The name of the network settings resource. + * @example my-network-settings + */ + readonly name: string; + /** + * @description The subnet this network settings resource is configured for. + * @example /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet + */ + readonly subnet_id: string; + /** + * @description The location of the subnet this network settings resource is configured for. + * @example eastus + */ + readonly region: string; + }; /** * Team Organization * @description Team Organization @@ -27709,17 +28230,17 @@ export type components = { readonly is_alphanumeric: boolean; }; /** - * Check Automated Security Fixes - * @description Check Automated Security Fixes + * Check Dependabot security updates + * @description Check Dependabot security updates */ readonly "check-automated-security-fixes": { /** - * @description Whether automated security fixes are enabled for the repository. + * @description Whether Dependabot security updates are enabled for the repository. * @example true */ readonly enabled: boolean; /** - * @description Whether automated security fixes are paused for the repository. + * @description Whether Dependabot security updates are paused for the repository. * @example false */ readonly paused: boolean; @@ -28822,6 +29343,16 @@ export type components = { readonly state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + /** + * @description Runner type to be used. + * @enum {string|null} + */ + readonly runner_type?: "standard" | "labeled" | null; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + readonly runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -40713,11 +41244,14 @@ export type components = { readonly url?: string; readonly user_view_type?: string; } | null; + readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -40765,10 +41299,10 @@ export type components = { readonly severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - readonly state: "open" | "dismissed" | "fixed"; + readonly state: "open" | "dismissed" | "fixed" | null; readonly tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; @@ -40840,11 +41374,14 @@ export type components = { readonly url?: string; readonly user_view_type?: string; } | null; + readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -40937,6 +41474,7 @@ export type components = { readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ readonly dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly fixed_at?: unknown; /** * Format: uri @@ -40992,7 +41530,7 @@ export type components = { readonly tags?: readonly string[] | null; }; /** - * @description State of a code scanning alert. + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ readonly state: "open" | "dismissed" | null; @@ -41069,11 +41607,14 @@ export type components = { readonly url?: string; readonly user_view_type?: string; } | null; + readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41129,10 +41670,10 @@ export type components = { readonly tags?: readonly string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - readonly state: "fixed"; + readonly state: "fixed" | null; readonly tool: { readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41165,8 +41706,11 @@ export type components = { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly dismissed_at: string | null; readonly dismissed_by: Record | null; + readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ readonly dismissed_reason: string | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41220,10 +41764,10 @@ export type components = { readonly tags?: readonly string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - readonly state: "open" | "dismissed" | "fixed"; + readonly state: "open" | "dismissed" | "fixed" | null; readonly tool: { readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41258,8 +41802,11 @@ export type components = { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly dismissed_at: unknown; readonly dismissed_by: unknown; + readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ readonly dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41307,10 +41854,10 @@ export type components = { readonly severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - readonly state: "open" | "fixed"; + readonly state: "open" | "fixed" | null; readonly tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; @@ -87047,12 +87594,20 @@ export type components = { readonly "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ readonly "dependabot-alert-comma-separated-packages": string; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + readonly "dependabot-alert-comma-separated-epss": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ readonly "dependabot-alert-scope": "development" | "runtime"; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ - readonly "dependabot-alert-sort": "created" | "updated"; + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ + readonly "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ @@ -87111,6 +87666,8 @@ export type components = { readonly "billing-usage-report-day": number; /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ readonly "billing-usage-report-hour": number; + /** @description Unique identifier of the GitHub-hosted runner. */ + readonly "hosted-runner-id": number; /** @description The unique identifier of the repository. */ readonly "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -87222,6 +87779,10 @@ export type components = { readonly "secret-scanning-pagination-before-org-repo": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ readonly "secret-scanning-pagination-after-org-repo": string; + /** @description Unique identifier of the hosted compute network configuration. */ + readonly "network-configuration-id": string; + /** @description Unique identifier of the hosted compute network settings. */ + readonly "network-settings-id": string; /** @description The number that identifies the discussion. */ readonly "discussion-number": number; /** @description The number that identifies the comment. */ @@ -88742,11 +89303,19 @@ export interface operations { readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ readonly scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ readonly sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; @@ -90593,6 +91162,306 @@ export interface operations { }; }; }; + readonly "actions/list-hosted-runners-for-org": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly runners: readonly components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; + readonly "actions/create-hosted-runner-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + readonly name: string; + /** @description The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + readonly image: { + /** @description The unique identifier of the runner image. */ + readonly id?: string; + /** + * @description The source of the runner image. + * @enum {string} + */ + readonly source?: "github" | "partner" | "custom"; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + readonly version?: string | null; + }; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + readonly size: string; + /** @description The existing runner group to add this runner to. */ + readonly runner_group_id: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + readonly maximum_runners?: number; + /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + readonly enable_static_ip?: boolean; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + readonly "actions/get-hosted-runners-github-owned-images-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly images: readonly components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + readonly "actions/get-hosted-runners-partner-images-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly images: readonly components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + readonly "actions/get-hosted-runners-limits-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-hosted-runner-limits"]; + }; + }; + }; + }; + readonly "actions/get-hosted-runners-machine-specs-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly machine_specs: readonly components["schemas"]["actions-hosted-runner-machine-spec"][]; + }; + }; + }; + }; + }; + readonly "actions/get-hosted-runners-platforms-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly platforms: readonly string[]; + }; + }; + }; + }; + }; + readonly "actions/get-hosted-runner-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + readonly hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + readonly "actions/delete-hosted-runner-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + readonly hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 202: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + readonly "actions/update-hosted-runner-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + readonly hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + readonly name?: string; + /** @description The existing runner group to add this runner to. */ + readonly runner_group_id?: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + readonly maximum_runners?: number; + /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + readonly enable_static_ip?: boolean; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + readonly image_version?: string | null; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; readonly "oidc/get-oidc-custom-sub-template-for-org": { readonly parameters: { readonly query?: never; @@ -90967,6 +91836,8 @@ export interface operations { readonly restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ readonly selected_workflows?: readonly string[]; + /** @description The identifier of a hosted compute network configuration. */ + readonly network_configuration_id?: string; }; }; }; @@ -91064,6 +91935,8 @@ export interface operations { readonly restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ readonly selected_workflows?: readonly string[]; + /** @description The identifier of a hosted compute network configuration. */ + readonly network_configuration_id?: string | null; }; }; }; @@ -91079,6 +91952,40 @@ export interface operations { }; }; }; + readonly "actions/list-github-hosted-runners-in-group-for-org": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly runners: readonly components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; readonly "actions/list-repo-access-to-self-hosted-runner-group-in-org": { readonly parameters: { readonly query?: { @@ -93660,11 +94567,19 @@ export interface operations { readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ readonly scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ readonly sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; @@ -97833,6 +98748,189 @@ export interface operations { }; }; }; + readonly "hosted-compute/list-network-configurations-for-org": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly network_configurations: readonly components["schemas"]["network-configuration"][]; + }; + }; + }; + }; + }; + readonly "hosted-compute/create-network-configuration-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + readonly name: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + readonly compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + readonly network_settings_ids: readonly string[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + readonly "hosted-compute/get-network-configuration-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + readonly network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + readonly "hosted-compute/delete-network-configuration-from-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + readonly network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "hosted-compute/update-network-configuration-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + readonly network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + readonly name?: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + readonly compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + readonly network_settings_ids?: readonly string[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + readonly "hosted-compute/get-network-settings-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network settings. */ + readonly network_settings_id: components["parameters"]["network-settings-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["network-settings"]; + }; + }; + }; + }; readonly "copilot/copilot-metrics-for-team": { readonly parameters: { readonly query?: { @@ -106913,11 +108011,19 @@ export interface operations { readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ readonly manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ readonly scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ readonly sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; @@ -111072,7 +112178,7 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description The sub-issue to remove */ + /** @description The id of the sub-issue to remove */ readonly sub_issue_id: number; }; }; @@ -111145,7 +112251,7 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description The sub-issue to add */ + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ readonly sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ readonly replace_parent?: boolean; @@ -115892,7 +116998,7 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ readonly names: readonly string[]; }; }; diff --git a/packages/openapi-typescript/examples/github-api-immutable.ts b/packages/openapi-typescript/examples/github-api-immutable.ts index 966d6b87c..25a97d3f9 100644 --- a/packages/openapi-typescript/examples/github-api-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-immutable.ts @@ -1763,6 +1763,164 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/actions/hosted-runners": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List GitHub-hosted runners for an organization + * @description Lists all GitHub-hosted runners configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. + */ + readonly get: operations["actions/list-hosted-runners-for-org"]; + readonly put?: never; + /** + * Create a GitHub-hosted runner for an organization + * @description Creates a GitHub-hosted runner for an organization. + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + readonly post: operations["actions/create-hosted-runner-for-org"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/hosted-runners/images/github-owned": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get GitHub-owned images for GitHub-hosted runners in an organization + * @description Get the list of GitHub-owned images available for GitHub-hosted runners for an organization. + */ + readonly get: operations["actions/get-hosted-runners-github-owned-images-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/hosted-runners/images/partner": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get partner images for GitHub-hosted runners in an organization + * @description Get the list of partner images available for GitHub-hosted runners for an organization. + */ + readonly get: operations["actions/get-hosted-runners-partner-images-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/hosted-runners/limits": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get limits on GitHub-hosted runners for an organization + * @description Get the GitHub-hosted runners limits for an organization. + */ + readonly get: operations["actions/get-hosted-runners-limits-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/hosted-runners/machine-sizes": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get GitHub-hosted runners machine specs for an organization + * @description Get the list of machine specs available for GitHub-hosted runners for an organization. + */ + readonly get: operations["actions/get-hosted-runners-machine-specs-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/hosted-runners/platforms": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get platforms for GitHub-hosted runners in an organization + * @description Get the list of platforms available for GitHub-hosted runners for an organization. + */ + readonly get: operations["actions/get-hosted-runners-platforms-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a GitHub-hosted runner for an organization + * @description Gets a GitHub-hosted runner configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + readonly get: operations["actions/get-hosted-runner-for-org"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a GitHub-hosted runner for an organization + * @description Deletes a GitHub-hosted runner for an organization. + */ + readonly delete: operations["actions/delete-hosted-runner-for-org"]; + readonly options?: never; + readonly head?: never; + /** + * Update a GitHub-hosted runner for an organization + * @description Updates a GitHub-hosted runner for an organization. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + readonly patch: operations["actions/update-hosted-runner-for-org"]; + readonly trace?: never; + }; readonly "/orgs/{org}/actions/oidc/customization/sub": { readonly parameters: { readonly query?: never; @@ -1998,6 +2156,28 @@ export interface paths { readonly patch: operations["actions/update-self-hosted-runner-group-for-org"]; readonly trace?: never; }; + readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List GitHub-hosted runners in a group for an organization + * @description Lists the GitHub-hosted runners in an organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + readonly get: operations["actions/list-github-hosted-runners-in-group-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { readonly parameters: { readonly query?: never; @@ -5622,6 +5802,90 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/settings/network-configurations": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List hosted compute network configurations for an organization + * @description Lists all hosted compute network configurations configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + readonly get: operations["hosted-compute/list-network-configurations-for-org"]; + readonly put?: never; + /** + * Create a hosted compute network configuration for an organization + * @description Creates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + readonly post: operations["hosted-compute/create-network-configuration-for-org"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a hosted compute network configuration for an organization + * @description Gets a hosted compute network configuration configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + readonly get: operations["hosted-compute/get-network-configuration-for-org"]; + readonly put?: never; + readonly post?: never; + /** + * Delete a hosted compute network configuration from an organization + * @description Deletes a hosted compute network configuration from an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + readonly delete: operations["hosted-compute/delete-network-configuration-from-org"]; + readonly options?: never; + readonly head?: never; + /** + * Update a hosted compute network configuration for an organization + * @description Updates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + readonly patch: operations["hosted-compute/update-network-configuration-for-org"]; + readonly trace?: never; + }; + readonly "/orgs/{org}/settings/network-settings/{network_settings_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a hosted compute network settings resource for an organization + * @description Gets a hosted compute network settings resource configured for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + readonly get: operations["hosted-compute/get-network-settings-for-org"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/team/{team_slug}/copilot/metrics": { readonly parameters: { readonly query?: never; @@ -8205,19 +8469,19 @@ export interface paths { readonly cookie?: never; }; /** - * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Check if Dependabot security updates are enabled for a repository + * @description Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ readonly get: operations["repos/check-automated-security-fixes"]; /** - * Enable automated security fixes - * @description Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Enable Dependabot security updates + * @description Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ readonly put: operations["repos/enable-automated-security-fixes"]; readonly post?: never; /** - * Disable automated security fixes - * @description Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Disable Dependabot security updates + * @description Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ readonly delete: operations["repos/disable-automated-security-fixes"]; readonly options?: never; @@ -14299,7 +14563,7 @@ export interface paths { }; /** * Get secret scanning scan history for a repository - * @description Lists the latest incremental and backfill scans by type for a repository. + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -17347,9 +17611,11 @@ export interface paths { * Get a user using their ID * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ readonly get: operations["users/get-by-id"]; readonly put?: never; @@ -17393,9 +17659,11 @@ export interface paths { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ readonly get: operations["users/get-by-username"]; readonly put?: never; @@ -18254,6 +18522,11 @@ export interface components { readonly score: number | null; } | null; } | null; + /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + readonly "security-advisory-epss": { + readonly percentage?: number; + readonly percentile?: number; + } | null; /** * Simple User * @description A GitHub user. @@ -18415,16 +18688,13 @@ export interface components { readonly score: number | null; } | null; readonly cvss_severities?: components["schemas"]["cvss-severities"]; + readonly epss?: components["schemas"]["security-advisory-epss"]; readonly cwes: readonly { /** @description The Common Weakness Enumeration (CWE) identifier. */ readonly cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - readonly epss?: { - readonly percentage?: number; - readonly percentile?: number; - } | null; /** @description The users who contributed to the advisory. */ readonly credits: readonly { readonly user: components["schemas"]["simple-user"]; @@ -18451,79 +18721,52 @@ export interface components { readonly errors?: readonly string[]; }; /** - * Simple User - * @description A GitHub user. + * Enterprise + * @description An enterprise on GitHub. */ - readonly "nullable-simple-user": { - readonly name?: string | null; - readonly email?: string | null; - /** @example octocat */ - readonly login: string; - /** - * Format: int64 - * @example 1 - */ - readonly id: number; - /** @example MDQ6VXNlcjE= */ - readonly node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + readonly enterprise: { + /** @description A short description of the enterprise. */ + readonly description?: string | null; /** * Format: uri - * @example https://api.github.com/users/octocat + * @example https://github.com/enterprises/octo-business */ - readonly url: string; + readonly html_url: string; /** * Format: uri - * @example https://github.com/octocat + * @description The enterprise's website URL. */ - readonly html_url: string; + readonly website_url?: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/followers + * @description Unique identifier of the enterprise + * @example 42 */ - readonly followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + readonly id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + readonly node_id: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions + * @description The name of the enterprise. + * @example Octo Business */ - readonly subscriptions_url: string; + readonly name: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs + * @description The slug url identifier for the enterprise. + * @example octo-business */ - readonly organizations_url: string; + readonly slug: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/repos + * Format: date-time + * @example 2019-01-26T19:01:12Z */ - readonly repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + readonly created_at: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events + * Format: date-time + * @example 2019-01-26T19:14:43Z */ - readonly received_events_url: string; - /** @example User */ - readonly type: string; - readonly site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; - /** @example public */ - readonly user_view_type?: string; - } | null; + readonly updated_at: string | null; + /** Format: uri */ + readonly avatar_url: string; + }; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -18543,7 +18786,7 @@ export interface components { readonly node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ readonly client_id?: string; - readonly owner: components["schemas"]["nullable-simple-user"]; + readonly owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners @@ -18821,53 +19064,6 @@ export interface components { readonly payload: string | null; }; }; - /** - * Enterprise - * @description An enterprise on GitHub. - */ - readonly enterprise: { - /** @description A short description of the enterprise. */ - readonly description?: string | null; - /** - * Format: uri - * @example https://github.com/enterprises/octo-business - */ - readonly html_url: string; - /** - * Format: uri - * @description The enterprise's website URL. - */ - readonly website_url?: string | null; - /** - * @description Unique identifier of the enterprise - * @example 42 - */ - readonly id: number; - /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; - /** - * @description The name of the enterprise. - * @example Octo Business - */ - readonly name: string; - /** - * @description The slug url identifier for the enterprise. - * @example octo-business - */ - readonly slug: string; - /** - * Format: date-time - * @example 2019-01-26T19:01:12Z - */ - readonly created_at: string | null; - /** - * Format: date-time - * @example 2019-01-26T19:14:43Z - */ - readonly updated_at: string | null; - /** Format: uri */ - readonly avatar_url: string; - }; /** * Integration Installation Request * @description Request to install an integration on a target @@ -19140,6 +19336,80 @@ export interface components { */ readonly starring?: "read" | "write"; }; + /** + * Simple User + * @description A GitHub user. + */ + readonly "nullable-simple-user": { + readonly name?: string | null; + readonly email?: string | null; + /** @example octocat */ + readonly login: string; + /** + * Format: int64 + * @example 1 + */ + readonly id: number; + /** @example MDQ6VXNlcjE= */ + readonly node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + readonly avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + readonly gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + readonly url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + readonly html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + readonly followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + readonly following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + readonly gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + readonly starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + readonly subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + readonly organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + readonly repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + readonly events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + readonly received_events_url: string; + /** @example User */ + readonly type: string; + readonly site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + readonly starred_at?: string; + /** @example public */ + readonly user_view_type?: string; + } | null; /** * Installation * @description Installation @@ -20540,6 +20810,7 @@ export interface components { readonly vector_string: string | null; }; readonly cvss_severities?: components["schemas"]["cvss-severities"]; + readonly epss?: components["schemas"]["security-advisory-epss"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: readonly { /** @description The unique CWE ID. */ @@ -20828,7 +21099,7 @@ export interface components { readonly node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ readonly client_id?: string; - readonly owner: components["schemas"]["nullable-simple-user"]; + readonly owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners @@ -21193,6 +21464,7 @@ export interface components { readonly updated_at: string; readonly description: string | null; readonly comments: number; + readonly comments_enabled?: boolean; readonly user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ readonly comments_url: string; @@ -21344,6 +21616,7 @@ export interface components { readonly updated_at: string; readonly description: string | null; readonly comments: number; + readonly comments_enabled?: boolean; readonly user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ readonly comments_url: string; @@ -21381,6 +21654,7 @@ export interface components { readonly updated_at?: string; readonly description?: string | null; readonly comments?: number; + readonly comments_enabled?: boolean; readonly user?: string | null; readonly comments_url?: string; readonly owner?: components["schemas"]["simple-user"]; @@ -22320,6 +22594,186 @@ export interface components { */ readonly active_caches_count: number; }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + readonly "nullable-actions-hosted-runner-pool-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example ubuntu-20.04 + */ + readonly id: string; + /** + * @description Image size in GB. + * @example 86 + */ + readonly size_gb: number; + /** + * @description Display name for this image. + * @example 20.04 + */ + readonly display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + readonly source: "github" | "partner" | "custom"; + /** + * @description The image version of the hosted runner pool. + * @example latest + */ + readonly version: string; + } | null; + /** + * Github-owned VM details. + * @description Provides details of a particular machine spec. + */ + readonly "actions-hosted-runner-machine-spec": { + /** + * @description The ID used for the `size` parameter when creating a new runner. + * @example 8-core + */ + readonly id: string; + /** + * @description The number of cores. + * @example 8 + */ + readonly cpu_cores: number; + /** + * @description The available RAM for the machine spec. + * @example 32 + */ + readonly memory_gb: number; + /** + * @description The available SSD storage for the machine spec. + * @example 300 + */ + readonly storage_gb: number; + }; + /** + * Public IP for a GitHub-hosted larger runners. + * @description Provides details of Public IP for a GitHub-hosted larger runners + */ + readonly "public-ip": { + /** + * @description Whether public IP is enabled. + * @example true + */ + readonly enabled?: boolean; + /** + * @description The prefix for the public IP. + * @example 20.80.208.150 + */ + readonly prefix?: string; + /** + * @description The length of the IP prefix. + * @example 28 + */ + readonly length?: number; + }; + /** + * GitHub-hosted hosted runner + * @description A Github-hosted hosted runner. + */ + readonly "actions-hosted-runner": { + /** + * @description The unique identifier of the hosted runner. + * @example 5 + */ + readonly id: number; + /** + * @description The name of the hosted runner. + * @example my-github-hosted-runner + */ + readonly name: string; + /** + * @description The unique identifier of the group that the hosted runner belongs to. + * @example 2 + */ + readonly runner_group_id?: number; + readonly image_details: components["schemas"]["nullable-actions-hosted-runner-pool-image"]; + readonly machine_size_details: components["schemas"]["actions-hosted-runner-machine-spec"]; + /** + * @description The status of the runner. + * @example Ready + * @enum {string} + */ + readonly status: "Ready" | "Provisioning" | "Shutdown" | "Deleting" | "Stuck"; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + readonly platform: string; + /** + * @description The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. + * @default 10 + * @example 5 + */ + readonly maximum_runners: number; + /** + * @description Whether public IP is enabled for the hosted runners. + * @example true + */ + readonly public_ip_enabled: boolean; + /** @description The public IP ranges when public IP is enabled for the hosted runners. */ + readonly public_ips?: readonly components["schemas"]["public-ip"][]; + /** + * Format: date-time + * @description The time at which the runner was last used, in ISO 8601 format. + * @example 2022-10-09T23:39:01Z + */ + readonly last_active_on?: string | null; + }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + readonly "actions-hosted-runner-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example ubuntu-20.04 + */ + readonly id: string; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + readonly platform: string; + /** + * @description Image size in GB. + * @example 86 + */ + readonly size_gb: number; + /** + * @description Display name for this image. + * @example 20.04 + */ + readonly display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + readonly source: "github" | "partner" | "custom"; + }; + readonly "actions-hosted-runner-limits": { + /** + * Static public IP Limits for GitHub-hosted Hosted Runners. + * @description Provides details of static public IP limits for GitHub-hosted Hosted Runners + */ + readonly public_ips: { + /** + * @description The maximum number of static public IP addresses that can be used for Hosted Runners. + * @example 50 + */ + readonly maximum: number; + /** + * @description The current number of static public IP addresses in use by Hosted Runners. + * @example 17 + */ + readonly current_usage: number; + }; + }; /** * Actions OIDC Subject customization * @description Actions OIDC Subject customization @@ -22387,6 +22841,8 @@ export interface components { readonly selected_repositories_url?: string; readonly runners_url: string; readonly hosted_runners_url?: string; + /** @description The identifier of a hosted compute network configuration. */ + readonly network_configuration_id?: string; readonly inherited: boolean; readonly inherited_allows_public_repositories?: boolean; readonly allows_public_repositories: boolean; @@ -23163,6 +23619,8 @@ export interface components { readonly sync_to_organizations: string; /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ readonly group_id?: string | null; + /** @example Justice League */ + readonly group_name?: string | null; /** * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league @@ -26009,6 +26467,69 @@ export interface components { /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ readonly estimated_storage_for_month: number; }; + /** + * Hosted compute network configuration + * @description A hosted compute network configuration. + */ + readonly "network-configuration": { + /** + * @description The unique identifier of the network configuration. + * @example 123ABC456DEF789 + */ + readonly id: string; + /** + * @description The name of the network configuration. + * @example my-network-configuration + */ + readonly name: string; + /** + * @description The hosted compute service the network configuration supports. + * @enum {string} + */ + readonly compute_service?: "none" | "actions" | "codespaces"; + /** + * @description The unique identifier of each network settings in the configuration. + * @example 123ABC456DEF789 + */ + readonly network_settings_ids?: readonly string[]; + /** + * Format: date-time + * @description The time at which the network configuration was created, in ISO 8601 format. + * @example 2024-04-26T11:31:07Z + */ + readonly created_on: string | null; + }; + /** + * Hosted compute network settings resource + * @description A hosted compute network settings resource. + */ + readonly "network-settings": { + /** + * @description The unique identifier of the network settings resource. + * @example 220F78DACB92BBFBC5E6F22DE1CCF52309D + */ + readonly id: string; + /** + * @description The identifier of the network configuration that is using this settings resource. + * @example 934E208B3EE0BD60CF5F752C426BFB53562 + */ + readonly network_configuration_id?: string; + /** + * @description The name of the network settings resource. + * @example my-network-settings + */ + readonly name: string; + /** + * @description The subnet this network settings resource is configured for. + * @example /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet + */ + readonly subnet_id: string; + /** + * @description The location of the subnet this network settings resource is configured for. + * @example eastus + */ + readonly region: string; + }; /** * Team Organization * @description Team Organization @@ -27709,17 +28230,17 @@ export interface components { readonly is_alphanumeric: boolean; }; /** - * Check Automated Security Fixes - * @description Check Automated Security Fixes + * Check Dependabot security updates + * @description Check Dependabot security updates */ readonly "check-automated-security-fixes": { /** - * @description Whether automated security fixes are enabled for the repository. + * @description Whether Dependabot security updates are enabled for the repository. * @example true */ readonly enabled: boolean; /** - * @description Whether automated security fixes are paused for the repository. + * @description Whether Dependabot security updates are paused for the repository. * @example false */ readonly paused: boolean; @@ -28822,6 +29343,16 @@ export interface components { readonly state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + /** + * @description Runner type to be used. + * @enum {string|null} + */ + readonly runner_type?: "standard" | "labeled" | null; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + readonly runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -40713,11 +41244,14 @@ export interface components { readonly url?: string; readonly user_view_type?: string; } | null; + readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -40765,10 +41299,10 @@ export interface components { readonly severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - readonly state: "open" | "dismissed" | "fixed"; + readonly state: "open" | "dismissed" | "fixed" | null; readonly tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; @@ -40840,11 +41374,14 @@ export interface components { readonly url?: string; readonly user_view_type?: string; } | null; + readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -40937,6 +41474,7 @@ export interface components { readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ readonly dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly fixed_at?: unknown; /** * Format: uri @@ -40992,7 +41530,7 @@ export interface components { readonly tags?: readonly string[] | null; }; /** - * @description State of a code scanning alert. + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ readonly state: "open" | "dismissed" | null; @@ -41069,11 +41607,14 @@ export interface components { readonly url?: string; readonly user_view_type?: string; } | null; + readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41129,10 +41670,10 @@ export interface components { readonly tags?: readonly string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - readonly state: "fixed"; + readonly state: "fixed" | null; readonly tool: { readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41165,8 +41706,11 @@ export interface components { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly dismissed_at: string | null; readonly dismissed_by: Record | null; + readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ readonly dismissed_reason: string | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41220,10 +41764,10 @@ export interface components { readonly tags?: readonly string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - readonly state: "open" | "dismissed" | "fixed"; + readonly state: "open" | "dismissed" | "fixed" | null; readonly tool: { readonly guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41258,8 +41802,11 @@ export interface components { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly dismissed_at: unknown; readonly dismissed_by: unknown; + readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ readonly dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41307,10 +41854,10 @@ export interface components { readonly severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - readonly state: "open" | "fixed"; + readonly state: "open" | "fixed" | null; readonly tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ readonly name: string; @@ -87047,12 +87594,20 @@ export interface components { readonly "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ readonly "dependabot-alert-comma-separated-packages": string; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + readonly "dependabot-alert-comma-separated-epss": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ readonly "dependabot-alert-scope": "development" | "runtime"; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ - readonly "dependabot-alert-sort": "created" | "updated"; + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ + readonly "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ @@ -87111,6 +87666,8 @@ export interface components { readonly "billing-usage-report-day": number; /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ readonly "billing-usage-report-hour": number; + /** @description Unique identifier of the GitHub-hosted runner. */ + readonly "hosted-runner-id": number; /** @description The unique identifier of the repository. */ readonly "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -87222,6 +87779,10 @@ export interface components { readonly "secret-scanning-pagination-before-org-repo": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ readonly "secret-scanning-pagination-after-org-repo": string; + /** @description Unique identifier of the hosted compute network configuration. */ + readonly "network-configuration-id": string; + /** @description Unique identifier of the hosted compute network settings. */ + readonly "network-settings-id": string; /** @description The number that identifies the discussion. */ readonly "discussion-number": number; /** @description The number that identifies the comment. */ @@ -88742,11 +89303,19 @@ export interface operations { readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ readonly scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ readonly sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; @@ -90593,6 +91162,306 @@ export interface operations { }; }; }; + readonly "actions/list-hosted-runners-for-org": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly runners: readonly components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; + readonly "actions/create-hosted-runner-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + readonly name: string; + /** @description The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + readonly image: { + /** @description The unique identifier of the runner image. */ + readonly id?: string; + /** + * @description The source of the runner image. + * @enum {string} + */ + readonly source?: "github" | "partner" | "custom"; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + readonly version?: string | null; + }; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + readonly size: string; + /** @description The existing runner group to add this runner to. */ + readonly runner_group_id: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + readonly maximum_runners?: number; + /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + readonly enable_static_ip?: boolean; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + readonly "actions/get-hosted-runners-github-owned-images-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly images: readonly components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + readonly "actions/get-hosted-runners-partner-images-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly images: readonly components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + readonly "actions/get-hosted-runners-limits-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-hosted-runner-limits"]; + }; + }; + }; + }; + readonly "actions/get-hosted-runners-machine-specs-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly machine_specs: readonly components["schemas"]["actions-hosted-runner-machine-spec"][]; + }; + }; + }; + }; + }; + readonly "actions/get-hosted-runners-platforms-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly platforms: readonly string[]; + }; + }; + }; + }; + }; + readonly "actions/get-hosted-runner-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + readonly hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + readonly "actions/delete-hosted-runner-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + readonly hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 202: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + readonly "actions/update-hosted-runner-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + readonly hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + readonly name?: string; + /** @description The existing runner group to add this runner to. */ + readonly runner_group_id?: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + readonly maximum_runners?: number; + /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + readonly enable_static_ip?: boolean; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + readonly image_version?: string | null; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; readonly "oidc/get-oidc-custom-sub-template-for-org": { readonly parameters: { readonly query?: never; @@ -90967,6 +91836,8 @@ export interface operations { readonly restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ readonly selected_workflows?: readonly string[]; + /** @description The identifier of a hosted compute network configuration. */ + readonly network_configuration_id?: string; }; }; }; @@ -91064,6 +91935,8 @@ export interface operations { readonly restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ readonly selected_workflows?: readonly string[]; + /** @description The identifier of a hosted compute network configuration. */ + readonly network_configuration_id?: string | null; }; }; }; @@ -91079,6 +91952,40 @@ export interface operations { }; }; }; + readonly "actions/list-github-hosted-runners-in-group-for-org": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + readonly runner_group_id: components["parameters"]["runner-group-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly runners: readonly components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; readonly "actions/list-repo-access-to-self-hosted-runner-group-in-org": { readonly parameters: { readonly query?: { @@ -93660,11 +94567,19 @@ export interface operations { readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ readonly scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ readonly sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; @@ -97833,6 +98748,189 @@ export interface operations { }; }; }; + readonly "hosted-compute/list-network-configurations-for-org": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + readonly page?: components["parameters"]["page"]; + }; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly total_count: number; + readonly network_configurations: readonly components["schemas"]["network-configuration"][]; + }; + }; + }; + }; + }; + readonly "hosted-compute/create-network-configuration-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + readonly name: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + readonly compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + readonly network_settings_ids: readonly string[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + readonly "hosted-compute/get-network-configuration-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + readonly network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + readonly "hosted-compute/delete-network-configuration-from-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + readonly network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "hosted-compute/update-network-configuration-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + readonly network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + readonly name?: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + readonly compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + readonly network_settings_ids?: readonly string[]; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + readonly "hosted-compute/get-network-settings-for-org": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network settings. */ + readonly network_settings_id: components["parameters"]["network-settings-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly Link: components["headers"]["link"]; + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["network-settings"]; + }; + }; + }; + }; readonly "copilot/copilot-metrics-for-team": { readonly parameters: { readonly query?: { @@ -106913,11 +108011,19 @@ export interface operations { readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ readonly manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ readonly scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ readonly sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; @@ -111072,7 +112178,7 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description The sub-issue to remove */ + /** @description The id of the sub-issue to remove */ readonly sub_issue_id: number; }; }; @@ -111145,7 +112251,7 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description The sub-issue to add */ + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ readonly sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ readonly replace_parent?: boolean; @@ -115892,7 +116998,7 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ readonly names: readonly string[]; }; }; diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts index b652d4640..3e54966f1 100644 --- a/packages/openapi-typescript/examples/github-api-next.ts +++ b/packages/openapi-typescript/examples/github-api-next.ts @@ -1763,6 +1763,164 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List GitHub-hosted runners for an organization + * @description Lists all GitHub-hosted runners configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. + */ + get: operations["actions/list-hosted-runners-for-org"]; + put?: never; + /** + * Create a GitHub-hosted runner for an organization + * @description Creates a GitHub-hosted runner for an organization. + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + post: operations["actions/create-hosted-runner-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub-owned images for GitHub-hosted runners in an organization + * @description Get the list of GitHub-owned images available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-github-owned-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/partner": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get partner images for GitHub-hosted runners in an organization + * @description Get the list of partner images available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-partner-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get limits on GitHub-hosted runners for an organization + * @description Get the GitHub-hosted runners limits for an organization. + */ + get: operations["actions/get-hosted-runners-limits-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/machine-sizes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub-hosted runners machine specs for an organization + * @description Get the list of machine specs available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-machine-specs-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/platforms": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get platforms for GitHub-hosted runners in an organization + * @description Get the list of platforms available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-platforms-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a GitHub-hosted runner for an organization + * @description Gets a GitHub-hosted runner configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-hosted-runner-for-org"]; + put?: never; + post?: never; + /** + * Delete a GitHub-hosted runner for an organization + * @description Deletes a GitHub-hosted runner for an organization. + */ + delete: operations["actions/delete-hosted-runner-for-org"]; + options?: never; + head?: never; + /** + * Update a GitHub-hosted runner for an organization + * @description Updates a GitHub-hosted runner for an organization. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + patch: operations["actions/update-hosted-runner-for-org"]; + trace?: never; + }; "/orgs/{org}/actions/oidc/customization/sub": { parameters: { query?: never; @@ -1998,6 +2156,28 @@ export interface paths { patch: operations["actions/update-self-hosted-runner-group-for-org"]; trace?: never; }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List GitHub-hosted runners in a group for an organization + * @description Lists the GitHub-hosted runners in an organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-github-hosted-runners-in-group-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { parameters: { query?: never; @@ -5622,6 +5802,90 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/settings/network-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List hosted compute network configurations for an organization + * @description Lists all hosted compute network configurations configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/list-network-configurations-for-org"]; + put?: never; + /** + * Create a hosted compute network configuration for an organization + * @description Creates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + post: operations["hosted-compute/create-network-configuration-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a hosted compute network configuration for an organization + * @description Gets a hosted compute network configuration configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/get-network-configuration-for-org"]; + put?: never; + post?: never; + /** + * Delete a hosted compute network configuration from an organization + * @description Deletes a hosted compute network configuration from an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + delete: operations["hosted-compute/delete-network-configuration-from-org"]; + options?: never; + head?: never; + /** + * Update a hosted compute network configuration for an organization + * @description Updates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + patch: operations["hosted-compute/update-network-configuration-for-org"]; + trace?: never; + }; + "/orgs/{org}/settings/network-settings/{network_settings_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a hosted compute network settings resource for an organization + * @description Gets a hosted compute network settings resource configured for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/get-network-settings-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/team/{team_slug}/copilot/metrics": { parameters: { query?: never; @@ -8205,19 +8469,19 @@ export interface paths { cookie?: never; }; /** - * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Check if Dependabot security updates are enabled for a repository + * @description Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ get: operations["repos/check-automated-security-fixes"]; /** - * Enable automated security fixes - * @description Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Enable Dependabot security updates + * @description Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ put: operations["repos/enable-automated-security-fixes"]; post?: never; /** - * Disable automated security fixes - * @description Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Disable Dependabot security updates + * @description Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ delete: operations["repos/disable-automated-security-fixes"]; options?: never; @@ -14299,7 +14563,7 @@ export interface paths { }; /** * Get secret scanning scan history for a repository - * @description Lists the latest incremental and backfill scans by type for a repository. + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -17347,9 +17611,11 @@ export interface paths { * Get a user using their ID * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ get: operations["users/get-by-id"]; put?: never; @@ -17393,9 +17659,11 @@ export interface paths { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ get: operations["users/get-by-username"]; put?: never; @@ -24299,6 +24567,11 @@ export interface components { readonly score: number | null; } | null; } | null; + /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + "security-advisory-epss": { + percentage?: number; + percentile?: number; + } | null; /** * Simple User * @description A GitHub user. @@ -24423,16 +24696,13 @@ export interface components { readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - epss?: { - percentage?: number; - percentile?: number; - } | null; /** @description The users who contributed to the advisory. */ readonly credits: { user: components["schemas"]["simple-user"]; @@ -24458,6 +24728,34 @@ export interface components { documentation_url: string; errors?: string[]; }; + /** + * Enterprise + * @description An enterprise on GitHub. + */ + enterprise: { + /** @description A short description of the enterprise. */ + description?: string | null; + /** Format: uri */ + html_url: string; + /** + * Format: uri + * @description The enterprise's website URL. + */ + website_url?: string | null; + /** @description Unique identifier of the enterprise */ + id: number; + node_id: string; + /** @description The name of the enterprise. */ + name: string; + /** @description The slug url identifier for the enterprise. */ + slug: string; + /** Format: date-time */ + created_at: string | null; + /** Format: date-time */ + updated_at: string | null; + /** Format: uri */ + avatar_url: string; + }; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -24469,7 +24767,7 @@ export interface components { slug?: string; node_id: string; client_id?: string; - owner: null | components["schemas"]["simple-user"]; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** @description The name of the GitHub app */ name: string; description: string | null; @@ -24645,34 +24943,6 @@ export interface components { payload: string | null; }; }; - /** - * Enterprise - * @description An enterprise on GitHub. - */ - enterprise: { - /** @description A short description of the enterprise. */ - description?: string | null; - /** Format: uri */ - html_url: string; - /** - * Format: uri - * @description The enterprise's website URL. - */ - website_url?: string | null; - /** @description Unique identifier of the enterprise */ - id: number; - node_id: string; - /** @description The name of the enterprise. */ - name: string; - /** @description The slug url identifier for the enterprise. */ - slug: string; - /** Format: date-time */ - created_at: string | null; - /** Format: date-time */ - updated_at: string | null; - /** Format: uri */ - avatar_url: string; - }; /** * Integration Installation Request * @description Request to install an integration on a target @@ -25865,6 +26135,7 @@ export interface components { readonly vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: { /** @description The unique CWE ID. */ @@ -26349,6 +26620,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: null | components["schemas"]["simple-user"]; /** Format: uri */ comments_url: string; @@ -26495,6 +26767,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: null | components["schemas"]["simple-user"]; /** Format: uri */ comments_url: string; @@ -26532,6 +26805,7 @@ export interface components { updated_at?: string; description?: string | null; comments?: number; + comments_enabled?: boolean; user?: string | null; comments_url?: string; owner?: components["schemas"]["simple-user"]; @@ -27085,6 +27359,117 @@ export interface components { /** @description The number of active caches in the repository. */ active_caches_count: number; }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + "actions-hosted-runner-pool-image": { + /** @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. */ + id: string; + /** @description Image size in GB. */ + size_gb: number; + /** @description Display name for this image. */ + display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + source: "github" | "partner" | "custom"; + /** @description The image version of the hosted runner pool. */ + version: string; + }; + /** + * Github-owned VM details. + * @description Provides details of a particular machine spec. + */ + "actions-hosted-runner-machine-spec": { + /** @description The ID used for the `size` parameter when creating a new runner. */ + id: string; + /** @description The number of cores. */ + cpu_cores: number; + /** @description The available RAM for the machine spec. */ + memory_gb: number; + /** @description The available SSD storage for the machine spec. */ + storage_gb: number; + }; + /** + * Public IP for a GitHub-hosted larger runners. + * @description Provides details of Public IP for a GitHub-hosted larger runners + */ + "public-ip": { + /** @description Whether public IP is enabled. */ + enabled?: boolean; + /** @description The prefix for the public IP. */ + prefix?: string; + /** @description The length of the IP prefix. */ + length?: number; + }; + /** + * GitHub-hosted hosted runner + * @description A Github-hosted hosted runner. + */ + "actions-hosted-runner": { + /** @description The unique identifier of the hosted runner. */ + id: number; + /** @description The name of the hosted runner. */ + name: string; + /** @description The unique identifier of the group that the hosted runner belongs to. */ + runner_group_id?: number; + image_details: null | components["schemas"]["actions-hosted-runner-pool-image"]; + machine_size_details: components["schemas"]["actions-hosted-runner-machine-spec"]; + /** + * @description The status of the runner. + * @enum {string} + */ + status: "Ready" | "Provisioning" | "Shutdown" | "Deleting" | "Stuck"; + /** @description The operating system of the image. */ + platform: string; + /** + * @description The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. + * @default 10 + */ + maximum_runners: number; + /** @description Whether public IP is enabled for the hosted runners. */ + public_ip_enabled: boolean; + /** @description The public IP ranges when public IP is enabled for the hosted runners. */ + public_ips?: components["schemas"]["public-ip"][]; + /** + * Format: date-time + * @description The time at which the runner was last used, in ISO 8601 format. + */ + last_active_on?: string | null; + }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + "actions-hosted-runner-image": { + /** @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. */ + id: string; + /** @description The operating system of the image. */ + platform: string; + /** @description Image size in GB. */ + size_gb: number; + /** @description Display name for this image. */ + display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + source: "github" | "partner" | "custom"; + }; + "actions-hosted-runner-limits": { + /** + * Static public IP Limits for GitHub-hosted Hosted Runners. + * @description Provides details of static public IP limits for GitHub-hosted Hosted Runners + */ + public_ips: { + /** @description The maximum number of static public IP addresses that can be used for Hosted Runners. */ + maximum: number; + /** @description The current number of static public IP addresses in use by Hosted Runners. */ + current_usage: number; + }; + }; /** * Actions OIDC Subject customization * @description Actions OIDC Subject customization @@ -27152,6 +27537,8 @@ export interface components { selected_repositories_url?: string; runners_url: string; hosted_runners_url?: string; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string; inherited: boolean; inherited_allows_public_repositories?: boolean; allows_public_repositories: boolean; @@ -27723,6 +28110,7 @@ export interface components { url: string; sync_to_organizations: string; group_id?: string | null; + group_name?: string | null; /** Format: uri */ html_url: string; members_url: string; @@ -29586,6 +29974,44 @@ export interface components { /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ estimated_storage_for_month: number; }; + /** + * Hosted compute network configuration + * @description A hosted compute network configuration. + */ + "network-configuration": { + /** @description The unique identifier of the network configuration. */ + id: string; + /** @description The name of the network configuration. */ + name: string; + /** + * @description The hosted compute service the network configuration supports. + * @enum {string} + */ + compute_service?: "none" | "actions" | "codespaces"; + /** @description The unique identifier of each network settings in the configuration. */ + network_settings_ids?: string[]; + /** + * Format: date-time + * @description The time at which the network configuration was created, in ISO 8601 format. + */ + created_on: string | null; + }; + /** + * Hosted compute network settings resource + * @description A hosted compute network settings resource. + */ + "network-settings": { + /** @description The unique identifier of the network settings resource. */ + id: string; + /** @description The identifier of the network configuration that is using this settings resource. */ + network_configuration_id?: string; + /** @description The name of the network settings resource. */ + name: string; + /** @description The subnet this network settings resource is configured for. */ + subnet_id: string; + /** @description The location of the subnet this network settings resource is configured for. */ + region: string; + }; /** * Team Organization * @description Team Organization @@ -30669,13 +31095,13 @@ export interface components { is_alphanumeric: boolean; }; /** - * Check Automated Security Fixes - * @description Check Automated Security Fixes + * Check Dependabot security updates + * @description Check Dependabot security updates */ "check-automated-security-fixes": { - /** @description Whether automated security fixes are enabled for the repository. */ + /** @description Whether Dependabot security updates are enabled for the repository. */ enabled: boolean; - /** @description Whether automated security fixes are paused for the repository. */ + /** @description Whether Dependabot security updates are paused for the repository. */ paused: boolean; }; /** @@ -31521,6 +31947,13 @@ export interface components { state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + /** + * @description Runner type to be used. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | null; + /** @description Runner label to be used if the runner type is labeled. */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -41255,11 +41688,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: null; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41307,10 +41743,10 @@ export interface components { severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed" | null; tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; @@ -41382,11 +41818,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: null; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41479,6 +41918,7 @@ export interface components { dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ fixed_at?: null; /** * Format: uri @@ -41534,7 +41974,7 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | null; @@ -41611,11 +42051,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: null; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41671,10 +42114,10 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "fixed"; + state: "fixed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41707,8 +42150,11 @@ export interface components { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; dismissed_by: Record | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: null; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41762,10 +42208,10 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41800,8 +42246,11 @@ export interface components { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: null; dismissed_by: null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: null; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41849,10 +42298,10 @@ export interface components { severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "fixed"; + state: "open" | "fixed" | null; tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; @@ -87586,12 +88035,20 @@ export interface components { "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ "dependabot-alert-comma-separated-packages": string; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + "dependabot-alert-comma-separated-epss": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ "dependabot-alert-scope": "development" | "runtime"; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ - "dependabot-alert-sort": "created" | "updated"; + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ + "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ @@ -87650,6 +88107,8 @@ export interface components { "billing-usage-report-day": number; /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ "billing-usage-report-hour": number; + /** @description Unique identifier of the GitHub-hosted runner. */ + "hosted-runner-id": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -87761,6 +88220,10 @@ export interface components { "secret-scanning-pagination-before-org-repo": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ "secret-scanning-pagination-after-org-repo": string; + /** @description Unique identifier of the hosted compute network configuration. */ + "network-configuration-id": string; + /** @description Unique identifier of the hosted compute network settings. */ + "network-settings-id": string; /** @description The number that identifies the discussion. */ "discussion-number": number; /** @description The number that identifies the comment. */ @@ -89262,11 +89725,19 @@ export interface operations { ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -91083,6 +91554,306 @@ export interface operations { }; }; }; + "actions/list-hosted-runners-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; + "actions/create-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; + /** @description The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + image: { + /** @description The unique identifier of the runner image. */ + id?: string; + /** + * @description The source of the runner image. + * @enum {string} + */ + source?: "github" | "partner" | "custom"; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + version?: string | null; + }; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + size: string; + /** @description The existing runner group to add this runner to. */ + runner_group_id: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + maximum_runners?: number; + /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + enable_static_ip?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/get-hosted-runners-github-owned-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-partner-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-limits-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-limits"]; + }; + }; + }; + }; + "actions/get-hosted-runners-machine-specs-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + machine_specs: components["schemas"]["actions-hosted-runner-machine-spec"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-platforms-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + platforms: string[]; + }; + }; + }; + }; + }; + "actions/get-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/delete-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/update-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; + /** @description The existing runner group to add this runner to. */ + runner_group_id?: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + maximum_runners?: number; + /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + enable_static_ip?: boolean; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + image_version?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; "oidc/get-oidc-custom-sub-template-for-org": { parameters: { query?: never; @@ -91457,6 +92228,8 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string; }; }; }; @@ -91554,6 +92327,8 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string | null; }; }; }; @@ -91569,6 +92344,40 @@ export interface operations { }; }; }; + "actions/list-github-hosted-runners-in-group-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; "actions/list-repo-access-to-self-hosted-runner-group-in-org": { parameters: { query?: { @@ -94150,11 +94959,19 @@ export interface operations { ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -98308,6 +99125,189 @@ export interface operations { }; }; }; + "hosted-compute/list-network-configurations-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + network_configurations: components["schemas"]["network-configuration"][]; + }; + }; + }; + }; + }; + "hosted-compute/create-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + network_settings_ids: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/get-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/delete-network-configuration-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "hosted-compute/update-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + network_settings_ids?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/get-network-settings-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network settings. */ + network_settings_id: components["parameters"]["network-settings-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-settings"]; + }; + }; + }; + }; "copilot/copilot-metrics-for-team": { parameters: { query?: { @@ -107335,11 +108335,19 @@ export interface operations { package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -111474,7 +112482,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The sub-issue to remove */ + /** @description The id of the sub-issue to remove */ sub_issue_id: number; }; }; @@ -111547,7 +112555,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The sub-issue to add */ + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ replace_parent?: boolean; @@ -116281,7 +117289,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; diff --git a/packages/openapi-typescript/examples/github-api-next.yaml b/packages/openapi-typescript/examples/github-api-next.yaml index e494f1288..98675b253 100644 --- a/packages/openapi-typescript/examples/github-api-next.yaml +++ b/packages/openapi-typescript/examples/github-api-next.yaml @@ -93,6 +93,8 @@ tags: description: Endpoints to manage Code security using the REST API. - name: private-registries description: Manage private registry configurations. +- name: hosted-compute + description: Manage hosted compute networking resources. servers: - url: https://api.github.com externalDocs: @@ -2135,6 +2137,7 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" @@ -4781,6 +4784,459 @@ paths: enabledForGitHubApps: true category: actions subcategory: cache + "/orgs/{org}/actions/hosted-runners": + get: + summary: List GitHub-hosted runners for an organization + description: |- + Lists all GitHub-hosted runners configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-hosted-runners-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: integer + runners: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + post: + summary: Create a GitHub-hosted runner for an organization + description: |- + Creates a GitHub-hosted runner for an organization. + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + operationId: actions/create-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner. Must be between 1 and 64 characters + and may only contain upper and lowercase letters a-z, numbers + 0-9, '.', '-', and '_'. + type: string + image: + description: The image of runner. To list all available images, + use `GET /actions/hosted-runners/images/github-owned` or `GET + /actions/hosted-runners/images/partner`. + type: object + properties: + id: + description: The unique identifier of the runner image. + type: string + source: + description: The source of the runner image. + type: string + enum: + - github + - partner + - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: + - string + - 'null' + size: + description: The machine size of the runner. To list available sizes, + use `GET actions/hosted-runners/machine-sizes` + type: string + runner_group_id: + description: The existing runner group to add this runner to. + type: integer + maximum_runners: + description: The maximum amount of runners to scale up to. Runners + will not auto-scale above this number. Use this setting to limit + your cost. + type: integer + enable_static_ip: + description: Whether this runner should be created with a static + public IP. Note limit on account. To list limits on account, use + `GET actions/hosted-runners/limits` + type: boolean + required: + - name + - image + - size + - runner_group_id + examples: + default: + value: + name: My Hosted runner + image: + id: ubuntu-latest + source: github + version: latest + runner_group_id: 1 + size: 4-core + maximum_runners: 50 + enable_static_ip: false + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/github-owned": + get: + summary: Get GitHub-owned images for GitHub-hosted runners in an organization + description: Get the list of GitHub-owned images available for GitHub-hosted + runners for an organization. + operationId: actions/get-hosted-runners-github-owned-images-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/partner": + get: + summary: Get partner images for GitHub-hosted runners in an organization + description: Get the list of partner images available for GitHub-hosted runners + for an organization. + operationId: actions/get-hosted-runners-partner-images-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/limits": + get: + summary: Get limits on GitHub-hosted runners for an organization + description: Get the GitHub-hosted runners limits for an organization. + operationId: actions/get-hosted-runners-limits-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-limits" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-limits-default" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/machine-sizes": + get: + summary: Get GitHub-hosted runners machine specs for an organization + description: Get the list of machine specs available for GitHub-hosted runners + for an organization. + operationId: actions/get-hosted-runners-machine-specs-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - machine_specs + properties: + total_count: + type: integer + machine_specs: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-machine-spec" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-machine-spec" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/platforms": + get: + summary: Get platforms for GitHub-hosted runners in an organization + description: Get the list of platforms available for GitHub-hosted runners for + an organization. + operationId: actions/get-hosted-runners-platforms-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - platforms + properties: + total_count: + type: integer + platforms: + type: array + items: + type: string + examples: + default: + value: + total_count: 1 + platforms: + - linux-x64 + - win-x64 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": + get: + summary: Get a GitHub-hosted runner for an organization + description: |- + Gets a GitHub-hosted runner configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-hosted-runner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/hosted-runner-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + patch: + summary: Update a GitHub-hosted runner for an organization + description: |- + Updates a GitHub-hosted runner for an organization. + OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + operationId: actions/update-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/hosted-runner-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner. Must be between 1 and 64 characters + and may only contain upper and lowercase letters a-z, numbers + 0-9, '.', '-', and '_'. + type: string + runner_group_id: + description: The existing runner group to add this runner to. + type: integer + maximum_runners: + description: The maximum amount of runners to scale up to. Runners + will not auto-scale above this number. Use this setting to limit + your cost. + type: integer + enable_static_ip: + description: Whether this runner should be updated with a static + public IP. Note limit on account. To list limits on account, use + `GET actions/hosted-runners/limits` + type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: + - string + - 'null' + examples: + default: + value: + name: My larger runner + runner_group_id: 1 + maximum_runners: 50 + enable_static_ip: false + image_version: 1.0.0 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: hosted-runners + delete: + summary: Delete a GitHub-hosted runner for an organization + description: Deletes a GitHub-hosted runner for an organization. + operationId: actions/delete-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/hosted-runner-id" + responses: + '202': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/oidc/customization/sub": get: summary: Get the customization template for an OIDC subject claim for an organization @@ -5289,6 +5745,9 @@ paths: to run. Note that a ref, tag, or long SHA is required. examples: - octo-org/octo-repo/.github/workflows/deploy.yaml@main + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string required: - name examples: @@ -5401,6 +5860,11 @@ paths: to run. Note that a ref, tag, or long SHA is required. examples: - octo-org/octo-repo/.github/workflows/deploy.yaml@main + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: + - string + - 'null' required: - name examples: @@ -5446,6 +5910,52 @@ paths: githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": + get: + summary: List GitHub-hosted runners in a group for an organization + description: |- + Lists the GitHub-hosted runners in an organization group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-github-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: number + runners: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": get: summary: List repository access to a self-hosted runner group in an organization @@ -9300,6 +9810,7 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" @@ -13462,17 +13973,11 @@ paths: items: type: integer examples: - update-username-and-encrypted-value: + default: value: username: monalisa encrypted_value: c2VjcmV0 key_id: '012345678912345678' - update-with-selected-visibility: - value: - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 responses: '204': description: Response @@ -15037,6 +15542,270 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing + "/orgs/{org}/settings/network-configurations": + get: + summary: List hosted compute network configurations for an organization + description: |- + Lists all hosted compute network configurations configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/list-network-configurations-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - network_configurations + properties: + total_count: + type: integer + network_configurations: + type: array + items: + "$ref": "#/components/schemas/network-configuration" + examples: + default: + "$ref": "#/components/examples/network-configurations-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + post: + summary: Create a hosted compute network configuration for an organization + description: |- + Creates a hosted compute network configuration for an organization. + + OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/create-network-configuration-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the network configuration. Must be between + 1 and 100 characters and may only contain upper and lowercase + letters a-z, numbers 0-9, '.', '-', and '_'. + type: string + compute_service: + description: The hosted compute service to use for the network configuration. + type: string + enum: + - none + - actions + network_settings_ids: + type: array + minItems: 1 + maxItems: 1 + description: The identifier of the network settings to use for the + network configuration. Exactly one network settings must be specified. + items: + type: string + required: + - name + - network_settings_ids + examples: + default: + value: + name: my-network-configuration + network_settings_ids: + - 23456789ABDCEF1 + compute_service: actions + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/network-configuration" + examples: + default: + "$ref": "#/components/examples/network-configuration" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": + get: + summary: Get a hosted compute network configuration for an organization + description: |- + Gets a hosted compute network configuration configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/get-network-configuration-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/network-configuration-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/network-configuration" + examples: + default: + "$ref": "#/components/examples/network-configuration" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + patch: + summary: Update a hosted compute network configuration for an organization + description: |- + Updates a hosted compute network configuration for an organization. + + OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/update-network-configuration-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/network-configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the network configuration. Must be between + 1 and 100 characters and may only contain upper and lowercase + letters a-z, numbers 0-9, '.', '-', and '_'. + type: string + compute_service: + description: The hosted compute service to use for the network configuration. + type: string + enum: + - none + - actions + network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: The identifier of the network settings to use for the + network configuration. Exactly one network settings must be specified. + items: + type: string + examples: + default: + value: + name: my-network-configuration + network_settings_ids: + - 23456789ABDCEF1 + compute_service: actions + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/network-configuration" + examples: + default: + "$ref": "#/components/examples/network-configuration" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + delete: + summary: Delete a hosted compute network configuration from an organization + description: |- + Deletes a hosted compute network configuration from an organization. + + OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/delete-network-configuration-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/network-configuration-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + "/orgs/{org}/settings/network-settings/{network_settings_id}": + get: + summary: Get a hosted compute network settings resource for an organization + description: |- + Gets a hosted compute network settings resource configured for an organization. + + OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/get-network-settings-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/network-settings-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/network-settings" + examples: + default: + "$ref": "#/components/examples/network-settings" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations "/orgs/{org}/team/{team_slug}/copilot/metrics": get: summary: Get Copilot metrics for a team @@ -21690,17 +22459,17 @@ paths: subcategory: autolinks "/repos/{owner}/{repo}/automated-security-fixes": get: - summary: Check if automated security fixes are enabled for a repository - description: Shows whether automated security fixes are enabled, disabled or - paused for a repository. The authenticated user must have admin read access - to the repository. For more information, see "[Configuring automated security - fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + summary: Check if Dependabot security updates are enabled for a repository + description: Shows whether Dependabot security updates are enabled, disabled + or paused for a repository. The authenticated user must have admin read access + to the repository. For more information, see "[Configuring Dependabot security + updates](https://docs.github.com/articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/check-automated-security-fixes externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository + url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -21724,16 +22493,16 @@ paths: category: repos subcategory: repos put: - summary: Enable automated security fixes - description: Enables automated security fixes for a repository. The authenticated + summary: Enable Dependabot security updates + description: Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring - automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/enable-automated-security-fixes externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/repos#enable-automated-security-fixes + url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -21746,16 +22515,16 @@ paths: category: repos subcategory: repos delete: - summary: Disable automated security fixes - description: Disables automated security fixes for a repository. The authenticated + summary: Disable Dependabot security updates + description: Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring - automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/disable-automated-security-fixes externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/repos#disable-automated-security-fixes + url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -28385,6 +29154,7 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-manifests" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" @@ -34531,7 +35301,7 @@ paths: properties: sub_issue_id: type: integer - description: The sub-issue to remove + description: The id of the sub-issue to remove required: - sub_issue_id examples: @@ -34645,7 +35415,8 @@ paths: properties: sub_issue_id: type: integer - description: The sub-issue to add + description: The id of the sub-issue to add. The sub-issue must + belong to the same repository as the parent issue replace_parent: type: boolean description: Option that, when true, instructs the operation to @@ -40211,7 +40982,7 @@ paths: get: summary: Get secret scanning scan history for a repository description: |- - Lists the latest incremental and backfill scans by type for a repository. + Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: @@ -41464,7 +42235,7 @@ paths: description: An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** - Topic `names` cannot contain uppercase letters. + Topic `names` will be saved as lowercase. items: type: string required: @@ -48564,9 +49335,11 @@ paths: description: |- Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. - The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. - The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). tags: - users operationId: users/get-by-id @@ -48647,9 +49420,11 @@ paths: description: |- Provides publicly available information about someone with a GitHub account. - The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + + The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). - The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). tags: - users operationId: users/get-by-username @@ -67028,6 +67803,22 @@ components: required: - vector_string - score + security-advisory-epss: + type: + - object + - 'null' + readOnly: true + description: The EPSS scores as calculated by the [Exploit Prediction Scoring + System](https://www.first.org/epss). + properties: + percentage: + type: number + minimum: 0 + maximum: 100 + percentile: + type: number + minimum: 0 + maximum: 100 simple-user: title: Simple User description: A GitHub user. @@ -67321,6 +68112,8 @@ components: - score cvss_severities: "$ref": "#/components/schemas/cvss-severities" + epss: + "$ref": "#/components/schemas/security-advisory-epss" cwes: type: - array @@ -67338,15 +68131,6 @@ components: required: - cwe_id - name - epss: - type: - - object - - 'null' - properties: - percentage: - type: number - percentile: - type: number credits: type: - array @@ -67415,6 +68199,72 @@ components: type: array items: type: string + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: + - string + - 'null' + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: + - string + - 'null' + format: uri + id: + description: Unique identifier of the enterprise + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + examples: + - Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + examples: + - octo-business + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2019-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2019-01-26T19:14:43Z' + avatar_url: + type: string + format: uri + required: + - id + - node_id + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url integration: title: GitHub app description: GitHub apps are a new way to extend GitHub. They can be installed @@ -67444,9 +68294,9 @@ components: examples: - '"Iv1.25b5d1e65ffc4022"' owner: - anyOf: - - type: 'null' + oneOf: - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/enterprise" name: description: The name of the GitHub app type: string @@ -67869,72 +68719,6 @@ components: - repository_id - request - response - enterprise: - title: Enterprise - description: An enterprise on GitHub. - type: object - properties: - description: - description: A short description of the enterprise. - type: - - string - - 'null' - html_url: - type: string - format: uri - examples: - - https://github.com/enterprises/octo-business - website_url: - description: The enterprise's website URL. - type: - - string - - 'null' - format: uri - id: - description: Unique identifier of the enterprise - type: integer - examples: - - 42 - node_id: - type: string - examples: - - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - description: The name of the enterprise. - type: string - examples: - - Octo Business - slug: - description: The slug url identifier for the enterprise. - type: string - examples: - - octo-business - created_at: - type: - - string - - 'null' - format: date-time - examples: - - '2019-01-26T19:01:12Z' - updated_at: - type: - - string - - 'null' - format: date-time - examples: - - '2019-01-26T19:14:43Z' - avatar_url: - type: string - format: uri - required: - - id - - node_id - - name - - slug - - html_url - - created_at - - updated_at - - avatar_url integration-installation-request: title: Integration Installation Request description: Request to install an integration on a target @@ -70454,6 +71238,8 @@ components: additionalProperties: false cvss_severities: "$ref": "#/components/schemas/cvss-severities" + epss: + "$ref": "#/components/schemas/security-advisory-epss" cwes: type: array description: Details for the advisory pertaining to Common Weakness Enumeration. @@ -71524,6 +72310,8 @@ components: - 'null' comments: type: integer + comments_enabled: + type: boolean user: anyOf: - type: 'null' @@ -71850,6 +72638,8 @@ components: - 'null' comments: type: integer + comments_enabled: + type: boolean user: anyOf: - type: 'null' @@ -71940,6 +72730,8 @@ components: - 'null' comments: type: integer + comments_enabled: + type: boolean user: type: - string @@ -73553,6 +74345,237 @@ components: - full_name - active_caches_size_in_bytes - active_caches_count + actions-hosted-runner-pool-image: + title: GitHub-hosted runner image details. + description: Provides details of a hosted runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter + when creating a new larger runner. + type: string + examples: + - ubuntu-20.04 + size_gb: + description: Image size in GB. + type: integer + examples: + - 86 + display_name: + description: Display name for this image. + type: string + examples: + - 20.04 + source: + description: The image provider. + type: string + enum: + - github + - partner + - custom + version: + description: The image version of the hosted runner pool. + type: string + examples: + - latest + required: + - id + - size_gb + - display_name + - source + - version + actions-hosted-runner-machine-spec: + title: Github-owned VM details. + description: Provides details of a particular machine spec. + type: object + properties: + id: + description: The ID used for the `size` parameter when creating a new runner. + type: string + examples: + - 8-core + cpu_cores: + description: The number of cores. + type: integer + examples: + - 8 + memory_gb: + description: The available RAM for the machine spec. + type: integer + examples: + - 32 + storage_gb: + description: The available SSD storage for the machine spec. + type: integer + examples: + - 300 + required: + - id + - cpu_cores + - memory_gb + - storage_gb + public-ip: + title: Public IP for a GitHub-hosted larger runners. + description: Provides details of Public IP for a GitHub-hosted larger runners + type: object + properties: + enabled: + description: Whether public IP is enabled. + type: boolean + examples: + - true + prefix: + description: The prefix for the public IP. + type: string + examples: + - 20.80.208.150 + length: + description: The length of the IP prefix. + type: integer + examples: + - 28 + actions-hosted-runner: + title: GitHub-hosted hosted runner + description: A Github-hosted hosted runner. + type: object + properties: + id: + description: The unique identifier of the hosted runner. + type: integer + examples: + - 5 + name: + description: The name of the hosted runner. + type: string + examples: + - my-github-hosted-runner + runner_group_id: + description: The unique identifier of the group that the hosted runner belongs + to. + type: integer + examples: + - 2 + image_details: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/actions-hosted-runner-pool-image" + machine_size_details: + "$ref": "#/components/schemas/actions-hosted-runner-machine-spec" + status: + description: The status of the runner. + type: string + enum: + - Ready + - Provisioning + - Shutdown + - Deleting + - Stuck + examples: + - Ready + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + maximum_runners: + description: The maximum amount of hosted runners. Runners will not scale + automatically above this number. Use this setting to limit your cost. + type: integer + default: 10 + examples: + - 5 + public_ip_enabled: + description: Whether public IP is enabled for the hosted runners. + type: boolean + examples: + - true + public_ips: + description: The public IP ranges when public IP is enabled for the hosted + runners. + type: array + items: + "$ref": "#/components/schemas/public-ip" + last_active_on: + description: The time at which the runner was last used, in ISO 8601 format. + type: + - string + - 'null' + format: date-time + examples: + - '2022-10-09T23:39:01Z' + required: + - id + - name + - image_details + - machine_size_details + - status + - public_ip_enabled + - platform + actions-hosted-runner-image: + title: GitHub-hosted runner image details. + description: Provides details of a hosted runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter + when creating a new larger runner. + type: string + examples: + - ubuntu-20.04 + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + size_gb: + description: Image size in GB. + type: integer + examples: + - 86 + display_name: + description: Display name for this image. + type: string + examples: + - 20.04 + source: + description: The image provider. + type: string + enum: + - github + - partner + - custom + required: + - id + - platform + - size_gb + - display_name + - source + actions-hosted-runner-limits: + type: object + properties: + public_ips: + title: Static public IP Limits for GitHub-hosted Hosted Runners. + description: Provides details of static public IP limits for GitHub-hosted + Hosted Runners + type: object + properties: + maximum: + type: integer + description: The maximum number of static public IP addresses that can + be used for Hosted Runners. + examples: + - 50 + current_usage: + type: integer + description: The current number of static public IP addresses in use + by Hosted Runners. + examples: + - 17 + required: + - maximum + - current_usage + required: + - public_ips oidc-custom-sub: title: Actions OIDC Subject customization description: Actions OIDC Subject customization @@ -73676,6 +74699,9 @@ components: type: string hosted_runners_url: type: string + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string inherited: type: boolean inherited_allows_public_repositories: @@ -74869,6 +75895,12 @@ components: - 'null' examples: - 62ab9291-fae2-468e-974b-7e45096d5021 + group_name: + type: + - string + - 'null' + examples: + - Justice League html_url: type: string format: uri @@ -78906,6 +79938,85 @@ components: - days_left_in_billing_cycle - estimated_paid_storage_for_month - estimated_storage_for_month + network-configuration: + title: Hosted compute network configuration + description: A hosted compute network configuration. + type: object + properties: + id: + description: The unique identifier of the network configuration. + type: string + examples: + - 123ABC456DEF789 + name: + description: The name of the network configuration. + type: string + examples: + - my-network-configuration + compute_service: + description: The hosted compute service the network configuration supports. + type: string + enum: + - none + - actions + - codespaces + network_settings_ids: + description: The unique identifier of each network settings in the configuration. + type: array + items: + type: string + examples: + - 123ABC456DEF789 + created_on: + description: The time at which the network configuration was created, in + ISO 8601 format. + type: + - string + - 'null' + format: date-time + examples: + - '2024-04-26T11:31:07Z' + required: + - id + - name + - created_on + network-settings: + title: Hosted compute network settings resource + description: A hosted compute network settings resource. + type: object + properties: + id: + description: The unique identifier of the network settings resource. + type: string + examples: + - 220F78DACB92BBFBC5E6F22DE1CCF52309D + network_configuration_id: + description: The identifier of the network configuration that is using this + settings resource. + type: string + examples: + - 934E208B3EE0BD60CF5F752C426BFB53562 + name: + description: The name of the network settings resource. + type: string + examples: + - my-network-settings + subnet_id: + description: The subnet this network settings resource is configured for. + type: string + examples: + - "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" + region: + description: The location of the subnet this network settings resource is + configured for. + type: string + examples: + - eastus + required: + - id + - name + - subnet_id + - region team-organization: title: Team Organization description: Team Organization @@ -81675,18 +82786,18 @@ components: - url_template - is_alphanumeric check-automated-security-fixes: - title: Check Automated Security Fixes - description: Check Automated Security Fixes + title: Check Dependabot security updates + description: Check Dependabot security updates type: object properties: enabled: type: boolean - description: Whether automated security fixes are enabled for the repository. + description: Whether Dependabot security updates are enabled for the repository. examples: - true paused: type: boolean - description: Whether automated security fixes are paused for the repository. + description: Whether Dependabot security updates are paused for the repository. examples: - false required: @@ -83755,6 +84866,22 @@ components: - ruby - typescript - swift + runner_type: + description: Runner type to be used. + type: + - string + - 'null' + enum: + - standard + - labeled + - + runner_label: + description: Runner label to be used if the runner type is labeled. + type: + - string + - 'null' + examples: + - code-scanning query_suite: description: CodeQL query suite to be used. type: string @@ -105850,6 +106977,8 @@ components: required: - login - id + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -105860,6 +106989,11 @@ components: - won't fix - used in tests - + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' html_url: description: The GitHub URL of the alert resource. type: string @@ -105954,12 +107088,17 @@ components: - severity - description state: - description: State of a code scanning alert. - type: string + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + type: + - string + - 'null' enum: - open - dismissed - fixed + - tool: type: object properties: @@ -106103,6 +107242,8 @@ components: required: - login - id + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -106113,6 +107254,11 @@ components: - won't fix - used in tests - + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' html_url: description: The GitHub URL of the alert resource. type: string @@ -106321,6 +107467,8 @@ components: type: - 'null' fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' type: - 'null' html_url: @@ -106439,7 +107587,9 @@ components: - severity - description state: - description: State of a code scanning alert. + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. type: - string - 'null' @@ -106602,6 +107752,8 @@ components: required: - login - id + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -106612,6 +107764,11 @@ components: - won't fix - used in tests - + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' html_url: description: The GitHub URL of the alert resource. type: string @@ -106729,10 +107886,15 @@ components: - severity - description state: - description: State of a code scanning alert. - type: string + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + type: + - string + - 'null' enum: - fixed + - tool: type: object properties: @@ -106816,226 +107978,19 @@ components: type: - object - 'null' + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in tests`.' type: - string - 'null' - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - most_recent_instance: - title: Alert Instance - type: - - object - - 'null' - properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the analysis - was executed. - type: string - classifications: - type: array - items: - type: string - commit_sha: - type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. - type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. - type: string - full_description: - type: string - help: - type: - - string - - 'null' - help_uri: - description: A link to the documentation for the rule used to detect - the alert. - type: - - string - - 'null' - id: - description: A unique identifier for the rule used to detect the - alert. - type: string - name: - type: string - severity: - description: The severity of the alert. - type: - - string - - 'null' - enum: - - none - - note - - warning - - error - - - tags: - type: - - array - - 'null' - items: - type: string - required: - - id - - severity - - description - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - tool: - type: object - properties: - guid: - type: - - string - - 'null' - name: - description: The name of the tool used to generate the code scanning - analysis alert. - type: string - version: - description: The version of the tool used to detect the alert. - type: - - string - - 'null' - required: - - name - - version - url: - type: string - format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: - - string - - 'null' - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: - - string - - 'null' - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-code-scanning-alert-reopened-by-user: - title: code_scanning_alert reopened_by_user event - type: object - properties: - action: - type: string - enum: - - reopened_by_user - alert: - description: The code scanning alert involved in the event. - type: object - properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' type: - 'null' - dismissed_by: - type: - - 'null' - dismissed_reason: - description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' - type: - - 'null' html_url: description: The GitHub URL of the alert resource. type: string @@ -107110,10 +108065,24 @@ components: description: A short description of the rule used to detect the alert. type: string + full_description: + type: string + help: + type: + - string + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' id: description: A unique identifier for the rule used to detect the alert. type: string + name: + type: string severity: description: The severity of the alert. type: @@ -107125,16 +108094,233 @@ components: - warning - error - + tags: + type: + - array + - 'null' + items: + type: string required: - id - severity - description state: - description: State of a code scanning alert. + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + type: + - string + - 'null' + enum: + - open + - dismissed + - fixed + - + tool: + type: object + properties: + guid: + type: + - string + - 'null' + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: + - string + - 'null' + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + description: The commit SHA of the code scanning alert. When the action + is `reopened_by_user` or `closed_by_user`, the event was triggered by + the `sender` and this value will be empty. + type: + - string + - 'null' + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + description: The Git reference of the code scanning alert. When the action + is `reopened_by_user` or `closed_by_user`, the event was triggered by + the `sender` and this value will be empty. + type: + - string + - 'null' + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - ref + - commit_oid + - repository + - sender + webhook-code-scanning-alert-reopened-by-user: + title: code_scanning_alert reopened_by_user event + type: object + properties: + action: + type: string + enum: + - reopened_by_user + alert: + description: The code scanning alert involved in the event. + type: object + properties: + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' + dismissed_by: + type: + - 'null' + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + dismissed_reason: + description: 'The reason for dismissing or closing the alert. Can be + one of: `false positive`, `won''t fix`, and `used in tests`.' + type: + - 'null' + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' + html_url: + description: The GitHub URL of the alert resource. type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + severity: + description: The severity of the alert. + type: + - string + - 'null' + enum: + - none + - note + - warning + - error + - + required: + - id + - severity + - description + state: + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + type: + - string + - 'null' enum: - open - fixed + - tool: type: object properties: @@ -203653,6 +204839,9 @@ components: cvss_v4: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 + epss: + - percentage: 0.00045 + percentile: 0.16001e0 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor @@ -204303,6 +205492,7 @@ components: updated_at: '2022-09-21T10:28:06Z' description: An updated gist description. comments: 0 + comments_enabled: true user: comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments owner: @@ -205647,6 +206837,87 @@ components: - full_name: octo-org/server active_caches_size_in_bytes: 1022142 active_caches_count: 2 + actions-hosted-runner-paginated: + value: + total_count: 2 + runners: + - id: 5 + name: My hosted ubuntu runner + runner_group_id: 2 + platform: linux-x64 + image: + id: ubuntu-20.04 + size: 86 + machine_size_details: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 + status: Ready + maximum_runners: 10 + public_ip_enabled: true + public_ips: + - enabled: true + prefix: 20.80.208.150 + length: 31 + last_active_on: '2022-10-09T23:39:01Z' + - id: 7 + name: My hosted Windows runner + runner_group_id: 2 + platform: win-x64 + image: + id: windows-latest + size: 256 + machine_size_details: + id: 8-core + cpu_cores: 8 + memory_gb: 32 + storage_gb: 300 + status: Ready + maximum_runners: 20 + public_ip_enabled: false + public_ips: [] + last_active_on: '2023-04-26T15:23:37Z' + actions-hosted-runner: + value: + id: 5 + name: My hosted ubuntu runner + runner_group_id: 2 + platform: linux-x64 + image: + id: ubuntu-20.04 + size: 86 + machine_size_details: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 + status: Ready + maximum_runners: 10 + public_ip_enabled: true + public_ips: + - enabled: true + prefix: 20.80.208.150 + length: 31 + last_active_on: '2022-10-09T23:39:01Z' + actions-hosted-runner-image: + value: + id: ubuntu-20.04 + platform: linux-x64 + size_gb: 86 + display_name: '20.04' + source: github + actions-hosted-runner-limits-default: + value: + public_ips: + current_usage: 17 + maximum: 50 + actions-hosted-runner-machine-spec: + value: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 oidc-custom-sub: value: include_claim_keys: @@ -210021,6 +211292,40 @@ components: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 estimated_storage_for_month: 40 + network-configurations-paginated: + value: + total_count: 2 + network_configurations: + - id: 123456789ABCDEF + name: My network configuration + compute_service: actions + network_settings_ids: + - 23456789ABDCEF1 + - 3456789ABDCEF12 + created_on: '2022-10-09T23:39:01Z' + - id: 456789ABDCEF123 + name: My other configuration + compute_service: none + network_settings_ids: + - 56789ABDCEF1234 + - 6789ABDCEF12345 + created_on: '2023-04-26T15:23:37Z' + network-configuration: + value: + id: 123456789ABCDEF + name: My network configuration + compute_service: actions + network_settings_ids: + - 23456789ABDCEF1 + - 3456789ABDCEF12 + created_on: '2022-10-09T23:39:01Z' + network-settings: + value: + id: 220F78DACB92BBFBC5E6F22DE1CCF52309D + network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 + name: my_network_settings + subnet_id: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" + region: eastus team-full: value: id: 1 @@ -216654,6 +217959,9 @@ components: cvss_v4: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 + epss: + - percentage: 0.00045 + percentile: 0.16001e0 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor @@ -216840,6 +218148,9 @@ components: cvss_v4: vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N score: 8.5 + epss: + - percentage: 0.00045 + percentile: 0.16001e0 cwes: - cwe_id: CWE-532 name: Insertion of Sensitive Information into Log File @@ -227841,6 +229152,18 @@ components: for these packages will be returned. schema: type: string + dependabot-alert-comma-separated-epss: + name: epss_percentage + in: query + description: |- + CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + - An exact number (`n`) + - Comparators such as `>n`, `=n`, `<=n` + - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + + Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. + schema: + type: string dependabot-alert-scope: name: scope in: query @@ -227858,11 +229181,13 @@ components: The property by which to sort the results. `created` means when the alert was created. `updated` means when the alert's state last changed. + `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. schema: type: string enum: - created - updated + - epss_percentage default: created pagination-first: name: first @@ -228104,6 +229429,13 @@ components: required: false schema: type: integer + hosted-runner-id: + name: hosted_runner_id + description: Unique identifier of the GitHub-hosted runner. + in: path + required: true + schema: + type: integer repository-id: name: repository_id description: The unique identifier of the repository. @@ -228560,6 +229892,20 @@ components: required: false schema: type: string + network-configuration-id: + name: network_configuration_id + description: Unique identifier of the hosted compute network configuration. + in: path + required: true + schema: + type: string + network-settings-id: + name: network_settings_id + description: Unique identifier of the hosted compute network settings. + in: path + required: true + schema: + type: string discussion-number: name: discussion_number description: The number that identifies the discussion. diff --git a/packages/openapi-typescript/examples/github-api-required.ts b/packages/openapi-typescript/examples/github-api-required.ts index 5b6e4ba00..ed8280c84 100644 --- a/packages/openapi-typescript/examples/github-api-required.ts +++ b/packages/openapi-typescript/examples/github-api-required.ts @@ -1763,6 +1763,164 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List GitHub-hosted runners for an organization + * @description Lists all GitHub-hosted runners configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. + */ + get: operations["actions/list-hosted-runners-for-org"]; + put?: never; + /** + * Create a GitHub-hosted runner for an organization + * @description Creates a GitHub-hosted runner for an organization. + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + post: operations["actions/create-hosted-runner-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub-owned images for GitHub-hosted runners in an organization + * @description Get the list of GitHub-owned images available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-github-owned-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/partner": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get partner images for GitHub-hosted runners in an organization + * @description Get the list of partner images available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-partner-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get limits on GitHub-hosted runners for an organization + * @description Get the GitHub-hosted runners limits for an organization. + */ + get: operations["actions/get-hosted-runners-limits-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/machine-sizes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub-hosted runners machine specs for an organization + * @description Get the list of machine specs available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-machine-specs-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/platforms": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get platforms for GitHub-hosted runners in an organization + * @description Get the list of platforms available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-platforms-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a GitHub-hosted runner for an organization + * @description Gets a GitHub-hosted runner configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-hosted-runner-for-org"]; + put?: never; + post?: never; + /** + * Delete a GitHub-hosted runner for an organization + * @description Deletes a GitHub-hosted runner for an organization. + */ + delete: operations["actions/delete-hosted-runner-for-org"]; + options?: never; + head?: never; + /** + * Update a GitHub-hosted runner for an organization + * @description Updates a GitHub-hosted runner for an organization. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + patch: operations["actions/update-hosted-runner-for-org"]; + trace?: never; + }; "/orgs/{org}/actions/oidc/customization/sub": { parameters: { query?: never; @@ -1998,6 +2156,28 @@ export interface paths { patch: operations["actions/update-self-hosted-runner-group-for-org"]; trace?: never; }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List GitHub-hosted runners in a group for an organization + * @description Lists the GitHub-hosted runners in an organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-github-hosted-runners-in-group-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { parameters: { query?: never; @@ -5622,6 +5802,90 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/settings/network-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List hosted compute network configurations for an organization + * @description Lists all hosted compute network configurations configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/list-network-configurations-for-org"]; + put?: never; + /** + * Create a hosted compute network configuration for an organization + * @description Creates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + post: operations["hosted-compute/create-network-configuration-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a hosted compute network configuration for an organization + * @description Gets a hosted compute network configuration configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/get-network-configuration-for-org"]; + put?: never; + post?: never; + /** + * Delete a hosted compute network configuration from an organization + * @description Deletes a hosted compute network configuration from an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + delete: operations["hosted-compute/delete-network-configuration-from-org"]; + options?: never; + head?: never; + /** + * Update a hosted compute network configuration for an organization + * @description Updates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + patch: operations["hosted-compute/update-network-configuration-for-org"]; + trace?: never; + }; + "/orgs/{org}/settings/network-settings/{network_settings_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a hosted compute network settings resource for an organization + * @description Gets a hosted compute network settings resource configured for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/get-network-settings-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/team/{team_slug}/copilot/metrics": { parameters: { query?: never; @@ -8205,19 +8469,19 @@ export interface paths { cookie?: never; }; /** - * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Check if Dependabot security updates are enabled for a repository + * @description Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ get: operations["repos/check-automated-security-fixes"]; /** - * Enable automated security fixes - * @description Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Enable Dependabot security updates + * @description Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ put: operations["repos/enable-automated-security-fixes"]; post?: never; /** - * Disable automated security fixes - * @description Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Disable Dependabot security updates + * @description Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ delete: operations["repos/disable-automated-security-fixes"]; options?: never; @@ -14299,7 +14563,7 @@ export interface paths { }; /** * Get secret scanning scan history for a repository - * @description Lists the latest incremental and backfill scans by type for a repository. + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -17347,9 +17611,11 @@ export interface paths { * Get a user using their ID * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ get: operations["users/get-by-id"]; put?: never; @@ -17393,9 +17659,11 @@ export interface paths { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ get: operations["users/get-by-username"]; put?: never; @@ -18254,6 +18522,11 @@ export interface components { readonly score: number | null; } | null; } | null; + /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + "security-advisory-epss": { + percentage: number; + percentile: number; + } | null; /** * Simple User * @description A GitHub user. @@ -18415,16 +18688,13 @@ export interface components { readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - epss?: { - percentage: number; - percentile: number; - } | null; /** @description The users who contributed to the advisory. */ readonly credits: { user: components["schemas"]["simple-user"]; @@ -18451,79 +18721,52 @@ export interface components { errors?: string[]; }; /** - * Simple User - * @description A GitHub user. + * Enterprise + * @description An enterprise on GitHub. */ - "nullable-simple-user": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** - * Format: int64 - * @example 1 - */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + enterprise: { + /** @description A short description of the enterprise. */ + description?: string | null; /** * Format: uri - * @example https://api.github.com/users/octocat + * @example https://github.com/enterprises/octo-business */ - url: string; + html_url: string; /** * Format: uri - * @example https://github.com/octocat + * @description The enterprise's website URL. */ - html_url: string; + website_url?: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/followers + * @description Unique identifier of the enterprise + * @example 42 */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + node_id: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions + * @description The name of the enterprise. + * @example Octo Business */ - subscriptions_url: string; + name: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs + * @description The slug url identifier for the enterprise. + * @example octo-business */ - organizations_url: string; + slug: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/repos + * Format: date-time + * @example 2019-01-26T19:01:12Z */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + created_at: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events + * Format: date-time + * @example 2019-01-26T19:14:43Z */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - /** @example public */ - user_view_type?: string; - } | null; + updated_at: string | null; + /** Format: uri */ + avatar_url: string; + }; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -18543,7 +18786,7 @@ export interface components { node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ client_id?: string; - owner: components["schemas"]["nullable-simple-user"]; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners @@ -18821,53 +19064,6 @@ export interface components { payload: string | null; }; }; - /** - * Enterprise - * @description An enterprise on GitHub. - */ - enterprise: { - /** @description A short description of the enterprise. */ - description?: string | null; - /** - * Format: uri - * @example https://github.com/enterprises/octo-business - */ - html_url: string; - /** - * Format: uri - * @description The enterprise's website URL. - */ - website_url?: string | null; - /** - * @description Unique identifier of the enterprise - * @example 42 - */ - id: number; - /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; - /** - * @description The name of the enterprise. - * @example Octo Business - */ - name: string; - /** - * @description The slug url identifier for the enterprise. - * @example octo-business - */ - slug: string; - /** - * Format: date-time - * @example 2019-01-26T19:01:12Z - */ - created_at: string | null; - /** - * Format: date-time - * @example 2019-01-26T19:14:43Z - */ - updated_at: string | null; - /** Format: uri */ - avatar_url: string; - }; /** * Integration Installation Request * @description Request to install an integration on a target @@ -19140,6 +19336,80 @@ export interface components { */ starring: "read" | "write"; }; + /** + * Simple User + * @description A GitHub user. + */ + "nullable-simple-user": { + name?: string | null; + email?: string | null; + /** @example octocat */ + login: string; + /** + * Format: int64 + * @example 1 + */ + id: number; + /** @example MDQ6VXNlcjE= */ + node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + received_events_url: string; + /** @example User */ + type: string; + site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + starred_at?: string; + /** @example public */ + user_view_type?: string; + } | null; /** * Installation * @description Installation @@ -20540,6 +20810,7 @@ export interface components { readonly vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: { /** @description The unique CWE ID. */ @@ -20828,7 +21099,7 @@ export interface components { node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ client_id?: string; - owner: components["schemas"]["nullable-simple-user"]; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners @@ -21193,6 +21464,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -21344,6 +21616,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -21381,6 +21654,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled: boolean; user: string | null; comments_url: string; owner: components["schemas"]["simple-user"]; @@ -22320,6 +22594,186 @@ export interface components { */ active_caches_count: number; }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + "nullable-actions-hosted-runner-pool-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example ubuntu-20.04 + */ + id: string; + /** + * @description Image size in GB. + * @example 86 + */ + size_gb: number; + /** + * @description Display name for this image. + * @example 20.04 + */ + display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + source: "github" | "partner" | "custom"; + /** + * @description The image version of the hosted runner pool. + * @example latest + */ + version: string; + } | null; + /** + * Github-owned VM details. + * @description Provides details of a particular machine spec. + */ + "actions-hosted-runner-machine-spec": { + /** + * @description The ID used for the `size` parameter when creating a new runner. + * @example 8-core + */ + id: string; + /** + * @description The number of cores. + * @example 8 + */ + cpu_cores: number; + /** + * @description The available RAM for the machine spec. + * @example 32 + */ + memory_gb: number; + /** + * @description The available SSD storage for the machine spec. + * @example 300 + */ + storage_gb: number; + }; + /** + * Public IP for a GitHub-hosted larger runners. + * @description Provides details of Public IP for a GitHub-hosted larger runners + */ + "public-ip": { + /** + * @description Whether public IP is enabled. + * @example true + */ + enabled: boolean; + /** + * @description The prefix for the public IP. + * @example 20.80.208.150 + */ + prefix: string; + /** + * @description The length of the IP prefix. + * @example 28 + */ + length: number; + }; + /** + * GitHub-hosted hosted runner + * @description A Github-hosted hosted runner. + */ + "actions-hosted-runner": { + /** + * @description The unique identifier of the hosted runner. + * @example 5 + */ + id: number; + /** + * @description The name of the hosted runner. + * @example my-github-hosted-runner + */ + name: string; + /** + * @description The unique identifier of the group that the hosted runner belongs to. + * @example 2 + */ + runner_group_id?: number; + image_details: components["schemas"]["nullable-actions-hosted-runner-pool-image"]; + machine_size_details: components["schemas"]["actions-hosted-runner-machine-spec"]; + /** + * @description The status of the runner. + * @example Ready + * @enum {string} + */ + status: "Ready" | "Provisioning" | "Shutdown" | "Deleting" | "Stuck"; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. + * @default 10 + * @example 5 + */ + maximum_runners: number; + /** + * @description Whether public IP is enabled for the hosted runners. + * @example true + */ + public_ip_enabled: boolean; + /** @description The public IP ranges when public IP is enabled for the hosted runners. */ + public_ips?: components["schemas"]["public-ip"][]; + /** + * Format: date-time + * @description The time at which the runner was last used, in ISO 8601 format. + * @example 2022-10-09T23:39:01Z + */ + last_active_on?: string | null; + }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + "actions-hosted-runner-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example ubuntu-20.04 + */ + id: string; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description Image size in GB. + * @example 86 + */ + size_gb: number; + /** + * @description Display name for this image. + * @example 20.04 + */ + display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + source: "github" | "partner" | "custom"; + }; + "actions-hosted-runner-limits": { + /** + * Static public IP Limits for GitHub-hosted Hosted Runners. + * @description Provides details of static public IP limits for GitHub-hosted Hosted Runners + */ + public_ips: { + /** + * @description The maximum number of static public IP addresses that can be used for Hosted Runners. + * @example 50 + */ + maximum: number; + /** + * @description The current number of static public IP addresses in use by Hosted Runners. + * @example 17 + */ + current_usage: number; + }; + }; /** * Actions OIDC Subject customization * @description Actions OIDC Subject customization @@ -22387,6 +22841,8 @@ export interface components { selected_repositories_url?: string; runners_url: string; hosted_runners_url?: string; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string; inherited: boolean; inherited_allows_public_repositories?: boolean; allows_public_repositories: boolean; @@ -23163,6 +23619,8 @@ export interface components { sync_to_organizations: string; /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ group_id?: string | null; + /** @example Justice League */ + group_name?: string | null; /** * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league @@ -26009,6 +26467,69 @@ export interface components { /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ estimated_storage_for_month: number; }; + /** + * Hosted compute network configuration + * @description A hosted compute network configuration. + */ + "network-configuration": { + /** + * @description The unique identifier of the network configuration. + * @example 123ABC456DEF789 + */ + id: string; + /** + * @description The name of the network configuration. + * @example my-network-configuration + */ + name: string; + /** + * @description The hosted compute service the network configuration supports. + * @enum {string} + */ + compute_service?: "none" | "actions" | "codespaces"; + /** + * @description The unique identifier of each network settings in the configuration. + * @example 123ABC456DEF789 + */ + network_settings_ids?: string[]; + /** + * Format: date-time + * @description The time at which the network configuration was created, in ISO 8601 format. + * @example 2024-04-26T11:31:07Z + */ + created_on: string | null; + }; + /** + * Hosted compute network settings resource + * @description A hosted compute network settings resource. + */ + "network-settings": { + /** + * @description The unique identifier of the network settings resource. + * @example 220F78DACB92BBFBC5E6F22DE1CCF52309D + */ + id: string; + /** + * @description The identifier of the network configuration that is using this settings resource. + * @example 934E208B3EE0BD60CF5F752C426BFB53562 + */ + network_configuration_id?: string; + /** + * @description The name of the network settings resource. + * @example my-network-settings + */ + name: string; + /** + * @description The subnet this network settings resource is configured for. + * @example /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet + */ + subnet_id: string; + /** + * @description The location of the subnet this network settings resource is configured for. + * @example eastus + */ + region: string; + }; /** * Team Organization * @description Team Organization @@ -27709,17 +28230,17 @@ export interface components { is_alphanumeric: boolean; }; /** - * Check Automated Security Fixes - * @description Check Automated Security Fixes + * Check Dependabot security updates + * @description Check Dependabot security updates */ "check-automated-security-fixes": { /** - * @description Whether automated security fixes are enabled for the repository. + * @description Whether Dependabot security updates are enabled for the repository. * @example true */ enabled: boolean; /** - * @description Whether automated security fixes are paused for the repository. + * @description Whether Dependabot security updates are paused for the repository. * @example false */ paused: boolean; @@ -28822,6 +29343,16 @@ export interface components { state: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + /** + * @description Runner type to be used. + * @enum {string|null} + */ + runner_type: "standard" | "labeled" | null; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -40713,11 +41244,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -40765,10 +41299,10 @@ export interface components { severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed" | null; tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; @@ -40840,11 +41374,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -40937,6 +41474,7 @@ export interface components { dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ fixed_at?: unknown; /** * Format: uri @@ -40992,7 +41530,7 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | null; @@ -41069,11 +41607,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41129,10 +41670,10 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "fixed"; + state: "fixed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41165,8 +41706,11 @@ export interface components { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; dismissed_by: Record | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41220,10 +41764,10 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41258,8 +41802,11 @@ export interface components { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: unknown; dismissed_by: unknown; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41307,10 +41854,10 @@ export interface components { severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "fixed"; + state: "open" | "fixed" | null; tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; @@ -87047,12 +87594,20 @@ export interface components { "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ "dependabot-alert-comma-separated-packages": string; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + "dependabot-alert-comma-separated-epss": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ "dependabot-alert-scope": "development" | "runtime"; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ - "dependabot-alert-sort": "created" | "updated"; + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ + "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ @@ -87111,6 +87666,8 @@ export interface components { "billing-usage-report-day": number; /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ "billing-usage-report-hour": number; + /** @description Unique identifier of the GitHub-hosted runner. */ + "hosted-runner-id": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -87222,6 +87779,10 @@ export interface components { "secret-scanning-pagination-before-org-repo": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ "secret-scanning-pagination-after-org-repo": string; + /** @description Unique identifier of the hosted compute network configuration. */ + "network-configuration-id": string; + /** @description Unique identifier of the hosted compute network settings. */ + "network-settings-id": string; /** @description The number that identifies the discussion. */ "discussion-number": number; /** @description The number that identifies the comment. */ @@ -88742,11 +89303,19 @@ export interface operations { ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -90593,6 +91162,306 @@ export interface operations { }; }; }; + "actions/list-hosted-runners-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; + "actions/create-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; + /** @description The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + image: { + /** @description The unique identifier of the runner image. */ + id: string; + /** + * @description The source of the runner image. + * @enum {string} + */ + source: "github" | "partner" | "custom"; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + version: string | null; + }; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + size: string; + /** @description The existing runner group to add this runner to. */ + runner_group_id: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + maximum_runners?: number; + /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + enable_static_ip?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/get-hosted-runners-github-owned-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-partner-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-limits-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-limits"]; + }; + }; + }; + }; + "actions/get-hosted-runners-machine-specs-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + machine_specs: components["schemas"]["actions-hosted-runner-machine-spec"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-platforms-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + platforms: string[]; + }; + }; + }; + }; + }; + "actions/get-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/delete-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/update-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; + /** @description The existing runner group to add this runner to. */ + runner_group_id: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + maximum_runners: number; + /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + enable_static_ip: boolean; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + image_version: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; "oidc/get-oidc-custom-sub-template-for-org": { parameters: { query?: never; @@ -90967,6 +91836,8 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string; }; }; }; @@ -91064,6 +91935,8 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string | null; }; }; }; @@ -91079,6 +91952,40 @@ export interface operations { }; }; }; + "actions/list-github-hosted-runners-in-group-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; "actions/list-repo-access-to-self-hosted-runner-group-in-org": { parameters: { query?: { @@ -93660,11 +94567,19 @@ export interface operations { ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -97833,6 +98748,189 @@ export interface operations { }; }; }; + "hosted-compute/list-network-configurations-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + network_configurations: components["schemas"]["network-configuration"][]; + }; + }; + }; + }; + }; + "hosted-compute/create-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + network_settings_ids: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/get-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/delete-network-configuration-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "hosted-compute/update-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + compute_service: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + network_settings_ids: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/get-network-settings-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network settings. */ + network_settings_id: components["parameters"]["network-settings-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-settings"]; + }; + }; + }; + }; "copilot/copilot-metrics-for-team": { parameters: { query?: { @@ -106913,11 +108011,19 @@ export interface operations { package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -111072,7 +112178,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The sub-issue to remove */ + /** @description The id of the sub-issue to remove */ sub_issue_id: number; }; }; @@ -111145,7 +112251,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The sub-issue to add */ + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ replace_parent?: boolean; @@ -115892,7 +116998,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; diff --git a/packages/openapi-typescript/examples/github-api-root-types.ts b/packages/openapi-typescript/examples/github-api-root-types.ts index 19bfd78c3..f010442dc 100644 --- a/packages/openapi-typescript/examples/github-api-root-types.ts +++ b/packages/openapi-typescript/examples/github-api-root-types.ts @@ -1763,6 +1763,164 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List GitHub-hosted runners for an organization + * @description Lists all GitHub-hosted runners configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. + */ + get: operations["actions/list-hosted-runners-for-org"]; + put?: never; + /** + * Create a GitHub-hosted runner for an organization + * @description Creates a GitHub-hosted runner for an organization. + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + post: operations["actions/create-hosted-runner-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub-owned images for GitHub-hosted runners in an organization + * @description Get the list of GitHub-owned images available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-github-owned-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/partner": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get partner images for GitHub-hosted runners in an organization + * @description Get the list of partner images available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-partner-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get limits on GitHub-hosted runners for an organization + * @description Get the GitHub-hosted runners limits for an organization. + */ + get: operations["actions/get-hosted-runners-limits-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/machine-sizes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub-hosted runners machine specs for an organization + * @description Get the list of machine specs available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-machine-specs-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/platforms": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get platforms for GitHub-hosted runners in an organization + * @description Get the list of platforms available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-platforms-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a GitHub-hosted runner for an organization + * @description Gets a GitHub-hosted runner configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-hosted-runner-for-org"]; + put?: never; + post?: never; + /** + * Delete a GitHub-hosted runner for an organization + * @description Deletes a GitHub-hosted runner for an organization. + */ + delete: operations["actions/delete-hosted-runner-for-org"]; + options?: never; + head?: never; + /** + * Update a GitHub-hosted runner for an organization + * @description Updates a GitHub-hosted runner for an organization. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + patch: operations["actions/update-hosted-runner-for-org"]; + trace?: never; + }; "/orgs/{org}/actions/oidc/customization/sub": { parameters: { query?: never; @@ -1998,6 +2156,28 @@ export interface paths { patch: operations["actions/update-self-hosted-runner-group-for-org"]; trace?: never; }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List GitHub-hosted runners in a group for an organization + * @description Lists the GitHub-hosted runners in an organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-github-hosted-runners-in-group-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { parameters: { query?: never; @@ -5622,6 +5802,90 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/settings/network-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List hosted compute network configurations for an organization + * @description Lists all hosted compute network configurations configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/list-network-configurations-for-org"]; + put?: never; + /** + * Create a hosted compute network configuration for an organization + * @description Creates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + post: operations["hosted-compute/create-network-configuration-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a hosted compute network configuration for an organization + * @description Gets a hosted compute network configuration configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/get-network-configuration-for-org"]; + put?: never; + post?: never; + /** + * Delete a hosted compute network configuration from an organization + * @description Deletes a hosted compute network configuration from an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + delete: operations["hosted-compute/delete-network-configuration-from-org"]; + options?: never; + head?: never; + /** + * Update a hosted compute network configuration for an organization + * @description Updates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + patch: operations["hosted-compute/update-network-configuration-for-org"]; + trace?: never; + }; + "/orgs/{org}/settings/network-settings/{network_settings_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a hosted compute network settings resource for an organization + * @description Gets a hosted compute network settings resource configured for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/get-network-settings-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/team/{team_slug}/copilot/metrics": { parameters: { query?: never; @@ -8205,19 +8469,19 @@ export interface paths { cookie?: never; }; /** - * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Check if Dependabot security updates are enabled for a repository + * @description Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ get: operations["repos/check-automated-security-fixes"]; /** - * Enable automated security fixes - * @description Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Enable Dependabot security updates + * @description Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ put: operations["repos/enable-automated-security-fixes"]; post?: never; /** - * Disable automated security fixes - * @description Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Disable Dependabot security updates + * @description Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ delete: operations["repos/disable-automated-security-fixes"]; options?: never; @@ -14299,7 +14563,7 @@ export interface paths { }; /** * Get secret scanning scan history for a repository - * @description Lists the latest incremental and backfill scans by type for a repository. + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -17347,9 +17611,11 @@ export interface paths { * Get a user using their ID * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ get: operations["users/get-by-id"]; put?: never; @@ -17393,9 +17659,11 @@ export interface paths { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ get: operations["users/get-by-username"]; put?: never; @@ -18254,6 +18522,11 @@ export interface components { readonly score: number | null; } | null; } | null; + /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + "security-advisory-epss": { + percentage?: number; + percentile?: number; + } | null; /** * Simple User * @description A GitHub user. @@ -18415,16 +18688,13 @@ export interface components { readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - epss?: { - percentage?: number; - percentile?: number; - } | null; /** @description The users who contributed to the advisory. */ readonly credits: { user: components["schemas"]["simple-user"]; @@ -18451,79 +18721,52 @@ export interface components { errors?: string[]; }; /** - * Simple User - * @description A GitHub user. + * Enterprise + * @description An enterprise on GitHub. */ - "nullable-simple-user": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** - * Format: int64 - * @example 1 - */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + enterprise: { + /** @description A short description of the enterprise. */ + description?: string | null; /** * Format: uri - * @example https://api.github.com/users/octocat + * @example https://github.com/enterprises/octo-business */ - url: string; + html_url: string; /** * Format: uri - * @example https://github.com/octocat + * @description The enterprise's website URL. */ - html_url: string; + website_url?: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/followers + * @description Unique identifier of the enterprise + * @example 42 */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + node_id: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions + * @description The name of the enterprise. + * @example Octo Business */ - subscriptions_url: string; + name: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs + * @description The slug url identifier for the enterprise. + * @example octo-business */ - organizations_url: string; + slug: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/repos + * Format: date-time + * @example 2019-01-26T19:01:12Z */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + created_at: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events + * Format: date-time + * @example 2019-01-26T19:14:43Z */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - /** @example public */ - user_view_type?: string; - } | null; + updated_at: string | null; + /** Format: uri */ + avatar_url: string; + }; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -18543,7 +18786,7 @@ export interface components { node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ client_id?: string; - owner: components["schemas"]["nullable-simple-user"]; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners @@ -18821,53 +19064,6 @@ export interface components { payload: string | null; }; }; - /** - * Enterprise - * @description An enterprise on GitHub. - */ - enterprise: { - /** @description A short description of the enterprise. */ - description?: string | null; - /** - * Format: uri - * @example https://github.com/enterprises/octo-business - */ - html_url: string; - /** - * Format: uri - * @description The enterprise's website URL. - */ - website_url?: string | null; - /** - * @description Unique identifier of the enterprise - * @example 42 - */ - id: number; - /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; - /** - * @description The name of the enterprise. - * @example Octo Business - */ - name: string; - /** - * @description The slug url identifier for the enterprise. - * @example octo-business - */ - slug: string; - /** - * Format: date-time - * @example 2019-01-26T19:01:12Z - */ - created_at: string | null; - /** - * Format: date-time - * @example 2019-01-26T19:14:43Z - */ - updated_at: string | null; - /** Format: uri */ - avatar_url: string; - }; /** * Integration Installation Request * @description Request to install an integration on a target @@ -19140,6 +19336,80 @@ export interface components { */ starring?: "read" | "write"; }; + /** + * Simple User + * @description A GitHub user. + */ + "nullable-simple-user": { + name?: string | null; + email?: string | null; + /** @example octocat */ + login: string; + /** + * Format: int64 + * @example 1 + */ + id: number; + /** @example MDQ6VXNlcjE= */ + node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + received_events_url: string; + /** @example User */ + type: string; + site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + starred_at?: string; + /** @example public */ + user_view_type?: string; + } | null; /** * Installation * @description Installation @@ -20540,6 +20810,7 @@ export interface components { readonly vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: { /** @description The unique CWE ID. */ @@ -20828,7 +21099,7 @@ export interface components { node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ client_id?: string; - owner: components["schemas"]["nullable-simple-user"]; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners @@ -21193,6 +21464,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -21344,6 +21616,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -21381,6 +21654,7 @@ export interface components { updated_at?: string; description?: string | null; comments?: number; + comments_enabled?: boolean; user?: string | null; comments_url?: string; owner?: components["schemas"]["simple-user"]; @@ -22320,6 +22594,186 @@ export interface components { */ active_caches_count: number; }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + "nullable-actions-hosted-runner-pool-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example ubuntu-20.04 + */ + id: string; + /** + * @description Image size in GB. + * @example 86 + */ + size_gb: number; + /** + * @description Display name for this image. + * @example 20.04 + */ + display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + source: "github" | "partner" | "custom"; + /** + * @description The image version of the hosted runner pool. + * @example latest + */ + version: string; + } | null; + /** + * Github-owned VM details. + * @description Provides details of a particular machine spec. + */ + "actions-hosted-runner-machine-spec": { + /** + * @description The ID used for the `size` parameter when creating a new runner. + * @example 8-core + */ + id: string; + /** + * @description The number of cores. + * @example 8 + */ + cpu_cores: number; + /** + * @description The available RAM for the machine spec. + * @example 32 + */ + memory_gb: number; + /** + * @description The available SSD storage for the machine spec. + * @example 300 + */ + storage_gb: number; + }; + /** + * Public IP for a GitHub-hosted larger runners. + * @description Provides details of Public IP for a GitHub-hosted larger runners + */ + "public-ip": { + /** + * @description Whether public IP is enabled. + * @example true + */ + enabled?: boolean; + /** + * @description The prefix for the public IP. + * @example 20.80.208.150 + */ + prefix?: string; + /** + * @description The length of the IP prefix. + * @example 28 + */ + length?: number; + }; + /** + * GitHub-hosted hosted runner + * @description A Github-hosted hosted runner. + */ + "actions-hosted-runner": { + /** + * @description The unique identifier of the hosted runner. + * @example 5 + */ + id: number; + /** + * @description The name of the hosted runner. + * @example my-github-hosted-runner + */ + name: string; + /** + * @description The unique identifier of the group that the hosted runner belongs to. + * @example 2 + */ + runner_group_id?: number; + image_details: components["schemas"]["nullable-actions-hosted-runner-pool-image"]; + machine_size_details: components["schemas"]["actions-hosted-runner-machine-spec"]; + /** + * @description The status of the runner. + * @example Ready + * @enum {string} + */ + status: "Ready" | "Provisioning" | "Shutdown" | "Deleting" | "Stuck"; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. + * @default 10 + * @example 5 + */ + maximum_runners: number; + /** + * @description Whether public IP is enabled for the hosted runners. + * @example true + */ + public_ip_enabled: boolean; + /** @description The public IP ranges when public IP is enabled for the hosted runners. */ + public_ips?: components["schemas"]["public-ip"][]; + /** + * Format: date-time + * @description The time at which the runner was last used, in ISO 8601 format. + * @example 2022-10-09T23:39:01Z + */ + last_active_on?: string | null; + }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + "actions-hosted-runner-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example ubuntu-20.04 + */ + id: string; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description Image size in GB. + * @example 86 + */ + size_gb: number; + /** + * @description Display name for this image. + * @example 20.04 + */ + display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + source: "github" | "partner" | "custom"; + }; + "actions-hosted-runner-limits": { + /** + * Static public IP Limits for GitHub-hosted Hosted Runners. + * @description Provides details of static public IP limits for GitHub-hosted Hosted Runners + */ + public_ips: { + /** + * @description The maximum number of static public IP addresses that can be used for Hosted Runners. + * @example 50 + */ + maximum: number; + /** + * @description The current number of static public IP addresses in use by Hosted Runners. + * @example 17 + */ + current_usage: number; + }; + }; /** * Actions OIDC Subject customization * @description Actions OIDC Subject customization @@ -22387,6 +22841,8 @@ export interface components { selected_repositories_url?: string; runners_url: string; hosted_runners_url?: string; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string; inherited: boolean; inherited_allows_public_repositories?: boolean; allows_public_repositories: boolean; @@ -23163,6 +23619,8 @@ export interface components { sync_to_organizations: string; /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ group_id?: string | null; + /** @example Justice League */ + group_name?: string | null; /** * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league @@ -26009,6 +26467,69 @@ export interface components { /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ estimated_storage_for_month: number; }; + /** + * Hosted compute network configuration + * @description A hosted compute network configuration. + */ + "network-configuration": { + /** + * @description The unique identifier of the network configuration. + * @example 123ABC456DEF789 + */ + id: string; + /** + * @description The name of the network configuration. + * @example my-network-configuration + */ + name: string; + /** + * @description The hosted compute service the network configuration supports. + * @enum {string} + */ + compute_service?: "none" | "actions" | "codespaces"; + /** + * @description The unique identifier of each network settings in the configuration. + * @example 123ABC456DEF789 + */ + network_settings_ids?: string[]; + /** + * Format: date-time + * @description The time at which the network configuration was created, in ISO 8601 format. + * @example 2024-04-26T11:31:07Z + */ + created_on: string | null; + }; + /** + * Hosted compute network settings resource + * @description A hosted compute network settings resource. + */ + "network-settings": { + /** + * @description The unique identifier of the network settings resource. + * @example 220F78DACB92BBFBC5E6F22DE1CCF52309D + */ + id: string; + /** + * @description The identifier of the network configuration that is using this settings resource. + * @example 934E208B3EE0BD60CF5F752C426BFB53562 + */ + network_configuration_id?: string; + /** + * @description The name of the network settings resource. + * @example my-network-settings + */ + name: string; + /** + * @description The subnet this network settings resource is configured for. + * @example /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet + */ + subnet_id: string; + /** + * @description The location of the subnet this network settings resource is configured for. + * @example eastus + */ + region: string; + }; /** * Team Organization * @description Team Organization @@ -27709,17 +28230,17 @@ export interface components { is_alphanumeric: boolean; }; /** - * Check Automated Security Fixes - * @description Check Automated Security Fixes + * Check Dependabot security updates + * @description Check Dependabot security updates */ "check-automated-security-fixes": { /** - * @description Whether automated security fixes are enabled for the repository. + * @description Whether Dependabot security updates are enabled for the repository. * @example true */ enabled: boolean; /** - * @description Whether automated security fixes are paused for the repository. + * @description Whether Dependabot security updates are paused for the repository. * @example false */ paused: boolean; @@ -28822,6 +29343,16 @@ export interface components { state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + /** + * @description Runner type to be used. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | null; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -40713,11 +41244,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -40765,10 +41299,10 @@ export interface components { severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed" | null; tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; @@ -40840,11 +41374,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -40937,6 +41474,7 @@ export interface components { dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ fixed_at?: unknown; /** * Format: uri @@ -40992,7 +41530,7 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | null; @@ -41069,11 +41607,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41129,10 +41670,10 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "fixed"; + state: "fixed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41165,8 +41706,11 @@ export interface components { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; dismissed_by: Record | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41220,10 +41764,10 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41258,8 +41802,11 @@ export interface components { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: unknown; dismissed_by: unknown; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41307,10 +41854,10 @@ export interface components { severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "fixed"; + state: "open" | "fixed" | null; tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; @@ -87047,12 +87594,20 @@ export interface components { "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ "dependabot-alert-comma-separated-packages": string; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + "dependabot-alert-comma-separated-epss": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ "dependabot-alert-scope": "development" | "runtime"; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ - "dependabot-alert-sort": "created" | "updated"; + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ + "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ @@ -87111,6 +87666,8 @@ export interface components { "billing-usage-report-day": number; /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ "billing-usage-report-hour": number; + /** @description Unique identifier of the GitHub-hosted runner. */ + "hosted-runner-id": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -87222,6 +87779,10 @@ export interface components { "secret-scanning-pagination-before-org-repo": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ "secret-scanning-pagination-after-org-repo": string; + /** @description Unique identifier of the hosted compute network configuration. */ + "network-configuration-id": string; + /** @description Unique identifier of the hosted compute network settings. */ + "network-settings-id": string; /** @description The number that identifies the discussion. */ "discussion-number": number; /** @description The number that identifies the comment. */ @@ -87389,12 +87950,13 @@ export type SchemaRoot = components['schemas']['root']; export type SchemaSecurityAdvisoryEcosystems = components['schemas']['security-advisory-ecosystems']; export type SchemaVulnerability = components['schemas']['vulnerability']; export type SchemaCvssSeverities = components['schemas']['cvss-severities']; +export type SchemaSecurityAdvisoryEpss = components['schemas']['security-advisory-epss']; export type SchemaSimpleUser = components['schemas']['simple-user']; export type SchemaSecurityAdvisoryCreditTypes = components['schemas']['security-advisory-credit-types']; export type SchemaGlobalAdvisory = components['schemas']['global-advisory']; export type SchemaBasicError = components['schemas']['basic-error']; export type SchemaValidationErrorSimple = components['schemas']['validation-error-simple']; -export type SchemaNullableSimpleUser = components['schemas']['nullable-simple-user']; +export type SchemaEnterprise = components['schemas']['enterprise']; export type SchemaIntegration = components['schemas']['integration']; export type SchemaWebhookConfigUrl = components['schemas']['webhook-config-url']; export type SchemaWebhookConfigContentType = components['schemas']['webhook-config-content-type']; @@ -87405,9 +87967,9 @@ export type SchemaHookDeliveryItem = components['schemas']['hook-delivery-item'] export type SchemaScimError = components['schemas']['scim-error']; export type SchemaValidationError = components['schemas']['validation-error']; export type SchemaHookDelivery = components['schemas']['hook-delivery']; -export type SchemaEnterprise = components['schemas']['enterprise']; export type SchemaIntegrationInstallationRequest = components['schemas']['integration-installation-request']; export type SchemaAppPermissions = components['schemas']['app-permissions']; +export type SchemaNullableSimpleUser = components['schemas']['nullable-simple-user']; export type SchemaInstallation = components['schemas']['installation']; export type SchemaNullableLicenseSimple = components['schemas']['nullable-license-simple']; export type SchemaRepository = components['schemas']['repository']; @@ -87477,6 +88039,12 @@ export type SchemaBillingUsageReport = components['schemas']['billing-usage-repo export type SchemaOrganizationFull = components['schemas']['organization-full']; export type SchemaActionsCacheUsageOrgEnterprise = components['schemas']['actions-cache-usage-org-enterprise']; export type SchemaActionsCacheUsageByRepository = components['schemas']['actions-cache-usage-by-repository']; +export type SchemaNullableActionsHostedRunnerPoolImage = components['schemas']['nullable-actions-hosted-runner-pool-image']; +export type SchemaActionsHostedRunnerMachineSpec = components['schemas']['actions-hosted-runner-machine-spec']; +export type SchemaPublicIp = components['schemas']['public-ip']; +export type SchemaActionsHostedRunner = components['schemas']['actions-hosted-runner']; +export type SchemaActionsHostedRunnerImage = components['schemas']['actions-hosted-runner-image']; +export type SchemaActionsHostedRunnerLimits = components['schemas']['actions-hosted-runner-limits']; export type SchemaOidcCustomSub = components['schemas']['oidc-custom-sub']; export type SchemaEmptyObject = components['schemas']['empty-object']; export type SchemaEnabledRepositories = components['schemas']['enabled-repositories']; @@ -87606,6 +88174,8 @@ export type SchemaRepositoryAdvisory = components['schemas']['repository-advisor export type SchemaActionsBillingUsage = components['schemas']['actions-billing-usage']; export type SchemaPackagesBillingUsage = components['schemas']['packages-billing-usage']; export type SchemaCombinedBillingUsage = components['schemas']['combined-billing-usage']; +export type SchemaNetworkConfiguration = components['schemas']['network-configuration']; +export type SchemaNetworkSettings = components['schemas']['network-settings']; export type SchemaTeamOrganization = components['schemas']['team-organization']; export type SchemaTeamFull = components['schemas']['team-full']; export type SchemaTeamDiscussion = components['schemas']['team-discussion']; @@ -88246,6 +88816,7 @@ export type ParameterDependabotAlertCommaSeparatedStates = components['parameter export type ParameterDependabotAlertCommaSeparatedSeverities = components['parameters']['dependabot-alert-comma-separated-severities']; export type ParameterDependabotAlertCommaSeparatedEcosystems = components['parameters']['dependabot-alert-comma-separated-ecosystems']; export type ParameterDependabotAlertCommaSeparatedPackages = components['parameters']['dependabot-alert-comma-separated-packages']; +export type ParameterDependabotAlertCommaSeparatedEpss = components['parameters']['dependabot-alert-comma-separated-epss']; export type ParameterDependabotAlertScope = components['parameters']['dependabot-alert-scope']; export type ParameterDependabotAlertSort = components['parameters']['dependabot-alert-sort']; export type ParameterPaginationFirst = components['parameters']['pagination-first']; @@ -88275,6 +88846,7 @@ export type ParameterBillingUsageReportYear = components['parameters']['billing- export type ParameterBillingUsageReportMonth = components['parameters']['billing-usage-report-month']; export type ParameterBillingUsageReportDay = components['parameters']['billing-usage-report-day']; export type ParameterBillingUsageReportHour = components['parameters']['billing-usage-report-hour']; +export type ParameterHostedRunnerId = components['parameters']['hosted-runner-id']; export type ParameterRepositoryId = components['parameters']['repository-id']; export type ParameterVisibleToRepository = components['parameters']['visible-to-repository']; export type ParameterRunnerGroupId = components['parameters']['runner-group-id']; @@ -88325,6 +88897,8 @@ export type ParameterRuleSuiteResult = components['parameters']['rule-suite-resu export type ParameterRuleSuiteId = components['parameters']['rule-suite-id']; export type ParameterSecretScanningPaginationBeforeOrgRepo = components['parameters']['secret-scanning-pagination-before-org-repo']; export type ParameterSecretScanningPaginationAfterOrgRepo = components['parameters']['secret-scanning-pagination-after-org-repo']; +export type ParameterNetworkConfigurationId = components['parameters']['network-configuration-id']; +export type ParameterNetworkSettingsId = components['parameters']['network-settings-id']; export type ParameterDiscussionNumber = components['parameters']['discussion-number']; export type ParameterCommentNumber = components['parameters']['comment-number']; export type ParameterReactionId = components['parameters']['reaction-id']; @@ -89756,11 +90330,19 @@ export interface operations { ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -91607,6 +92189,306 @@ export interface operations { }; }; }; + "actions/list-hosted-runners-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; + "actions/create-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; + /** @description The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + image: { + /** @description The unique identifier of the runner image. */ + id?: string; + /** + * @description The source of the runner image. + * @enum {string} + */ + source?: "github" | "partner" | "custom"; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + version?: string | null; + }; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + size: string; + /** @description The existing runner group to add this runner to. */ + runner_group_id: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + maximum_runners?: number; + /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + enable_static_ip?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/get-hosted-runners-github-owned-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-partner-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-limits-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-limits"]; + }; + }; + }; + }; + "actions/get-hosted-runners-machine-specs-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + machine_specs: components["schemas"]["actions-hosted-runner-machine-spec"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-platforms-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + platforms: string[]; + }; + }; + }; + }; + }; + "actions/get-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/delete-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/update-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; + /** @description The existing runner group to add this runner to. */ + runner_group_id?: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + maximum_runners?: number; + /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + enable_static_ip?: boolean; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + image_version?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; "oidc/get-oidc-custom-sub-template-for-org": { parameters: { query?: never; @@ -91981,6 +92863,8 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string; }; }; }; @@ -92078,6 +92962,8 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string | null; }; }; }; @@ -92093,6 +92979,40 @@ export interface operations { }; }; }; + "actions/list-github-hosted-runners-in-group-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; "actions/list-repo-access-to-self-hosted-runner-group-in-org": { parameters: { query?: { @@ -94674,11 +95594,19 @@ export interface operations { ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -98847,6 +99775,189 @@ export interface operations { }; }; }; + "hosted-compute/list-network-configurations-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + network_configurations: components["schemas"]["network-configuration"][]; + }; + }; + }; + }; + }; + "hosted-compute/create-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + network_settings_ids: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/get-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/delete-network-configuration-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "hosted-compute/update-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + network_settings_ids?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/get-network-settings-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network settings. */ + network_settings_id: components["parameters"]["network-settings-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-settings"]; + }; + }; + }; + }; "copilot/copilot-metrics-for-team": { parameters: { query?: { @@ -107927,11 +109038,19 @@ export interface operations { package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -112086,7 +113205,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The sub-issue to remove */ + /** @description The id of the sub-issue to remove */ sub_issue_id: number; }; }; @@ -112159,7 +113278,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The sub-issue to add */ + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ replace_parent?: boolean; @@ -116906,7 +118025,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts index 20a0d85ff..13489f8f8 100644 --- a/packages/openapi-typescript/examples/github-api.ts +++ b/packages/openapi-typescript/examples/github-api.ts @@ -1763,6 +1763,164 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List GitHub-hosted runners for an organization + * @description Lists all GitHub-hosted runners configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. + */ + get: operations["actions/list-hosted-runners-for-org"]; + put?: never; + /** + * Create a GitHub-hosted runner for an organization + * @description Creates a GitHub-hosted runner for an organization. + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + post: operations["actions/create-hosted-runner-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub-owned images for GitHub-hosted runners in an organization + * @description Get the list of GitHub-owned images available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-github-owned-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/partner": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get partner images for GitHub-hosted runners in an organization + * @description Get the list of partner images available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-partner-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get limits on GitHub-hosted runners for an organization + * @description Get the GitHub-hosted runners limits for an organization. + */ + get: operations["actions/get-hosted-runners-limits-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/machine-sizes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub-hosted runners machine specs for an organization + * @description Get the list of machine specs available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-machine-specs-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/platforms": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get platforms for GitHub-hosted runners in an organization + * @description Get the list of platforms available for GitHub-hosted runners for an organization. + */ + get: operations["actions/get-hosted-runners-platforms-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a GitHub-hosted runner for an organization + * @description Gets a GitHub-hosted runner configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-hosted-runner-for-org"]; + put?: never; + post?: never; + /** + * Delete a GitHub-hosted runner for an organization + * @description Deletes a GitHub-hosted runner for an organization. + */ + delete: operations["actions/delete-hosted-runner-for-org"]; + options?: never; + head?: never; + /** + * Update a GitHub-hosted runner for an organization + * @description Updates a GitHub-hosted runner for an organization. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + patch: operations["actions/update-hosted-runner-for-org"]; + trace?: never; + }; "/orgs/{org}/actions/oidc/customization/sub": { parameters: { query?: never; @@ -1998,6 +2156,28 @@ export interface paths { patch: operations["actions/update-self-hosted-runner-group-for-org"]; trace?: never; }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List GitHub-hosted runners in a group for an organization + * @description Lists the GitHub-hosted runners in an organization group. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["actions/list-github-hosted-runners-in-group-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { parameters: { query?: never; @@ -5622,6 +5802,90 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/settings/network-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List hosted compute network configurations for an organization + * @description Lists all hosted compute network configurations configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/list-network-configurations-for-org"]; + put?: never; + /** + * Create a hosted compute network configuration for an organization + * @description Creates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + post: operations["hosted-compute/create-network-configuration-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a hosted compute network configuration for an organization + * @description Gets a hosted compute network configuration configured in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/get-network-configuration-for-org"]; + put?: never; + post?: never; + /** + * Delete a hosted compute network configuration from an organization + * @description Deletes a hosted compute network configuration from an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + delete: operations["hosted-compute/delete-network-configuration-from-org"]; + options?: never; + head?: never; + /** + * Update a hosted compute network configuration for an organization + * @description Updates a hosted compute network configuration for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + */ + patch: operations["hosted-compute/update-network-configuration-for-org"]; + trace?: never; + }; + "/orgs/{org}/settings/network-settings/{network_settings_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a hosted compute network settings resource for an organization + * @description Gets a hosted compute network settings resource configured for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + */ + get: operations["hosted-compute/get-network-settings-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/team/{team_slug}/copilot/metrics": { parameters: { query?: never; @@ -8205,19 +8469,19 @@ export interface paths { cookie?: never; }; /** - * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Check if Dependabot security updates are enabled for a repository + * @description Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ get: operations["repos/check-automated-security-fixes"]; /** - * Enable automated security fixes - * @description Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Enable Dependabot security updates + * @description Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ put: operations["repos/enable-automated-security-fixes"]; post?: never; /** - * Disable automated security fixes - * @description Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + * Disable Dependabot security updates + * @description Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ delete: operations["repos/disable-automated-security-fixes"]; options?: never; @@ -14299,7 +14563,7 @@ export interface paths { }; /** * Get secret scanning scan history for a repository - * @description Lists the latest incremental and backfill scans by type for a repository. + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ @@ -17347,9 +17611,11 @@ export interface paths { * Get a user using their ID * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + * + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ get: operations["users/get-by-id"]; put?: never; @@ -17393,9 +17659,11 @@ export interface paths { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ get: operations["users/get-by-username"]; put?: never; @@ -18254,6 +18522,11 @@ export interface components { readonly score: number | null; } | null; } | null; + /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ + "security-advisory-epss": { + percentage?: number; + percentile?: number; + } | null; /** * Simple User * @description A GitHub user. @@ -18415,16 +18688,13 @@ export interface components { readonly score: number | null; } | null; cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; - epss?: { - percentage?: number; - percentile?: number; - } | null; /** @description The users who contributed to the advisory. */ readonly credits: { user: components["schemas"]["simple-user"]; @@ -18451,79 +18721,52 @@ export interface components { errors?: string[]; }; /** - * Simple User - * @description A GitHub user. + * Enterprise + * @description An enterprise on GitHub. */ - "nullable-simple-user": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** - * Format: int64 - * @example 1 - */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; + enterprise: { + /** @description A short description of the enterprise. */ + description?: string | null; /** * Format: uri - * @example https://api.github.com/users/octocat + * @example https://github.com/enterprises/octo-business */ - url: string; + html_url: string; /** * Format: uri - * @example https://github.com/octocat + * @description The enterprise's website URL. */ - html_url: string; + website_url?: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/followers + * @description Unique identifier of the enterprise + * @example 42 */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; + id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + node_id: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions + * @description The name of the enterprise. + * @example Octo Business */ - subscriptions_url: string; + name: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs + * @description The slug url identifier for the enterprise. + * @example octo-business */ - organizations_url: string; + slug: string; /** - * Format: uri - * @example https://api.github.com/users/octocat/repos + * Format: date-time + * @example 2019-01-26T19:01:12Z */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; + created_at: string | null; /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events + * Format: date-time + * @example 2019-01-26T19:14:43Z */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - /** @example public */ - user_view_type?: string; - } | null; + updated_at: string | null; + /** Format: uri */ + avatar_url: string; + }; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -18543,7 +18786,7 @@ export interface components { node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ client_id?: string; - owner: components["schemas"]["nullable-simple-user"]; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners @@ -18821,53 +19064,6 @@ export interface components { payload: string | null; }; }; - /** - * Enterprise - * @description An enterprise on GitHub. - */ - enterprise: { - /** @description A short description of the enterprise. */ - description?: string | null; - /** - * Format: uri - * @example https://github.com/enterprises/octo-business - */ - html_url: string; - /** - * Format: uri - * @description The enterprise's website URL. - */ - website_url?: string | null; - /** - * @description Unique identifier of the enterprise - * @example 42 - */ - id: number; - /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; - /** - * @description The name of the enterprise. - * @example Octo Business - */ - name: string; - /** - * @description The slug url identifier for the enterprise. - * @example octo-business - */ - slug: string; - /** - * Format: date-time - * @example 2019-01-26T19:01:12Z - */ - created_at: string | null; - /** - * Format: date-time - * @example 2019-01-26T19:14:43Z - */ - updated_at: string | null; - /** Format: uri */ - avatar_url: string; - }; /** * Integration Installation Request * @description Request to install an integration on a target @@ -19140,6 +19336,80 @@ export interface components { */ starring?: "read" | "write"; }; + /** + * Simple User + * @description A GitHub user. + */ + "nullable-simple-user": { + name?: string | null; + email?: string | null; + /** @example octocat */ + login: string; + /** + * Format: int64 + * @example 1 + */ + id: number; + /** @example MDQ6VXNlcjE= */ + node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + received_events_url: string; + /** @example User */ + type: string; + site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + starred_at?: string; + /** @example public */ + user_view_type?: string; + } | null; /** * Installation * @description Installation @@ -20540,6 +20810,7 @@ export interface components { readonly vector_string: string | null; }; cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ readonly cwes: { /** @description The unique CWE ID. */ @@ -20828,7 +21099,7 @@ export interface components { node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ client_id?: string; - owner: components["schemas"]["nullable-simple-user"]; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners @@ -21193,6 +21464,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -21344,6 +21616,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -21381,6 +21654,7 @@ export interface components { updated_at?: string; description?: string | null; comments?: number; + comments_enabled?: boolean; user?: string | null; comments_url?: string; owner?: components["schemas"]["simple-user"]; @@ -22320,6 +22594,186 @@ export interface components { */ active_caches_count: number; }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + "nullable-actions-hosted-runner-pool-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example ubuntu-20.04 + */ + id: string; + /** + * @description Image size in GB. + * @example 86 + */ + size_gb: number; + /** + * @description Display name for this image. + * @example 20.04 + */ + display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + source: "github" | "partner" | "custom"; + /** + * @description The image version of the hosted runner pool. + * @example latest + */ + version: string; + } | null; + /** + * Github-owned VM details. + * @description Provides details of a particular machine spec. + */ + "actions-hosted-runner-machine-spec": { + /** + * @description The ID used for the `size` parameter when creating a new runner. + * @example 8-core + */ + id: string; + /** + * @description The number of cores. + * @example 8 + */ + cpu_cores: number; + /** + * @description The available RAM for the machine spec. + * @example 32 + */ + memory_gb: number; + /** + * @description The available SSD storage for the machine spec. + * @example 300 + */ + storage_gb: number; + }; + /** + * Public IP for a GitHub-hosted larger runners. + * @description Provides details of Public IP for a GitHub-hosted larger runners + */ + "public-ip": { + /** + * @description Whether public IP is enabled. + * @example true + */ + enabled?: boolean; + /** + * @description The prefix for the public IP. + * @example 20.80.208.150 + */ + prefix?: string; + /** + * @description The length of the IP prefix. + * @example 28 + */ + length?: number; + }; + /** + * GitHub-hosted hosted runner + * @description A Github-hosted hosted runner. + */ + "actions-hosted-runner": { + /** + * @description The unique identifier of the hosted runner. + * @example 5 + */ + id: number; + /** + * @description The name of the hosted runner. + * @example my-github-hosted-runner + */ + name: string; + /** + * @description The unique identifier of the group that the hosted runner belongs to. + * @example 2 + */ + runner_group_id?: number; + image_details: components["schemas"]["nullable-actions-hosted-runner-pool-image"]; + machine_size_details: components["schemas"]["actions-hosted-runner-machine-spec"]; + /** + * @description The status of the runner. + * @example Ready + * @enum {string} + */ + status: "Ready" | "Provisioning" | "Shutdown" | "Deleting" | "Stuck"; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. + * @default 10 + * @example 5 + */ + maximum_runners: number; + /** + * @description Whether public IP is enabled for the hosted runners. + * @example true + */ + public_ip_enabled: boolean; + /** @description The public IP ranges when public IP is enabled for the hosted runners. */ + public_ips?: components["schemas"]["public-ip"][]; + /** + * Format: date-time + * @description The time at which the runner was last used, in ISO 8601 format. + * @example 2022-10-09T23:39:01Z + */ + last_active_on?: string | null; + }; + /** + * GitHub-hosted runner image details. + * @description Provides details of a hosted runner image + */ + "actions-hosted-runner-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example ubuntu-20.04 + */ + id: string; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description Image size in GB. + * @example 86 + */ + size_gb: number; + /** + * @description Display name for this image. + * @example 20.04 + */ + display_name: string; + /** + * @description The image provider. + * @enum {string} + */ + source: "github" | "partner" | "custom"; + }; + "actions-hosted-runner-limits": { + /** + * Static public IP Limits for GitHub-hosted Hosted Runners. + * @description Provides details of static public IP limits for GitHub-hosted Hosted Runners + */ + public_ips: { + /** + * @description The maximum number of static public IP addresses that can be used for Hosted Runners. + * @example 50 + */ + maximum: number; + /** + * @description The current number of static public IP addresses in use by Hosted Runners. + * @example 17 + */ + current_usage: number; + }; + }; /** * Actions OIDC Subject customization * @description Actions OIDC Subject customization @@ -22387,6 +22841,8 @@ export interface components { selected_repositories_url?: string; runners_url: string; hosted_runners_url?: string; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string; inherited: boolean; inherited_allows_public_repositories?: boolean; allows_public_repositories: boolean; @@ -23163,6 +23619,8 @@ export interface components { sync_to_organizations: string; /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ group_id?: string | null; + /** @example Justice League */ + group_name?: string | null; /** * Format: uri * @example https://github.com/enterprises/dc/teams/justice-league @@ -26009,6 +26467,69 @@ export interface components { /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ estimated_storage_for_month: number; }; + /** + * Hosted compute network configuration + * @description A hosted compute network configuration. + */ + "network-configuration": { + /** + * @description The unique identifier of the network configuration. + * @example 123ABC456DEF789 + */ + id: string; + /** + * @description The name of the network configuration. + * @example my-network-configuration + */ + name: string; + /** + * @description The hosted compute service the network configuration supports. + * @enum {string} + */ + compute_service?: "none" | "actions" | "codespaces"; + /** + * @description The unique identifier of each network settings in the configuration. + * @example 123ABC456DEF789 + */ + network_settings_ids?: string[]; + /** + * Format: date-time + * @description The time at which the network configuration was created, in ISO 8601 format. + * @example 2024-04-26T11:31:07Z + */ + created_on: string | null; + }; + /** + * Hosted compute network settings resource + * @description A hosted compute network settings resource. + */ + "network-settings": { + /** + * @description The unique identifier of the network settings resource. + * @example 220F78DACB92BBFBC5E6F22DE1CCF52309D + */ + id: string; + /** + * @description The identifier of the network configuration that is using this settings resource. + * @example 934E208B3EE0BD60CF5F752C426BFB53562 + */ + network_configuration_id?: string; + /** + * @description The name of the network settings resource. + * @example my-network-settings + */ + name: string; + /** + * @description The subnet this network settings resource is configured for. + * @example /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet + */ + subnet_id: string; + /** + * @description The location of the subnet this network settings resource is configured for. + * @example eastus + */ + region: string; + }; /** * Team Organization * @description Team Organization @@ -27709,17 +28230,17 @@ export interface components { is_alphanumeric: boolean; }; /** - * Check Automated Security Fixes - * @description Check Automated Security Fixes + * Check Dependabot security updates + * @description Check Dependabot security updates */ "check-automated-security-fixes": { /** - * @description Whether automated security fixes are enabled for the repository. + * @description Whether Dependabot security updates are enabled for the repository. * @example true */ enabled: boolean; /** - * @description Whether automated security fixes are paused for the repository. + * @description Whether Dependabot security updates are paused for the repository. * @example false */ paused: boolean; @@ -28822,6 +29343,16 @@ export interface components { state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + /** + * @description Runner type to be used. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | null; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -40713,11 +41244,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -40765,10 +41299,10 @@ export interface components { severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed" | null; tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; @@ -40840,11 +41374,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -40937,6 +41474,7 @@ export interface components { dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ fixed_at?: unknown; /** * Format: uri @@ -40992,7 +41530,7 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ state: "open" | "dismissed" | null; @@ -41069,11 +41607,14 @@ export interface components { url?: string; user_view_type?: string; } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41129,10 +41670,10 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "fixed"; + state: "fixed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41165,8 +41706,11 @@ export interface components { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; dismissed_by: Record | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41220,10 +41764,10 @@ export interface components { tags?: string[] | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -41258,8 +41802,11 @@ export interface components { /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: unknown; dismissed_by: unknown; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. @@ -41307,10 +41854,10 @@ export interface components { severity: "none" | "note" | "warning" | "error" | null; }; /** - * @description State of a code scanning alert. - * @enum {string} + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} */ - state: "open" | "fixed"; + state: "open" | "fixed" | null; tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ name: string; @@ -87047,12 +87594,20 @@ export interface components { "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ "dependabot-alert-comma-separated-packages": string; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + "dependabot-alert-comma-separated-epss": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ "dependabot-alert-scope": "development" | "runtime"; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ - "dependabot-alert-sort": "created" | "updated"; + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ + "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ @@ -87111,6 +87666,8 @@ export interface components { "billing-usage-report-day": number; /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ "billing-usage-report-hour": number; + /** @description Unique identifier of the GitHub-hosted runner. */ + "hosted-runner-id": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ @@ -87222,6 +87779,10 @@ export interface components { "secret-scanning-pagination-before-org-repo": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ "secret-scanning-pagination-after-org-repo": string; + /** @description Unique identifier of the hosted compute network configuration. */ + "network-configuration-id": string; + /** @description Unique identifier of the hosted compute network settings. */ + "network-settings-id": string; /** @description The number that identifies the discussion. */ "discussion-number": number; /** @description The number that identifies the comment. */ @@ -88742,11 +89303,19 @@ export interface operations { ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -90593,6 +91162,306 @@ export interface operations { }; }; }; + "actions/list-hosted-runners-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; + "actions/create-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; + /** @description The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + image: { + /** @description The unique identifier of the runner image. */ + id?: string; + /** + * @description The source of the runner image. + * @enum {string} + */ + source?: "github" | "partner" | "custom"; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + version?: string | null; + }; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + size: string; + /** @description The existing runner group to add this runner to. */ + runner_group_id: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + maximum_runners?: number; + /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + enable_static_ip?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/get-hosted-runners-github-owned-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-partner-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-image"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-limits-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-limits"]; + }; + }; + }; + }; + "actions/get-hosted-runners-machine-specs-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + machine_specs: components["schemas"]["actions-hosted-runner-machine-spec"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-platforms-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + platforms: string[]; + }; + }; + }; + }; + }; + "actions/get-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/delete-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; + "actions/update-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the GitHub-hosted runner. */ + hosted_runner_id: components["parameters"]["hosted-runner-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; + /** @description The existing runner group to add this runner to. */ + runner_group_id?: number; + /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ + maximum_runners?: number; + /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ + enable_static_ip?: boolean; + /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ + image_version?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner"]; + }; + }; + }; + }; "oidc/get-oidc-custom-sub-template-for-org": { parameters: { query?: never; @@ -90967,6 +91836,8 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string; }; }; }; @@ -91064,6 +91935,8 @@ export interface operations { restricted_to_workflows?: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; + /** @description The identifier of a hosted compute network configuration. */ + network_configuration_id?: string | null; }; }; }; @@ -91079,6 +91952,40 @@ export interface operations { }; }; }; + "actions/list-github-hosted-runners-in-group-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ + runner_group_id: components["parameters"]["runner-group-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; + }; + }; + }; + }; + }; "actions/list-repo-access-to-self-hosted-runner-group-in-org": { parameters: { query?: { @@ -93660,11 +94567,19 @@ export interface operations { ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -97833,6 +98748,189 @@ export interface operations { }; }; }; + "hosted-compute/list-network-configurations-for-org": { + parameters: { + query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + network_configurations: components["schemas"]["network-configuration"][]; + }; + }; + }; + }; + }; + "hosted-compute/create-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + network_settings_ids: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/get-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/delete-network-configuration-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "hosted-compute/update-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + compute_service?: "none" | "actions"; + /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + network_settings_ids?: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-configuration"]; + }; + }; + }; + }; + "hosted-compute/get-network-settings-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network settings. */ + network_settings_id: components["parameters"]["network-settings-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["network-settings"]; + }; + }; + }; + }; "copilot/copilot-metrics-for-team": { parameters: { query?: { @@ -106913,11 +108011,19 @@ export interface operations { package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + /** @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @description The property by which to sort the results. * `created` means when the alert was created. - * `updated` means when the alert's state last changed. */ + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -111072,7 +112178,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The sub-issue to remove */ + /** @description The id of the sub-issue to remove */ sub_issue_id: number; }; }; @@ -111145,7 +112251,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The sub-issue to add */ + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ replace_parent?: boolean; @@ -115892,7 +116998,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; diff --git a/packages/openapi-typescript/examples/github-api.yaml b/packages/openapi-typescript/examples/github-api.yaml index 1724d88ad..fce72e63f 100644 --- a/packages/openapi-typescript/examples/github-api.yaml +++ b/packages/openapi-typescript/examples/github-api.yaml @@ -93,6 +93,8 @@ tags: description: Endpoints to manage Code security using the REST API. - name: private-registries description: Manage private registry configurations. +- name: hosted-compute + description: Manage hosted compute networking resources. servers: - url: https://api.github.com externalDocs: @@ -2129,6 +2131,7 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" @@ -4763,6 +4766,457 @@ paths: enabledForGitHubApps: true category: actions subcategory: cache + "/orgs/{org}/actions/hosted-runners": + get: + summary: List GitHub-hosted runners for an organization + description: |- + Lists all GitHub-hosted runners configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-hosted-runners-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: integer + runners: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + post: + summary: Create a GitHub-hosted runner for an organization + description: |- + Creates a GitHub-hosted runner for an organization. + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + operationId: actions/create-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner. Must be between 1 and 64 characters + and may only contain upper and lowercase letters a-z, numbers + 0-9, '.', '-', and '_'. + type: string + image: + description: The image of runner. To list all available images, + use `GET /actions/hosted-runners/images/github-owned` or `GET + /actions/hosted-runners/images/partner`. + type: object + properties: + id: + description: The unique identifier of the runner image. + type: string + source: + description: The source of the runner image. + type: string + enum: + - github + - partner + - custom + version: + description: The version of the runner image to deploy. This + is relevant only for runners using custom images. + type: string + nullable: true + size: + description: The machine size of the runner. To list available sizes, + use `GET actions/hosted-runners/machine-sizes` + type: string + runner_group_id: + description: The existing runner group to add this runner to. + type: integer + maximum_runners: + description: The maximum amount of runners to scale up to. Runners + will not auto-scale above this number. Use this setting to limit + your cost. + type: integer + enable_static_ip: + description: Whether this runner should be created with a static + public IP. Note limit on account. To list limits on account, use + `GET actions/hosted-runners/limits` + type: boolean + required: + - name + - image + - size + - runner_group_id + examples: + default: + value: + name: My Hosted runner + image: + id: ubuntu-latest + source: github + version: latest + runner_group_id: 1 + size: 4-core + maximum_runners: 50 + enable_static_ip: false + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/github-owned": + get: + summary: Get GitHub-owned images for GitHub-hosted runners in an organization + description: Get the list of GitHub-owned images available for GitHub-hosted + runners for an organization. + operationId: actions/get-hosted-runners-github-owned-images-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-github-owned-images-for-github-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/partner": + get: + summary: Get partner images for GitHub-hosted runners in an organization + description: Get the list of partner images available for GitHub-hosted runners + for an organization. + operationId: actions/get-hosted-runners-partner-images-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-partner-images-for-github-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/limits": + get: + summary: Get limits on GitHub-hosted runners for an organization + description: Get the GitHub-hosted runners limits for an organization. + operationId: actions/get-hosted-runners-limits-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-limits-on-github-hosted-runners-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-limits" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-limits-default" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/machine-sizes": + get: + summary: Get GitHub-hosted runners machine specs for an organization + description: Get the list of machine specs available for GitHub-hosted runners + for an organization. + operationId: actions/get-hosted-runners-machine-specs-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-github-hosted-runners-machine-specs-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - machine_specs + properties: + total_count: + type: integer + machine_specs: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-machine-spec" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-machine-spec" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/platforms": + get: + summary: Get platforms for GitHub-hosted runners in an organization + description: Get the list of platforms available for GitHub-hosted runners for + an organization. + operationId: actions/get-hosted-runners-platforms-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-platforms-for-github-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - platforms + properties: + total_count: + type: integer + platforms: + type: array + items: + type: string + examples: + default: + value: + total_count: 1 + platforms: + - linux-x64 + - win-x64 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": + get: + summary: Get a GitHub-hosted runner for an organization + description: |- + Gets a GitHub-hosted runner configured in an organization. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-hosted-runner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/hosted-runner-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + patch: + summary: Update a GitHub-hosted runner for an organization + description: |- + Updates a GitHub-hosted runner for an organization. + OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + operationId: actions/update-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/hosted-runner-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the runner. Must be between 1 and 64 characters + and may only contain upper and lowercase letters a-z, numbers + 0-9, '.', '-', and '_'. + type: string + runner_group_id: + description: The existing runner group to add this runner to. + type: integer + maximum_runners: + description: The maximum amount of runners to scale up to. Runners + will not auto-scale above this number. Use this setting to limit + your cost. + type: integer + enable_static_ip: + description: Whether this runner should be updated with a static + public IP. Note limit on account. To list limits on account, use + `GET actions/hosted-runners/limits` + type: boolean + image_version: + description: The version of the runner image to deploy. This is + relevant only for runners using custom images. + type: string + nullable: true + examples: + default: + value: + name: My larger runner + runner_group_id: 1 + maximum_runners: 50 + enable_static_ip: false + image_version: 1.0.0 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: hosted-runners + delete: + summary: Delete a GitHub-hosted runner for an organization + description: Deletes a GitHub-hosted runner for an organization. + operationId: actions/delete-hosted-runner-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/hosted-runner-id" + responses: + '202': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/oidc/customization/sub": get: summary: Get the customization template for an OIDC subject claim for an organization @@ -5270,6 +5724,9 @@ paths: description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string required: - name examples: @@ -5381,6 +5838,10 @@ paths: description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required. example: octo-org/octo-repo/.github/workflows/deploy.yaml@main + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string + nullable: true required: - name examples: @@ -5426,6 +5887,52 @@ paths: githubCloudOnly: false category: actions subcategory: self-hosted-runner-groups + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": + get: + summary: List GitHub-hosted runners in a group for an organization + description: |- + Lists the GitHub-hosted runners in an organization group. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/list-github-hosted-runners-in-group-for-org + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runner-groups#list-github-hosted-runners-in-a-group-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - runners + properties: + total_count: + type: number + runners: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: self-hosted-runner-groups "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": get: summary: List repository access to a self-hosted runner group in an organization @@ -9280,6 +9787,7 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-severities" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" @@ -13426,17 +13934,11 @@ paths: items: type: integer examples: - update-username-and-encrypted-value: + default: value: username: monalisa encrypted_value: c2VjcmV0 key_id: '012345678912345678' - update-with-selected-visibility: - value: - visibility: selected - selected_repository_ids: - - 1296269 - - 1296280 responses: '204': description: Response @@ -15000,108 +15502,372 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing - "/orgs/{org}/team/{team_slug}/copilot/metrics": + "/orgs/{org}/settings/network-configurations": get: - summary: Get Copilot metrics for a team + summary: List hosted compute network configurations for an organization description: |- - Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + Lists all hosted compute network configurations configured in an organization. - > [!NOTE] - > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/list-network-configurations-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - network_configurations + properties: + total_count: + type: integer + network_configurations: + type: array + items: + "$ref": "#/components/schemas/network-configuration" + examples: + default: + "$ref": "#/components/examples/network-configurations-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + post: + summary: Create a hosted compute network configuration for an organization + description: |- + Creates a hosted compute network configuration for an organization. - The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. + OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/create-network-configuration-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#create-a-hosted-compute-network-configuration-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the network configuration. Must be between + 1 and 100 characters and may only contain upper and lowercase + letters a-z, numbers 0-9, '.', '-', and '_'. + type: string + compute_service: + description: The hosted compute service to use for the network configuration. + type: string + enum: + - none + - actions + network_settings_ids: + type: array + minItems: 1 + maxItems: 1 + description: The identifier of the network settings to use for the + network configuration. Exactly one network settings must be specified. + items: + type: string + required: + - name + - network_settings_ids + examples: + default: + value: + name: my-network-configuration + network_settings_ids: + - 23456789ABDCEF1 + compute_service: actions + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/network-configuration" + examples: + default: + "$ref": "#/components/examples/network-configuration" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": + get: + summary: Get a hosted compute network configuration for an organization + description: |- + Gets a hosted compute network configuration configured in an organization. - To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. - Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/get-network-configuration-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-configuration-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/network-configuration-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/network-configuration" + examples: + default: + "$ref": "#/components/examples/network-configuration" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + patch: + summary: Update a hosted compute network configuration for an organization + description: |- + Updates a hosted compute network configuration for an organization. - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. tags: - - copilot - operationId: copilot/copilot-metrics-for-team + - hosted-compute + operationId: hosted-compute/update-network-configuration-for-org externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + url: https://docs.github.com/rest/orgs/network-configurations#update-a-hosted-compute-network-configuration-for-an-organization parameters: - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - "$ref": "#/components/parameters/page" - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 + - "$ref": "#/components/parameters/network-configuration-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + description: Name of the network configuration. Must be between + 1 and 100 characters and may only contain upper and lowercase + letters a-z, numbers 0-9, '.', '-', and '_'. + type: string + compute_service: + description: The hosted compute service to use for the network configuration. + type: string + enum: + - none + - actions + network_settings_ids: + type: array + minItems: 0 + maxItems: 1 + description: The identifier of the network settings to use for the + network configuration. Exactly one network settings must be specified. + items: + type: string + examples: + default: + value: + name: my-network-configuration + network_settings_ids: + - 23456789ABDCEF1 + compute_service: actions responses: '200': description: Response content: application/json: schema: - type: array - items: - "$ref": "#/components/schemas/copilot-usage-metrics-day" + "$ref": "#/components/schemas/network-configuration" examples: default: - "$ref": "#/components/examples/copilot-usage-metrics-for-day" - '500': - "$ref": "#/components/responses/internal_error" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/usage_metrics_api_disabled" + "$ref": "#/components/examples/network-configuration" x-github: githubCloudOnly: false enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/orgs/{org}/team/{team_slug}/copilot/usage": + category: orgs + subcategory: network-configurations + delete: + summary: Delete a hosted compute network configuration from an organization + description: |- + Deletes a hosted compute network configuration from an organization. + + OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/delete-network-configuration-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#delete-a-hosted-compute-network-configuration-from-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/network-configuration-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + "/orgs/{org}/settings/network-settings/{network_settings_id}": get: - summary: Get a summary of Copilot usage for a team + summary: Get a hosted compute network settings resource for an organization description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + Gets a hosted compute network settings resource configured for an organization. - You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - See the response schema tab for detailed metrics definitions. + OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. + tags: + - hosted-compute + operationId: hosted-compute/get-network-settings-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/network-configurations#get-a-hosted-compute-network-settings-resource-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/network-settings-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/network-settings" + examples: + default: + "$ref": "#/components/examples/network-settings" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: network-configurations + "/orgs/{org}/team/{team_slug}/copilot/metrics": + get: + summary: Get Copilot metrics for a team + description: |- + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, + > [!NOTE] + > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + + The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. - > [!NOTE] - > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. - - Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. + To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. tags: - copilot - operationId: copilot/usage-metrics-for-team + operationId: copilot/copilot-metrics-for-team externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team + url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - name: since + description: Show usage metrics since this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). + Maximum value is 28 days ago. + in: query + required: false + schema: + type: string + - name: until + description: Show usage metrics until this date. This is a timestamp in [ISO + 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) + and should not preceed the `since` date if it is passed. + in: query + required: false + schema: + type: string + - "$ref": "#/components/parameters/page" + - name: per_page + description: The number of days of metrics to display per page (max 28). For + more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 28 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/copilot-usage-metrics-day" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-for-day" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/usage_metrics_api_disabled" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-metrics + "/orgs/{org}/team/{team_slug}/copilot/usage": + get: + summary: Get a summary of Copilot usage for a team + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE + for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. + See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, + and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + they must have telemetry enabled in their IDE. + + > [!NOTE] + > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. + + Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. + + OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/usage-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/team-slug" @@ -21627,17 +22393,17 @@ paths: subcategory: autolinks "/repos/{owner}/{repo}/automated-security-fixes": get: - summary: Check if automated security fixes are enabled for a repository - description: Shows whether automated security fixes are enabled, disabled or - paused for a repository. The authenticated user must have admin read access - to the repository. For more information, see "[Configuring automated security - fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + summary: Check if Dependabot security updates are enabled for a repository + description: Shows whether Dependabot security updates are enabled, disabled + or paused for a repository. The authenticated user must have admin read access + to the repository. For more information, see "[Configuring Dependabot security + updates](https://docs.github.com/articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/check-automated-security-fixes externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/repos#check-if-automated-security-fixes-are-enabled-for-a-repository + url: https://docs.github.com/rest/repos/repos#check-if-dependabot-security-updates-are-enabled-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -21661,16 +22427,16 @@ paths: category: repos subcategory: repos put: - summary: Enable automated security fixes - description: Enables automated security fixes for a repository. The authenticated + summary: Enable Dependabot security updates + description: Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring - automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/enable-automated-security-fixes externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/repos#enable-automated-security-fixes + url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -21683,16 +22449,16 @@ paths: category: repos subcategory: repos delete: - summary: Disable automated security fixes - description: Disables automated security fixes for a repository. The authenticated + summary: Disable Dependabot security updates + description: Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring - automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". + Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". tags: - repos operationId: repos/disable-automated-security-fixes externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/repos#disable-automated-security-fixes + url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -28305,6 +29071,7 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-manifests" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" @@ -34416,7 +35183,7 @@ paths: properties: sub_issue_id: type: integer - description: The sub-issue to remove + description: The id of the sub-issue to remove required: - sub_issue_id examples: @@ -34530,7 +35297,8 @@ paths: properties: sub_issue_id: type: integer - description: The sub-issue to add + description: The id of the sub-issue to add. The sub-issue must + belong to the same repository as the parent issue replace_parent: type: boolean description: Option that, when true, instructs the operation to @@ -40082,7 +40850,7 @@ paths: get: summary: Get secret scanning scan history for a repository description: |- - Lists the latest incremental and backfill scans by type for a repository. + Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: @@ -41333,7 +42101,7 @@ paths: description: An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** - Topic `names` cannot contain uppercase letters. + Topic `names` will be saved as lowercase. items: type: string required: @@ -48392,9 +49160,11 @@ paths: description: |- Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. - The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. + + The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). - The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). tags: - users operationId: users/get-by-id @@ -48475,9 +49245,11 @@ paths: description: |- Provides publicly available information about someone with a GitHub account. - The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + If you are requesting information about an [Enterprise Managed User](https://docs.github.com/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/about-enterprise-managed-users), or a GitHub App bot that is installed in an organization that uses Enterprise Managed Users, your requests must be authenticated as a user or GitHub App that has access to the organization to view that account's information. If you are not authorized, the request will return a `404 Not Found` status. - The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be public which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + + The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). tags: - users operationId: users/get-by-username @@ -66843,6 +67615,21 @@ components: required: - vector_string - score + security-advisory-epss: + type: object + nullable: true + readOnly: true + description: The EPSS scores as calculated by the [Exploit Prediction Scoring + System](https://www.first.org/epss). + properties: + percentage: + type: number + minimum: 0 + maximum: 100 + percentile: + type: number + minimum: 0 + maximum: 100 simple-user: title: Simple User description: A GitHub user. @@ -67101,6 +67888,8 @@ components: - score cvss_severities: "$ref": "#/components/schemas/cvss-severities" + epss: + "$ref": "#/components/schemas/security-advisory-epss" cwes: type: array nullable: true @@ -67117,14 +67906,6 @@ components: required: - cwe_id - name - epss: - type: object - nullable: true - properties: - percentage: - type: number - percentile: - type: number credits: type: array description: The users who contributed to the advisory. @@ -67192,106 +67973,61 @@ components: type: array items: type: string - nullable-simple-user: - title: Simple User - description: A GitHub user. + enterprise: + title: Enterprise + description: An enterprise on GitHub. type: object properties: - name: - nullable: true - type: string - email: - nullable: true - type: string - login: - type: string - example: octocat - id: - type: integer - format: int64 - example: 1 - node_id: - type: string - example: MDQ6VXNlcjE= - avatar_url: - type: string - format: uri - example: https://github.com/images/error/octocat_happy.gif - gravatar_id: + description: + description: A short description of the enterprise. type: string - example: 41d064eb2195891e12d0413f63227ea7 nullable: true - url: - type: string - format: uri - example: https://api.github.com/users/octocat html_url: type: string format: uri - example: https://github.com/octocat - followers_url: + example: https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. type: string + nullable: true format: uri - example: https://api.github.com/users/octocat/followers - following_url: - type: string - example: https://api.github.com/users/octocat/following{/other_user} - gists_url: - type: string - example: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: + id: + description: Unique identifier of the enterprise + example: 42 + type: integer + node_id: type: string - example: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. type: string - format: uri - example: https://api.github.com/users/octocat/subscriptions - organizations_url: + example: Octo Business + slug: + description: The slug url identifier for the enterprise. type: string - format: uri - example: https://api.github.com/users/octocat/orgs - repos_url: + example: octo-business + created_at: type: string - format: uri - example: https://api.github.com/users/octocat/repos - events_url: + nullable: true + format: date-time + example: '2019-01-26T19:01:12Z' + updated_at: type: string - example: https://api.github.com/users/octocat/events{/privacy} - received_events_url: + nullable: true + format: date-time + example: '2019-01-26T19:14:43Z' + avatar_url: type: string format: uri - example: https://api.github.com/users/octocat/received_events - type: - type: string - example: User - site_admin: - type: boolean - starred_at: - type: string - example: '"2020-07-09T00:17:55Z"' - user_view_type: - type: string - example: public required: - - avatar_url - - events_url - - followers_url - - following_url - - gists_url - - gravatar_id - - html_url - id - node_id - - login - - organizations_url - - received_events_url - - repos_url - - site_admin - - starred_url - - subscriptions_url - - type - - url - nullable: true + - name + - slug + - html_url + - created_at + - updated_at + - avatar_url integration: title: GitHub app description: GitHub apps are a new way to extend GitHub. They can be installed @@ -67316,7 +68052,9 @@ components: type: string example: '"Iv1.25b5d1e65ffc4022"' owner: - "$ref": "#/components/schemas/nullable-simple-user" + oneOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/enterprise" name: description: The name of the GitHub app example: Probot Owners @@ -67679,61 +68417,6 @@ components: - repository_id - request - response - enterprise: - title: Enterprise - description: An enterprise on GitHub. - type: object - properties: - description: - description: A short description of the enterprise. - type: string - nullable: true - html_url: - type: string - format: uri - example: https://github.com/enterprises/octo-business - website_url: - description: The enterprise's website URL. - type: string - nullable: true - format: uri - id: - description: Unique identifier of the enterprise - example: 42 - type: integer - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - description: The name of the enterprise. - type: string - example: Octo Business - slug: - description: The slug url identifier for the enterprise. - type: string - example: octo-business - created_at: - type: string - nullable: true - format: date-time - example: '2019-01-26T19:01:12Z' - updated_at: - type: string - nullable: true - format: date-time - example: '2019-01-26T19:14:43Z' - avatar_url: - type: string - format: uri - required: - - id - - node_id - - name - - slug - - html_url - - created_at - - updated_at - - avatar_url integration-installation-request: title: Integration Installation Request description: Request to install an integration on a target @@ -68108,6 +68791,106 @@ components: issues: read deployments: write single_file: read + nullable-simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + nullable: true + type: string + email: + nullable: true + type: string + login: + type: string + example: octocat + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + example: https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: string + example: 41d064eb2195891e12d0413f63227ea7 + nullable: true + url: + type: string + format: uri + example: https://api.github.com/users/octocat + html_url: + type: string + format: uri + example: https://github.com/octocat + followers_url: + type: string + format: uri + example: https://api.github.com/users/octocat/followers + following_url: + type: string + example: https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + example: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + example: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + example: https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + example: https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + example: https://api.github.com/users/octocat/repos + events_url: + type: string + example: https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + example: https://api.github.com/users/octocat/received_events + type: + type: string + example: User + site_admin: + type: boolean + starred_at: + type: string + example: '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + example: public + required: + - avatar_url + - events_url + - followers_url + - following_url + - gists_url + - gravatar_id + - html_url + - id + - node_id + - login + - organizations_url + - received_events_url + - repos_url + - site_admin + - starred_url + - subscriptions_url + - type + - url + nullable: true installation: title: Installation description: Installation @@ -70004,6 +70787,8 @@ components: additionalProperties: false cvss_severities: "$ref": "#/components/schemas/cvss-severities" + epss: + "$ref": "#/components/schemas/security-advisory-epss" cwes: type: array description: Details for the advisory pertaining to Common Weakness Enumeration. @@ -70478,7 +71263,9 @@ components: type: string example: '"Iv1.25b5d1e65ffc4022"' owner: - "$ref": "#/components/schemas/nullable-simple-user" + oneOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/enterprise" name: description: The name of the GitHub app example: Probot Owners @@ -71081,6 +71868,8 @@ components: nullable: true comments: type: integer + comments_enabled: + type: boolean user: "$ref": "#/components/schemas/nullable-simple-user" comments_url: @@ -71384,6 +72173,8 @@ components: nullable: true comments: type: integer + comments_enabled: + type: boolean user: "$ref": "#/components/schemas/nullable-simple-user" comments_url: @@ -71468,6 +72259,8 @@ components: nullable: true comments: type: integer + comments_enabled: + type: boolean user: type: string nullable: true @@ -72915,6 +73708,210 @@ components: - full_name - active_caches_size_in_bytes - active_caches_count + nullable-actions-hosted-runner-pool-image: + title: GitHub-hosted runner image details. + description: Provides details of a hosted runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter + when creating a new larger runner. + type: string + example: ubuntu-20.04 + size_gb: + description: Image size in GB. + type: integer + example: 86 + display_name: + description: Display name for this image. + type: string + example: 20.04 + source: + description: The image provider. + type: string + enum: + - github + - partner + - custom + version: + description: The image version of the hosted runner pool. + type: string + example: latest + required: + - id + - size_gb + - display_name + - source + - version + nullable: true + actions-hosted-runner-machine-spec: + title: Github-owned VM details. + description: Provides details of a particular machine spec. + type: object + properties: + id: + description: The ID used for the `size` parameter when creating a new runner. + type: string + example: 8-core + cpu_cores: + description: The number of cores. + type: integer + example: 8 + memory_gb: + description: The available RAM for the machine spec. + type: integer + example: 32 + storage_gb: + description: The available SSD storage for the machine spec. + type: integer + example: 300 + required: + - id + - cpu_cores + - memory_gb + - storage_gb + public-ip: + title: Public IP for a GitHub-hosted larger runners. + description: Provides details of Public IP for a GitHub-hosted larger runners + type: object + properties: + enabled: + description: Whether public IP is enabled. + type: boolean + example: true + prefix: + description: The prefix for the public IP. + type: string + example: 20.80.208.150 + length: + description: The length of the IP prefix. + type: integer + example: 28 + actions-hosted-runner: + title: GitHub-hosted hosted runner + description: A Github-hosted hosted runner. + type: object + properties: + id: + description: The unique identifier of the hosted runner. + type: integer + example: 5 + name: + description: The name of the hosted runner. + type: string + example: my-github-hosted-runner + runner_group_id: + description: The unique identifier of the group that the hosted runner belongs + to. + type: integer + example: 2 + image_details: + "$ref": "#/components/schemas/nullable-actions-hosted-runner-pool-image" + machine_size_details: + "$ref": "#/components/schemas/actions-hosted-runner-machine-spec" + status: + description: The status of the runner. + type: string + example: Ready + enum: + - Ready + - Provisioning + - Shutdown + - Deleting + - Stuck + platform: + description: The operating system of the image. + type: string + example: linux-x64 + maximum_runners: + description: The maximum amount of hosted runners. Runners will not scale + automatically above this number. Use this setting to limit your cost. + type: integer + default: 10 + example: 5 + public_ip_enabled: + description: Whether public IP is enabled for the hosted runners. + type: boolean + example: true + public_ips: + description: The public IP ranges when public IP is enabled for the hosted + runners. + type: array + items: + "$ref": "#/components/schemas/public-ip" + last_active_on: + description: The time at which the runner was last used, in ISO 8601 format. + type: string + format: date-time + example: '2022-10-09T23:39:01Z' + nullable: true + required: + - id + - name + - image_details + - machine_size_details + - status + - public_ip_enabled + - platform + actions-hosted-runner-image: + title: GitHub-hosted runner image details. + description: Provides details of a hosted runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter + when creating a new larger runner. + type: string + example: ubuntu-20.04 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + size_gb: + description: Image size in GB. + type: integer + example: 86 + display_name: + description: Display name for this image. + type: string + example: 20.04 + source: + description: The image provider. + type: string + enum: + - github + - partner + - custom + required: + - id + - platform + - size_gb + - display_name + - source + actions-hosted-runner-limits: + type: object + properties: + public_ips: + title: Static public IP Limits for GitHub-hosted Hosted Runners. + description: Provides details of static public IP limits for GitHub-hosted + Hosted Runners + type: object + properties: + maximum: + type: integer + description: The maximum number of static public IP addresses that can + be used for Hosted Runners. + example: 50 + current_usage: + type: integer + description: The current number of static public IP addresses in use + by Hosted Runners. + example: 17 + required: + - maximum + - current_usage + required: + - public_ips oidc-custom-sub: title: Actions OIDC Subject customization description: Actions OIDC Subject customization @@ -73038,6 +74035,9 @@ components: type: string hosted_runners_url: type: string + network_configuration_id: + description: The identifier of a hosted compute network configuration. + type: string inherited: type: boolean inherited_allows_public_repositories: @@ -74178,6 +75178,10 @@ components: nullable: true type: string example: 62ab9291-fae2-468e-974b-7e45096d5021 + group_name: + nullable: true + type: string + example: Justice League html_url: type: string format: uri @@ -78782,6 +79786,75 @@ components: - days_left_in_billing_cycle - estimated_paid_storage_for_month - estimated_storage_for_month + network-configuration: + title: Hosted compute network configuration + description: A hosted compute network configuration. + type: object + properties: + id: + description: The unique identifier of the network configuration. + type: string + example: 123ABC456DEF789 + name: + description: The name of the network configuration. + type: string + example: my-network-configuration + compute_service: + description: The hosted compute service the network configuration supports. + type: string + enum: + - none + - actions + - codespaces + network_settings_ids: + description: The unique identifier of each network settings in the configuration. + type: array + items: + type: string + example: 123ABC456DEF789 + created_on: + description: The time at which the network configuration was created, in + ISO 8601 format. + type: string + format: date-time + example: '2024-04-26T11:31:07Z' + nullable: true + required: + - id + - name + - created_on + network-settings: + title: Hosted compute network settings resource + description: A hosted compute network settings resource. + type: object + properties: + id: + description: The unique identifier of the network settings resource. + type: string + example: 220F78DACB92BBFBC5E6F22DE1CCF52309D + network_configuration_id: + description: The identifier of the network configuration that is using this + settings resource. + type: string + example: 934E208B3EE0BD60CF5F752C426BFB53562 + name: + description: The name of the network settings resource. + type: string + example: my-network-settings + subnet_id: + description: The subnet this network settings resource is configured for. + type: string + example: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" + region: + description: The location of the subnet this network settings resource is + configured for. + type: string + example: eastus + required: + - id + - name + - subnet_id + - region team-organization: title: Team Organization description: Team Organization @@ -81157,18 +82230,18 @@ components: - url_template - is_alphanumeric check-automated-security-fixes: - title: Check Automated Security Fixes - description: Check Automated Security Fixes + title: Check Dependabot security updates + description: Check Dependabot security updates type: object properties: enabled: type: boolean example: true - description: Whether automated security fixes are enabled for the repository. + description: Whether Dependabot security updates are enabled for the repository. paused: type: boolean example: false - description: Whether automated security fixes are paused for the repository. + description: Whether Dependabot security updates are paused for the repository. required: - enabled - paused @@ -83116,6 +84189,18 @@ components: - ruby - typescript - swift + runner_type: + description: Runner type to be used. + nullable: true + type: string + enum: + - standard + - labeled + runner_label: + description: Runner label to be used if the runner type is labeled. + nullable: true + type: string + example: code-scanning query_suite: description: CodeQL query suite to be used. type: string @@ -104995,6 +106080,8 @@ components: required: - login - id + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -105004,6 +106091,10 @@ components: - won't fix - used in tests - null + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true html_url: description: The GitHub URL of the alert resource. type: string @@ -105096,7 +106187,10 @@ components: - severity - description state: - description: State of a code scanning alert. + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + nullable: true type: string enum: - open @@ -105242,6 +106336,8 @@ components: required: - login - id + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -105251,6 +106347,10 @@ components: - won't fix - used in tests - null + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true html_url: description: The GitHub URL of the alert resource. type: string @@ -105448,6 +106548,8 @@ components: one of: `false positive`, `won''t fix`, and `used in tests`.' nullable: true fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' nullable: true html_url: description: The GitHub URL of the alert resource. @@ -105560,7 +106662,9 @@ components: - severity - description state: - description: State of a code scanning alert. + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. type: string nullable: true enum: @@ -105714,6 +106818,8 @@ components: required: - login - id + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: The reason for dismissing or closing the alert. type: string @@ -105723,6 +106829,10 @@ components: - won't fix - used in tests - null + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true html_url: description: The GitHub URL of the alert resource. type: string @@ -105835,7 +106945,10 @@ components: - severity - description state: - description: State of a code scanning alert. + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + nullable: true type: string enum: - fixed @@ -105917,11 +107030,17 @@ components: dismissed_by: type: object nullable: true + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in tests`.' type: string nullable: true + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true html_url: description: The GitHub URL of the alert resource. type: string @@ -106031,7 +107150,10 @@ components: - severity - description state: - description: State of a code scanning alert. + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + nullable: true type: string enum: - open @@ -106120,10 +107242,16 @@ components: nullable: true dismissed_by: nullable: true + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in tests`.' nullable: true + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true html_url: description: The GitHub URL of the alert resource. type: string @@ -106216,7 +107344,10 @@ components: - severity - description state: - description: State of a code scanning alert. + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + nullable: true type: string enum: - open @@ -200258,6 +201389,9 @@ components: cvss_v4: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 + epss: + - percentage: 0.00045 + percentile: 0.16001e0 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor @@ -200908,6 +202042,7 @@ components: updated_at: '2022-09-21T10:28:06Z' description: An updated gist description. comments: 0 + comments_enabled: true user: comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments owner: @@ -202252,6 +203387,87 @@ components: - full_name: octo-org/server active_caches_size_in_bytes: 1022142 active_caches_count: 2 + actions-hosted-runner-paginated: + value: + total_count: 2 + runners: + - id: 5 + name: My hosted ubuntu runner + runner_group_id: 2 + platform: linux-x64 + image: + id: ubuntu-20.04 + size: 86 + machine_size_details: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 + status: Ready + maximum_runners: 10 + public_ip_enabled: true + public_ips: + - enabled: true + prefix: 20.80.208.150 + length: 31 + last_active_on: '2022-10-09T23:39:01Z' + - id: 7 + name: My hosted Windows runner + runner_group_id: 2 + platform: win-x64 + image: + id: windows-latest + size: 256 + machine_size_details: + id: 8-core + cpu_cores: 8 + memory_gb: 32 + storage_gb: 300 + status: Ready + maximum_runners: 20 + public_ip_enabled: false + public_ips: [] + last_active_on: '2023-04-26T15:23:37Z' + actions-hosted-runner: + value: + id: 5 + name: My hosted ubuntu runner + runner_group_id: 2 + platform: linux-x64 + image: + id: ubuntu-20.04 + size: 86 + machine_size_details: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 + status: Ready + maximum_runners: 10 + public_ip_enabled: true + public_ips: + - enabled: true + prefix: 20.80.208.150 + length: 31 + last_active_on: '2022-10-09T23:39:01Z' + actions-hosted-runner-image: + value: + id: ubuntu-20.04 + platform: linux-x64 + size_gb: 86 + display_name: '20.04' + source: github + actions-hosted-runner-limits-default: + value: + public_ips: + current_usage: 17 + maximum: 50 + actions-hosted-runner-machine-spec: + value: + id: 4-core + cpu_cores: 4 + memory_gb: 16 + storage_gb: 150 oidc-custom-sub: value: include_claim_keys: @@ -206626,6 +207842,40 @@ components: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 estimated_storage_for_month: 40 + network-configurations-paginated: + value: + total_count: 2 + network_configurations: + - id: 123456789ABCDEF + name: My network configuration + compute_service: actions + network_settings_ids: + - 23456789ABDCEF1 + - 3456789ABDCEF12 + created_on: '2022-10-09T23:39:01Z' + - id: 456789ABDCEF123 + name: My other configuration + compute_service: none + network_settings_ids: + - 56789ABDCEF1234 + - 6789ABDCEF12345 + created_on: '2023-04-26T15:23:37Z' + network-configuration: + value: + id: 123456789ABCDEF + name: My network configuration + compute_service: actions + network_settings_ids: + - 23456789ABDCEF1 + - 3456789ABDCEF12 + created_on: '2022-10-09T23:39:01Z' + network-settings: + value: + id: 220F78DACB92BBFBC5E6F22DE1CCF52309D + network_configuration_id: 934E208B3EE0BD60CF5F752C426BFB53562 + name: my_network_settings + subnet_id: "/subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet" + region: eastus team-full: value: id: 1 @@ -213259,6 +214509,9 @@ components: cvss_v4: vector_string: CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:N/VA:N/SC:N/SI:N/SA:N score: 8.7 + epss: + - percentage: 0.00045 + percentile: 0.16001e0 cwes: - cwe_id: CWE-200 name: Exposure of Sensitive Information to an Unauthorized Actor @@ -213445,6 +214698,9 @@ components: cvss_v4: vector_string: CVSS:4.0/AV:L/AC:L/AT:N/PR:N/UI:P/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N score: 8.5 + epss: + - percentage: 0.00045 + percentile: 0.16001e0 cwes: - cwe_id: CWE-532 name: Insertion of Sensitive Information into Log File @@ -224446,6 +225702,18 @@ components: for these packages will be returned. schema: type: string + dependabot-alert-comma-separated-epss: + name: epss_percentage + in: query + description: |- + CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + - An exact number (`n`) + - Comparators such as `>n`, `=n`, `<=n` + - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + + Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. + schema: + type: string dependabot-alert-scope: name: scope in: query @@ -224463,11 +225731,13 @@ components: The property by which to sort the results. `created` means when the alert was created. `updated` means when the alert's state last changed. + `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. schema: type: string enum: - created - updated + - epss_percentage default: created pagination-first: name: first @@ -224709,6 +225979,13 @@ components: required: false schema: type: integer + hosted-runner-id: + name: hosted_runner_id + description: Unique identifier of the GitHub-hosted runner. + in: path + required: true + schema: + type: integer repository-id: name: repository_id description: The unique identifier of the repository. @@ -225161,6 +226438,20 @@ components: required: false schema: type: string + network-configuration-id: + name: network_configuration_id + description: Unique identifier of the hosted compute network configuration. + in: path + required: true + schema: + type: string + network-settings-id: + name: network_settings_id + description: Unique identifier of the hosted compute network settings. + in: path + required: true + schema: + type: string discussion-number: name: discussion_number description: The number that identifies the discussion. diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts index a1d3a6337..8ec3e1954 100644 --- a/packages/openapi-typescript/examples/stripe-api.ts +++ b/packages/openapi-typescript/examples/stripe-api.ts @@ -8380,6 +8380,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/treasury/financial_accounts/{financial_account}/close": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Close a FinancialAccount + * @description

Closes a FinancialAccount. A FinancialAccount can only be closed if it has a zero balance, has no pending InboundTransfers, and has canceled all attached Issuing cards.

+ */ + post: operations["PostTreasuryFinancialAccountsFinancialAccountClose"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/treasury/financial_accounts/{financial_account}/features": { parameters: { query?: never; @@ -9133,6 +9153,11 @@ export interface components { * @enum {string} */ p24_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges. + * @enum {string} + */ + pay_by_bank_payments?: "active" | "inactive" | "pending"; /** * @description The status of the Payco capability of the account, or whether the account can directly process Payco payments. * @enum {string} @@ -9579,6 +9604,8 @@ export interface components { }; /** APIErrors */ api_errors: { + /** @description For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one. */ + advice_code?: string; /** @description For card errors, the ID of the failed charge. */ charge?: string; /** @description For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. */ @@ -10878,6 +10905,11 @@ export interface components { }; /** ChargeOutcome */ charge_outcome: { + /** + * @description An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines). + * @enum {string|null} + */ + advice_code?: "confirm_card_data" | "do_not_try_again" | "try_again_later" | null; /** @description For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error. */ network_advice_code?: string | null; /** @description For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. */ @@ -10984,6 +11016,8 @@ export interface components { * on file. To access information about the customer once the payment flow is * complete, use the `customer` attribute. */ customer_email?: string | null; + /** @description List of coupons and promotion codes attached to the Checkout Session. */ + discounts?: components["schemas"]["payment_pages_checkout_session_discount"][] | null; /** * Format: unix-time * @description The timestamp at which the Checkout Session will expire. @@ -12087,6 +12121,7 @@ export interface components { naver_pay?: components["schemas"]["payment_method_naver_pay"]; oxxo?: components["schemas"]["payment_method_oxxo"]; p24?: components["schemas"]["payment_method_p24"]; + pay_by_bank?: components["schemas"]["payment_method_pay_by_bank"]; payco?: components["schemas"]["payment_method_payco"]; paynow?: components["schemas"]["payment_method_paynow"]; paypal?: components["schemas"]["payment_method_paypal"]; @@ -12102,7 +12137,7 @@ export interface components { * @description The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. * @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; us_bank_account?: components["schemas"]["payment_method_us_bank_account"]; wechat_pay?: components["schemas"]["payment_method_wechat_pay"]; zip?: components["schemas"]["payment_method_zip"]; @@ -12165,6 +12200,10 @@ export interface components { account_onboarding: components["schemas"]["connect_embedded_account_config_claim"]; balances: components["schemas"]["connect_embedded_payouts_config_claim"]; documents: components["schemas"]["connect_embedded_base_config_claim"]; + financial_account: components["schemas"]["connect_embedded_financial_account_config_claim"]; + financial_account_transactions: components["schemas"]["connect_embedded_financial_account_transactions_config_claim"]; + issuing_card: components["schemas"]["connect_embedded_issuing_card_config_claim"]; + issuing_cards_list: components["schemas"]["connect_embedded_issuing_cards_list_config_claim"]; notification_banner: components["schemas"]["connect_embedded_account_config_claim"]; payment_details: components["schemas"]["connect_embedded_payments_config_claim"]; payments: components["schemas"]["connect_embedded_payments_config_claim"]; @@ -12181,6 +12220,70 @@ export interface components { }; /** ConnectEmbeddedBaseFeatures */ connect_embedded_base_features: Record; + /** ConnectEmbeddedFinancialAccountConfigClaim */ + connect_embedded_financial_account_config_claim: { + /** @description Whether the embedded component is enabled. */ + enabled: boolean; + features: components["schemas"]["connect_embedded_financial_account_features"]; + }; + /** ConnectEmbeddedFinancialAccountFeatures */ + connect_embedded_financial_account_features: { + /** @description Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. */ + disable_stripe_user_authentication: boolean; + /** @description Whether to allow external accounts to be linked for money transfer. */ + external_account_collection: boolean; + /** @description Whether to allow sending money. */ + send_money: boolean; + /** @description Whether to allow transferring balance. */ + transfer_balance: boolean; + }; + /** ConnectEmbeddedFinancialAccountTransactionsConfigClaim */ + connect_embedded_financial_account_transactions_config_claim: { + /** @description Whether the embedded component is enabled. */ + enabled: boolean; + features: components["schemas"]["connect_embedded_financial_account_transactions_features"]; + }; + /** ConnectEmbeddedFinancialAccountTransactionsFeatures */ + connect_embedded_financial_account_transactions_features: { + /** @description Whether to allow card spend dispute management features. */ + card_spend_dispute_management: boolean; + }; + /** ConnectEmbeddedIssuingCardConfigClaim */ + connect_embedded_issuing_card_config_claim: { + /** @description Whether the embedded component is enabled. */ + enabled: boolean; + features: components["schemas"]["connect_embedded_issuing_card_features"]; + }; + /** ConnectEmbeddedIssuingCardFeatures */ + connect_embedded_issuing_card_features: { + /** @description Whether to allow card management features. */ + card_management: boolean; + /** @description Whether to allow card spend dispute management features. */ + card_spend_dispute_management: boolean; + /** @description Whether to allow cardholder management features. */ + cardholder_management: boolean; + /** @description Whether to allow spend control management features. */ + spend_control_management: boolean; + }; + /** ConnectEmbeddedIssuingCardsListConfigClaim */ + connect_embedded_issuing_cards_list_config_claim: { + /** @description Whether the embedded component is enabled. */ + enabled: boolean; + features: components["schemas"]["connect_embedded_issuing_cards_list_features"]; + }; + /** ConnectEmbeddedIssuingCardsListFeatures */ + connect_embedded_issuing_cards_list_features: { + /** @description Whether to allow card management features. */ + card_management: boolean; + /** @description Whether to allow card spend dispute management features. */ + card_spend_dispute_management: boolean; + /** @description Whether to allow cardholder management features. */ + cardholder_management: boolean; + /** @description Disables Stripe user authentication for this embedded component. This feature can only be false for accounts where you’re responsible for collecting updated information when requirements are due or change, like custom accounts. */ + disable_stripe_user_authentication: boolean; + /** @description Whether to allow spend control management features. */ + spend_control_management: boolean; + }; /** ConnectEmbeddedPaymentsConfigClaim */ connect_embedded_payments_config_claim: { /** @description Whether the embedded component is enabled. */ @@ -12410,7 +12513,7 @@ export interface components { /** @description The link to download the PDF of the credit note. */ pdf: string; /** @description The pretax credit amounts (ex: discount, credit grants, etc) for all line items. */ - pretax_credit_amounts?: components["schemas"]["credit_notes_pretax_credit_amount"][]; + pretax_credit_amounts: components["schemas"]["credit_notes_pretax_credit_amount"][]; /** * @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` * @enum {string|null} @@ -12473,7 +12576,7 @@ export interface components { */ object: "credit_note_line_item"; /** @description The pretax credit amounts (ex: discount, credit grants, etc) for this line item. */ - pretax_credit_amounts?: components["schemas"]["credit_notes_pretax_credit_amount"][]; + pretax_credit_amounts: components["schemas"]["credit_notes_pretax_credit_amount"][]; /** @description The number of units of product being credited. */ quantity?: number | null; /** @description The amount of tax calculated per tax rate for this line item */ @@ -17278,6 +17381,8 @@ export interface components { address_kanji?: components["schemas"]["legal_entity_japan_address"] | null; /** @description Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided). */ directors_provided?: boolean; + /** @description This hash is used to attest that the director information provided to Stripe is both current and correct. */ + directorship_declaration?: components["schemas"]["legal_entity_directorship_declaration"] | null; /** @description Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. */ executives_provided?: boolean; /** @description The export license ID number of the company, also referred as Import Export Code (India only). */ @@ -17294,6 +17399,8 @@ export interface components { owners_provided?: boolean; /** @description This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. */ ownership_declaration?: components["schemas"]["legal_entity_ubo_declaration"] | null; + /** @enum {string} */ + ownership_exemption_reason?: "qualified_entity_exceeds_ownership_threshold" | "qualifies_as_financial_institution"; /** @description The company's phone number (used for verification). */ phone?: string | null; /** @@ -17325,6 +17432,18 @@ export interface components { /** @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ front?: (string | components["schemas"]["file"]) | null; }; + /** LegalEntityDirectorshipDeclaration */ + legal_entity_directorship_declaration: { + /** + * Format: unix-time + * @description The Unix timestamp marking when the directorship declaration attestation was made. + */ + date?: number | null; + /** @description The IP address from which the directorship declaration attestation was made. */ + ip?: string | null; + /** @description The user-agent string from the browser where the directorship declaration attestation was made. */ + user_agent?: string | null; + }; /** LegalEntityDOB */ legal_entity_dob: { /** @description The day of birth, between 1 and 31. */ @@ -17722,13 +17841,24 @@ export interface components { /** OutboundTransfersPaymentMethodDetails */ outbound_transfers_payment_method_details: { billing_details: components["schemas"]["treasury_shared_resource_billing_details"]; + financial_account?: components["schemas"]["outbound_transfers_payment_method_details_financial_account"]; /** * @description The type of the payment method used in the OutboundTransfer. * @enum {string} */ - type: "us_bank_account"; + type: "financial_account" | "us_bank_account"; us_bank_account?: components["schemas"]["outbound_transfers_payment_method_details_us_bank_account"]; }; + /** outbound_transfers_payment_method_details_financial_account */ + outbound_transfers_payment_method_details_financial_account: { + /** @description Token of the FinancialAccount. */ + id: string; + /** + * @description The rails used to send funds. + * @enum {string} + */ + network: "stripe"; + }; /** outbound_transfers_payment_method_details_us_bank_account */ outbound_transfers_payment_method_details_us_bank_account: { /** @@ -18378,6 +18508,7 @@ export interface components { naver_pay?: components["schemas"]["payment_flows_private_payment_methods_naver_pay_payment_method_options"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; oxxo?: components["schemas"]["payment_method_options_oxxo"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; p24?: components["schemas"]["payment_method_options_p24"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + pay_by_bank?: components["schemas"]["payment_method_options_pay_by_bank"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; payco?: components["schemas"]["payment_flows_private_payment_methods_payco_payment_method_options"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; paynow?: components["schemas"]["payment_method_options_paynow"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; paypal?: components["schemas"]["payment_method_options_paypal"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; @@ -18787,7 +18918,7 @@ export interface components { */ payment_method_collection: "always" | "if_required"; /** @description The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | null; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "pay_by_bank" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | null; phone_number_collection: components["schemas"]["payment_links_resource_phone_number_collection"]; /** @description Settings that restrict the usage of a payment link. */ restrictions?: components["schemas"]["payment_links_resource_restrictions"] | null; @@ -18998,7 +19129,7 @@ export interface components { /** PaymentLinksResourceShippingAddressCollection */ payment_links_resource_shipping_address_collection: { /** @description An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. */ - allowed_countries: ("AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CV" | "CW" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; + allowed_countries: ("AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CV" | "CW" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; }; /** PaymentLinksResourceShippingOption */ payment_links_resource_shipping_option: { @@ -19105,6 +19236,7 @@ export interface components { object: "payment_method"; oxxo?: components["schemas"]["payment_method_oxxo"]; p24?: components["schemas"]["payment_method_p24"]; + pay_by_bank?: components["schemas"]["payment_method_pay_by_bank"]; payco?: components["schemas"]["payment_method_payco"]; paynow?: components["schemas"]["payment_method_paynow"]; paypal?: components["schemas"]["payment_method_paypal"]; @@ -19121,7 +19253,7 @@ export interface components { * @description The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. * @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; us_bank_account?: components["schemas"]["payment_method_us_bank_account"]; wechat_pay?: components["schemas"]["payment_method_wechat_pay"]; zip?: components["schemas"]["payment_method_zip"]; @@ -19425,6 +19557,7 @@ export interface components { p24?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; /** @description For child configs, the configuration's parent configuration. */ parent?: string | null; + pay_by_bank?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; paynow?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; paypal?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; promptpay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; @@ -19474,6 +19607,7 @@ export interface components { naver_pay?: components["schemas"]["payment_method_details_naver_pay"]; oxxo?: components["schemas"]["payment_method_details_oxxo"]; p24?: components["schemas"]["payment_method_details_p24"]; + pay_by_bank?: components["schemas"]["payment_method_details_pay_by_bank"]; payco?: components["schemas"]["payment_method_details_payco"]; paynow?: components["schemas"]["payment_method_details_paynow"]; paypal?: components["schemas"]["payment_method_details_paypal"]; @@ -20082,6 +20216,8 @@ export interface components { /** @description The last four digits of the card. */ last4?: string | null; }; + /** payment_method_details_pay_by_bank */ + payment_method_details_pay_by_bank: Record; /** payment_method_details_payco */ payment_method_details_payco: { /** @description A unique identifier for the buyer as determined by the local payment processor. */ @@ -20094,6 +20230,8 @@ export interface components { }; /** payment_method_details_paypal */ payment_method_details_paypal: { + /** @description Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + country?: string | null; /** @description Owner's email. Values are provided by PayPal directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ payer_email?: string | null; @@ -20775,6 +20913,8 @@ export interface components { */ setup_future_usage?: "none"; }; + /** payment_method_options_pay_by_bank */ + payment_method_options_pay_by_bank: Record; /** payment_method_options_paynow */ payment_method_options_paynow: { /** @@ -20949,12 +21089,16 @@ export interface components { */ bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank" | null; }; + /** payment_method_pay_by_bank */ + payment_method_pay_by_bank: Record; /** payment_method_payco */ payment_method_payco: Record; /** payment_method_paynow */ payment_method_paynow: Record; /** payment_method_paypal */ payment_method_paypal: { + /** @description Two-letter ISO code representing the buyer's country. Values are provided by PayPal directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + country?: string | null; /** @description Owner's email. Values are provided by PayPal directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ payer_email?: string | null; @@ -21223,6 +21367,13 @@ export interface components { /** @description The customer’s tax IDs after a completed Checkout Session. */ tax_ids?: components["schemas"]["payment_pages_checkout_session_tax_id"][] | null; }; + /** PaymentPagesCheckoutSessionDiscount */ + payment_pages_checkout_session_discount: { + /** @description Coupon attached to the Checkout Session. */ + coupon?: (string | components["schemas"]["coupon"]) | null; + /** @description Promotion code attached to the Checkout Session. */ + promotion_code?: (string | components["schemas"]["promotion_code"]) | null; + }; /** PaymentPagesCheckoutSessionInvoiceCreation */ payment_pages_checkout_session_invoice_creation: { /** @description Indicates whether invoice creation is enabled for the Checkout Session. */ @@ -21281,8 +21432,8 @@ export interface components { /** PaymentPagesCheckoutSessionShippingAddressCollection */ payment_pages_checkout_session_shipping_address_collection: { /** @description An array of two-letter ISO country codes representing which countries Checkout should provide as options for - * shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. */ - allowed_countries: ("AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CV" | "CW" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; + * shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`. */ + allowed_countries: ("AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CV" | "CW" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; }; /** PaymentPagesCheckoutSessionShippingCost */ payment_pages_checkout_session_shipping_cost: { @@ -25677,6 +25828,7 @@ export interface components { eur?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; gbp?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; hkd?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; + jpy?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; myr?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; nok?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; nzd?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; @@ -26371,12 +26523,15 @@ export interface components { financial_addresses: components["schemas"]["treasury_financial_accounts_resource_financial_address"][]; /** @description Unique identifier for the object. */ id: string; + is_default?: boolean; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. */ metadata?: { [key: string]: string; } | null; + /** @description The nickname for the FinancialAccount. */ + nickname?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} @@ -27201,12 +27356,13 @@ export interface components { treasury_received_credits_resource_source_flows_details: { credit_reversal?: components["schemas"]["treasury.credit_reversal"]; outbound_payment?: components["schemas"]["treasury.outbound_payment"]; + outbound_transfer?: components["schemas"]["treasury.outbound_transfer"]; payout?: components["schemas"]["payout"]; /** * @description The type of the source flow that originated the ReceivedCredit. * @enum {string} */ - type: "credit_reversal" | "other" | "outbound_payment" | "payout"; + type: "credit_reversal" | "other" | "outbound_payment" | "outbound_transfer" | "payout"; }; /** TreasuryReceivedCreditsResourceStatusTransitions */ treasury_received_credits_resource_status_transitions: { @@ -27601,6 +27757,48 @@ export interface operations { /** base_features_param */ features?: Record; }; + /** financial_account_config_param */ + financial_account?: { + enabled: boolean; + /** financial_account_features_param */ + features?: { + disable_stripe_user_authentication?: boolean; + external_account_collection?: boolean; + send_money?: boolean; + transfer_balance?: boolean; + }; + }; + /** financial_account_transactions_config_param */ + financial_account_transactions?: { + enabled: boolean; + /** financial_account_transactions_features_param */ + features?: { + card_spend_dispute_management?: boolean; + }; + }; + /** issuing_card_config_param */ + issuing_card?: { + enabled: boolean; + /** issuing_card_features_param */ + features?: { + card_management?: boolean; + card_spend_dispute_management?: boolean; + cardholder_management?: boolean; + spend_control_management?: boolean; + }; + }; + /** issuing_cards_list_config_param */ + issuing_cards_list?: { + enabled: boolean; + /** issuing_cards_list_features_param */ + features?: { + card_management?: boolean; + card_spend_dispute_management?: boolean; + cardholder_management?: boolean; + disable_stripe_user_authentication?: boolean; + spend_control_management?: boolean; + }; + }; /** account_config_param */ notification_banner?: { enabled: boolean; @@ -27981,6 +28179,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + pay_by_bank_payments?: { + requested?: boolean; + }; + /** capability_param */ payco_payments?: { requested?: boolean; }; @@ -28084,6 +28286,13 @@ export interface operations { town?: string; }; directors_provided?: boolean; + /** company_directorship_declaration */ + directorship_declaration?: { + /** Format: unix-time */ + date?: number; + ip?: string; + user_agent?: string; + }; executives_provided?: boolean; export_license_id?: string; export_purpose_code?: string; @@ -28098,6 +28307,8 @@ export interface operations { ip?: string; user_agent?: string; }; + /** @enum {string} */ + ownership_exemption_reason?: "" | "qualified_entity_exceeds_ownership_threshold" | "qualifies_as_financial_institution"; phone?: string; registration_number?: string; /** @enum {string} */ @@ -28177,6 +28388,10 @@ export interface operations { proof_of_registration?: { files?: string[]; }; + /** documents_param */ + proof_of_ultimate_beneficial_ownership?: { + files?: string[]; + }; }; /** @description The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent. */ email?: string; @@ -28642,6 +28857,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + pay_by_bank_payments?: { + requested?: boolean; + }; + /** capability_param */ payco_payments?: { requested?: boolean; }; @@ -28745,6 +28964,13 @@ export interface operations { town?: string; }; directors_provided?: boolean; + /** company_directorship_declaration */ + directorship_declaration?: { + /** Format: unix-time */ + date?: number; + ip?: string; + user_agent?: string; + }; executives_provided?: boolean; export_license_id?: string; export_purpose_code?: string; @@ -28759,6 +28985,8 @@ export interface operations { ip?: string; user_agent?: string; }; + /** @enum {string} */ + ownership_exemption_reason?: "" | "qualified_entity_exceeds_ownership_threshold" | "qualifies_as_financial_institution"; phone?: string; registration_number?: string; /** @enum {string} */ @@ -28813,6 +29041,10 @@ export interface operations { proof_of_registration?: { files?: string[]; }; + /** documents_param */ + proof_of_ultimate_beneficial_ownership?: { + files?: string[]; + }; }; /** @description The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent. */ email?: string; @@ -34835,6 +35067,8 @@ export interface operations { tos_shown_and_accepted?: boolean; }; /** payment_method_options_param */ + pay_by_bank?: Record; + /** payment_method_options_param */ payco?: { /** @enum {string} */ capture_method?: "manual"; @@ -34919,7 +35153,7 @@ export interface operations { * If multiple payment methods are passed, Checkout will dynamically reorder them to * prioritize the most relevant payment methods based on the customer's location and * other characteristics. */ - payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; + payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; /** * phone_number_collection_params * @description Controls phone number collection settings for the session. @@ -34964,7 +35198,7 @@ export interface operations { * @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ shipping_address_collection?: { - allowed_countries: ("AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CV" | "CW" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; + allowed_countries: ("AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CV" | "CW" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; }; /** @description The shipping rate options to apply to this Session. Up to a maximum of 5. */ shipping_options?: { @@ -38316,7 +38550,7 @@ export interface operations { /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ starting_after?: string; /** @description An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. */ - type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; }; header?: never; path: { @@ -41307,7 +41541,7 @@ export interface operations { GetFinancialConnectionsTransactions: { parameters: { query: { - /** @description The ID of the Stripe account whose transactions will be retrieved. */ + /** @description The ID of the Financial Connections Account whose transactions will be retrieved. */ account: string; /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ ending_before?: string; @@ -47654,6 +47888,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + pay_by_bank?: Record; + /** param */ payco?: Record; /** param */ paynow?: Record; @@ -47685,7 +47921,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -47960,6 +48196,7 @@ export interface operations { setup_future_usage?: "none"; tos_shown_and_accepted?: boolean; } | ""; + pay_by_bank?: Record | ""; payco?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -48404,6 +48641,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + pay_by_bank?: Record; + /** param */ payco?: Record; /** param */ paynow?: Record; @@ -48435,7 +48674,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -48710,6 +48949,7 @@ export interface operations { setup_future_usage?: "none"; tos_shown_and_accepted?: boolean; } | ""; + pay_by_bank?: Record | ""; payco?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -49216,6 +49456,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + pay_by_bank?: Record; + /** param */ payco?: Record; /** param */ paynow?: Record; @@ -49247,7 +49489,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -49522,6 +49764,7 @@ export interface operations { setup_future_usage?: "none"; tos_shown_and_accepted?: boolean; } | ""; + pay_by_bank?: Record | ""; payco?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -50051,7 +50294,7 @@ export interface operations { */ payment_method_collection?: "always" | "if_required"; /** @description The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). */ - payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "pay_by_bank" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; /** * phone_number_collection_params * @description Controls phone number collection settings during checkout. @@ -50076,7 +50319,7 @@ export interface operations { * @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: { - allowed_countries: ("AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CV" | "CW" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; + allowed_countries: ("AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CV" | "CW" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; }; /** @description The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ shipping_options?: { @@ -50369,7 +50612,16 @@ export interface operations { */ payment_method_collection?: "always" | "if_required"; /** @description The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | ""; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "pay_by_bank" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | ""; + /** + * phone_number_collection_params + * @description Controls phone number collection settings during checkout. + * + * We recommend that you review your privacy policy and check with your legal contacts. + */ + phone_number_collection?: { + enabled: boolean; + }; /** @description Settings that restrict the usage of a payment link. */ restrictions?: { /** completed_sessions_params */ @@ -50379,7 +50631,7 @@ export interface operations { } | ""; /** @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: { - allowed_countries: ("AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CV" | "CW" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; + allowed_countries: ("AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CV" | "CW" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; } | ""; /** * @description Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button. Changing this value will also affect the hostname in the [url](https://stripe.com/docs/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). @@ -50913,6 +51165,17 @@ export interface operations { }; /** @description Configuration's parent configuration. Specify to create a child configuration. */ parent?: string; + /** + * payment_method_param + * @description Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments. + */ + pay_by_bank?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. @@ -51455,6 +51718,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Pay by bank is a redirect payment method backed by bank transfers. A customer is redirected to their bank to authorize a bank transfer for a given amount. This removes a lot of the error risks inherent in waiting for the customer to initiate a transfer themselves, and is less expensive than card payments. + */ + pay_by_bank?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. @@ -51827,7 +52101,7 @@ export interface operations { /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ starting_after?: string; /** @description An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. */ - type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; }; header?: never; path?: never; @@ -52103,6 +52377,11 @@ export interface operations { /** @enum {string} */ bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; + /** + * param + * @description If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method. + */ + pay_by_bank?: Record; /** * param * @description If this is a `payco` PaymentMethod, this hash contains details about the PAYCO payment method. @@ -52176,7 +52455,7 @@ export interface operations { * @description The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. * @enum {string} */ - type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** * payment_method_param * @description If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. @@ -52328,6 +52607,11 @@ export interface operations { /** @enum {string} */ funding?: "card" | "points"; }; + /** + * param + * @description If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method. + */ + pay_by_bank?: Record; /** * update_param * @description If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. @@ -56384,6 +56668,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + pay_by_bank?: Record; + /** param */ payco?: Record; /** param */ paynow?: Record; @@ -56415,7 +56701,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -56787,6 +57073,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + pay_by_bank?: Record; + /** param */ payco?: Record; /** param */ paynow?: Record; @@ -56818,7 +57106,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -57188,6 +57476,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + pay_by_bank?: Record; + /** param */ payco?: Record; /** param */ paynow?: Record; @@ -57219,7 +57509,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -62192,6 +62482,12 @@ export interface operations { smart_tip_threshold?: number; }; /** currency_specific_config */ + jpy?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; + /** currency_specific_config */ myr?: { fixed_amounts?: number[]; percentages?: number[]; @@ -62387,6 +62683,12 @@ export interface operations { smart_tip_threshold?: number; }; /** currency_specific_config */ + jpy?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; + /** currency_specific_config */ myr?: { fixed_amounts?: number[]; percentages?: number[]; @@ -63387,6 +63689,8 @@ export interface operations { bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ + pay_by_bank?: Record; + /** param */ payco?: Record; /** param */ paynow?: Record; @@ -63418,7 +63722,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -65746,6 +66050,13 @@ export interface operations { town?: string; }; directors_provided?: boolean; + /** company_directorship_declaration */ + directorship_declaration?: { + /** Format: unix-time */ + date?: number; + ip?: string; + user_agent?: string; + }; executives_provided?: boolean; export_license_id?: string; export_purpose_code?: string; @@ -65761,6 +66072,8 @@ export interface operations { user_agent?: string; }; ownership_declaration_shown_and_signed?: boolean; + /** @enum {string} */ + ownership_exemption_reason?: "" | "qualified_entity_exceeds_ownership_threshold" | "qualifies_as_financial_institution"; phone?: string; registration_number?: string; /** @enum {string} */ @@ -67145,6 +67458,8 @@ export interface operations { metadata?: { [key: string]: string; }; + /** @description The nickname for the FinancialAccount. */ + nickname?: string | ""; /** * platform_restrictions * @description The set of functionalities that the platform can restrict on the FinancialAccount. @@ -67287,10 +67602,22 @@ export interface operations { }; }; }; + /** + * forwarding_settings + * @description A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0 + */ + forwarding_settings?: { + financial_account?: string; + payment_method?: string; + /** @enum {string} */ + type: "financial_account" | "payment_method"; + }; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { [key: string]: string; }; + /** @description The nickname for the FinancialAccount. */ + nickname?: string | ""; /** * platform_restrictions * @description The set of functionalities that the platform can restrict on the FinancialAccount. @@ -67325,6 +67652,54 @@ export interface operations { }; }; }; + PostTreasuryFinancialAccountsFinancialAccountClose: { + parameters: { + query?: never; + header?: never; + path: { + financial_account: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * forwarding_settings + * @description A different bank account where funds can be deposited/debited in order to get the closing FA's balance to $0 + */ + forwarding_settings?: { + financial_account?: string; + payment_method?: string; + /** @enum {string} */ + type: "financial_account" | "payment_method"; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["treasury.financial_account"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetTreasuryFinancialAccountsFinancialAccountFeatures: { parameters: { query?: { @@ -67992,6 +68367,15 @@ export interface operations { description?: string; /** @description The PaymentMethod to use as the payment instrument for the OutboundTransfer. */ destination_payment_method?: string; + /** + * payment_method_data + * @description Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with `destination_payment_method`. + */ + destination_payment_method_data?: { + financial_account?: string; + /** @enum {string} */ + type: "financial_account"; + }; /** * payment_method_options * @description Hash describing payment method configuration details. @@ -68126,7 +68510,7 @@ export interface operations { /** @description Only return ReceivedCredits described by the flow. */ linked_flows?: { /** @enum {string} */ - source_flow_type: "credit_reversal" | "other" | "outbound_payment" | "payout"; + source_flow_type: "credit_reversal" | "other" | "outbound_payment" | "outbound_transfer" | "payout"; }; /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */ starting_after?: string; @@ -68601,7 +68985,7 @@ export interface operations { * @description Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version. * @enum {string} */ - api_version?: "2011-01-01" | "2011-06-21" | "2011-06-28" | "2011-08-01" | "2011-09-15" | "2011-11-17" | "2012-02-23" | "2012-03-25" | "2012-06-18" | "2012-06-28" | "2012-07-09" | "2012-09-24" | "2012-10-26" | "2012-11-07" | "2013-02-11" | "2013-02-13" | "2013-07-05" | "2013-08-12" | "2013-08-13" | "2013-10-29" | "2013-12-03" | "2014-01-31" | "2014-03-13" | "2014-03-28" | "2014-05-19" | "2014-06-13" | "2014-06-17" | "2014-07-22" | "2014-07-26" | "2014-08-04" | "2014-08-20" | "2014-09-08" | "2014-10-07" | "2014-11-05" | "2014-11-20" | "2014-12-08" | "2014-12-17" | "2014-12-22" | "2015-01-11" | "2015-01-26" | "2015-02-10" | "2015-02-16" | "2015-02-18" | "2015-03-24" | "2015-04-07" | "2015-06-15" | "2015-07-07" | "2015-07-13" | "2015-07-28" | "2015-08-07" | "2015-08-19" | "2015-09-03" | "2015-09-08" | "2015-09-23" | "2015-10-01" | "2015-10-12" | "2015-10-16" | "2016-02-03" | "2016-02-19" | "2016-02-22" | "2016-02-23" | "2016-02-29" | "2016-03-07" | "2016-06-15" | "2016-07-06" | "2016-10-19" | "2017-01-27" | "2017-02-14" | "2017-04-06" | "2017-05-25" | "2017-06-05" | "2017-08-15" | "2017-12-14" | "2018-01-23" | "2018-02-05" | "2018-02-06" | "2018-02-28" | "2018-05-21" | "2018-07-27" | "2018-08-23" | "2018-09-06" | "2018-09-24" | "2018-10-31" | "2018-11-08" | "2019-02-11" | "2019-02-19" | "2019-03-14" | "2019-05-16" | "2019-08-14" | "2019-09-09" | "2019-10-08" | "2019-10-17" | "2019-11-05" | "2019-12-03" | "2020-03-02" | "2020-08-27" | "2022-08-01" | "2022-11-15" | "2023-08-16" | "2023-10-16" | "2024-04-10" | "2024-06-20" | "2024-09-30.acacia" | "2024-10-28.acacia" | "2024-11-20.acacia" | "2024-12-18.acacia"; + api_version?: "2011-01-01" | "2011-06-21" | "2011-06-28" | "2011-08-01" | "2011-09-15" | "2011-11-17" | "2012-02-23" | "2012-03-25" | "2012-06-18" | "2012-06-28" | "2012-07-09" | "2012-09-24" | "2012-10-26" | "2012-11-07" | "2013-02-11" | "2013-02-13" | "2013-07-05" | "2013-08-12" | "2013-08-13" | "2013-10-29" | "2013-12-03" | "2014-01-31" | "2014-03-13" | "2014-03-28" | "2014-05-19" | "2014-06-13" | "2014-06-17" | "2014-07-22" | "2014-07-26" | "2014-08-04" | "2014-08-20" | "2014-09-08" | "2014-10-07" | "2014-11-05" | "2014-11-20" | "2014-12-08" | "2014-12-17" | "2014-12-22" | "2015-01-11" | "2015-01-26" | "2015-02-10" | "2015-02-16" | "2015-02-18" | "2015-03-24" | "2015-04-07" | "2015-06-15" | "2015-07-07" | "2015-07-13" | "2015-07-28" | "2015-08-07" | "2015-08-19" | "2015-09-03" | "2015-09-08" | "2015-09-23" | "2015-10-01" | "2015-10-12" | "2015-10-16" | "2016-02-03" | "2016-02-19" | "2016-02-22" | "2016-02-23" | "2016-02-29" | "2016-03-07" | "2016-06-15" | "2016-07-06" | "2016-10-19" | "2017-01-27" | "2017-02-14" | "2017-04-06" | "2017-05-25" | "2017-06-05" | "2017-08-15" | "2017-12-14" | "2018-01-23" | "2018-02-05" | "2018-02-06" | "2018-02-28" | "2018-05-21" | "2018-07-27" | "2018-08-23" | "2018-09-06" | "2018-09-24" | "2018-10-31" | "2018-11-08" | "2019-02-11" | "2019-02-19" | "2019-03-14" | "2019-05-16" | "2019-08-14" | "2019-09-09" | "2019-10-08" | "2019-10-17" | "2019-11-05" | "2019-12-03" | "2020-03-02" | "2020-08-27" | "2022-08-01" | "2022-11-15" | "2023-08-16" | "2023-10-16" | "2024-04-10" | "2024-06-20" | "2024-09-30.acacia" | "2024-10-28.acacia" | "2024-11-20.acacia" | "2024-12-18.acacia" | "2025-01-27.acacia"; /** @description Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`. */ connect?: boolean; /** @description An optional description of what the webhook is used for. */ diff --git a/packages/openapi-typescript/examples/stripe-api.yaml b/packages/openapi-typescript/examples/stripe-api.yaml index d0a501f06..1e48b1d1c 100644 --- a/packages/openapi-typescript/examples/stripe-api.yaml +++ b/packages/openapi-typescript/examples/stripe-api.yaml @@ -715,6 +715,15 @@ components: - inactive - pending type: string + pay_by_bank_payments: + description: >- + The status of the pay_by_bank payments capability of the account, or + whether the account can directly process pay_by_bank charges. + enum: + - active + - inactive + - pending + type: string payco_payments: description: >- The status of the Payco capability of the account, or whether the @@ -2012,6 +2021,14 @@ components: api_errors: description: '' properties: + advice_code: + description: >- + For card errors resulting from a card issuer decline, a short string + indicating [how to proceed with an + error](https://stripe.com/docs/declines#retrying-issuer-declines) if + they provide one. + maxLength: 5000 + type: string charge: description: 'For card errors, the ID of the failed charge.' maxLength: 5000 @@ -5419,6 +5436,17 @@ components: charge_outcome: description: '' properties: + advice_code: + description: >- + An enumerated value providing a more detailed explanation on [how to + proceed with an + error](https://stripe.com/docs/declines#retrying-issuer-declines). + enum: + - confirm_card_data + - do_not_try_again + - try_again_later + nullable: true + type: string network_advice_code: description: >- For charges declined by the network, a 2 digit code which indicates @@ -5733,6 +5761,14 @@ components: maxLength: 5000 nullable: true type: string + discounts: + description: >- + List of coupons and promotion codes attached to the Checkout + Session. + items: + $ref: '#/components/schemas/payment_pages_checkout_session_discount' + nullable: true + type: array expires_at: description: The timestamp at which the Checkout Session will expire. format: unix-time @@ -5861,6 +5897,7 @@ components: - setup - subscription type: string + x-stripeBypassValidation: true object: description: >- String representing the object's type. Objects of the same type @@ -6117,6 +6154,7 @@ components: - custom_text - customer - customer_details + - discounts - invoice - invoice_creation - line_items @@ -8400,6 +8438,8 @@ components: $ref: '#/components/schemas/payment_method_oxxo' p24: $ref: '#/components/schemas/payment_method_p24' + pay_by_bank: + $ref: '#/components/schemas/payment_method_pay_by_bank' payco: $ref: '#/components/schemas/payment_method_payco' paynow: @@ -8459,6 +8499,7 @@ components: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -8520,6 +8561,7 @@ components: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -8683,6 +8725,16 @@ components: $ref: '#/components/schemas/connect_embedded_payouts_config_claim' documents: $ref: '#/components/schemas/connect_embedded_base_config_claim' + financial_account: + $ref: '#/components/schemas/connect_embedded_financial_account_config_claim' + financial_account_transactions: + $ref: >- + #/components/schemas/connect_embedded_financial_account_transactions_config_claim + issuing_card: + $ref: '#/components/schemas/connect_embedded_issuing_card_config_claim' + issuing_cards_list: + $ref: >- + #/components/schemas/connect_embedded_issuing_cards_list_config_claim notification_banner: $ref: '#/components/schemas/connect_embedded_account_config_claim' payment_details: @@ -8702,6 +8754,10 @@ components: - account_onboarding - balances - documents + - financial_account + - financial_account_transactions + - issuing_card + - issuing_cards_list - notification_banner - payment_details - payments @@ -8716,6 +8772,10 @@ components: - account_onboarding - balances - documents + - financial_account + - financial_account_transactions + - issuing_card + - issuing_cards_list - notification_banner - payment_details - payments @@ -8744,6 +8804,162 @@ components: title: ConnectEmbeddedBaseFeatures type: object x-expandableFields: [] + connect_embedded_financial_account_config_claim: + description: '' + properties: + enabled: + description: Whether the embedded component is enabled. + type: boolean + features: + $ref: '#/components/schemas/connect_embedded_financial_account_features' + required: + - enabled + - features + title: ConnectEmbeddedFinancialAccountConfigClaim + type: object + x-expandableFields: + - features + connect_embedded_financial_account_features: + description: '' + properties: + disable_stripe_user_authentication: + description: >- + Disables Stripe user authentication for this embedded component. + This value can only be true for accounts where + `controller.requirement_collection` is `application`. The default + value is the opposite of the `external_account_collection` value. + For example, if you don’t set `external_account_collection`, it + defaults to true and `disable_stripe_user_authentication` defaults + to false. + type: boolean + external_account_collection: + description: Whether to allow external accounts to be linked for money transfer. + type: boolean + send_money: + description: Whether to allow sending money. + type: boolean + transfer_balance: + description: Whether to allow transferring balance. + type: boolean + required: + - disable_stripe_user_authentication + - external_account_collection + - send_money + - transfer_balance + title: ConnectEmbeddedFinancialAccountFeatures + type: object + x-expandableFields: [] + connect_embedded_financial_account_transactions_config_claim: + description: '' + properties: + enabled: + description: Whether the embedded component is enabled. + type: boolean + features: + $ref: >- + #/components/schemas/connect_embedded_financial_account_transactions_features + required: + - enabled + - features + title: ConnectEmbeddedFinancialAccountTransactionsConfigClaim + type: object + x-expandableFields: + - features + connect_embedded_financial_account_transactions_features: + description: '' + properties: + card_spend_dispute_management: + description: Whether to allow card spend dispute management features. + type: boolean + required: + - card_spend_dispute_management + title: ConnectEmbeddedFinancialAccountTransactionsFeatures + type: object + x-expandableFields: [] + connect_embedded_issuing_card_config_claim: + description: '' + properties: + enabled: + description: Whether the embedded component is enabled. + type: boolean + features: + $ref: '#/components/schemas/connect_embedded_issuing_card_features' + required: + - enabled + - features + title: ConnectEmbeddedIssuingCardConfigClaim + type: object + x-expandableFields: + - features + connect_embedded_issuing_card_features: + description: '' + properties: + card_management: + description: Whether to allow card management features. + type: boolean + card_spend_dispute_management: + description: Whether to allow card spend dispute management features. + type: boolean + cardholder_management: + description: Whether to allow cardholder management features. + type: boolean + spend_control_management: + description: Whether to allow spend control management features. + type: boolean + required: + - card_management + - card_spend_dispute_management + - cardholder_management + - spend_control_management + title: ConnectEmbeddedIssuingCardFeatures + type: object + x-expandableFields: [] + connect_embedded_issuing_cards_list_config_claim: + description: '' + properties: + enabled: + description: Whether the embedded component is enabled. + type: boolean + features: + $ref: '#/components/schemas/connect_embedded_issuing_cards_list_features' + required: + - enabled + - features + title: ConnectEmbeddedIssuingCardsListConfigClaim + type: object + x-expandableFields: + - features + connect_embedded_issuing_cards_list_features: + description: '' + properties: + card_management: + description: Whether to allow card management features. + type: boolean + card_spend_dispute_management: + description: Whether to allow card spend dispute management features. + type: boolean + cardholder_management: + description: Whether to allow cardholder management features. + type: boolean + disable_stripe_user_authentication: + description: >- + Disables Stripe user authentication for this embedded component. + This feature can only be false for accounts where you’re responsible + for collecting updated information when requirements are due or + change, like custom accounts. + type: boolean + spend_control_management: + description: Whether to allow spend control management features. + type: boolean + required: + - card_management + - card_spend_dispute_management + - cardholder_management + - disable_stripe_user_authentication + - spend_control_management + title: ConnectEmbeddedIssuingCardsListFeatures + type: object + x-expandableFields: [] connect_embedded_payments_config_claim: description: '' properties: @@ -9410,6 +9626,7 @@ components: - number - object - pdf + - pretax_credit_amounts - status - subtotal - tax_amounts @@ -9536,6 +9753,7 @@ components: - id - livemode - object + - pretax_credit_amounts - tax_amounts - tax_rates - type @@ -23580,6 +23798,13 @@ components: provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided). type: boolean + directorship_declaration: + anyOf: + - $ref: '#/components/schemas/legal_entity_directorship_declaration' + description: >- + This hash is used to attest that the director information provided + to Stripe is both current and correct. + nullable: true executives_provided: description: >- Whether the company's executives have been provided. This Boolean @@ -23631,6 +23856,11 @@ components: This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. nullable: true + ownership_exemption_reason: + enum: + - qualified_entity_exceeds_ownership_threshold + - qualifies_as_financial_institution + type: string phone: description: The company's phone number (used for verification). maxLength: 5000 @@ -23691,6 +23921,7 @@ components: - address - address_kana - address_kanji + - directorship_declaration - ownership_declaration - verification legal_entity_company_verification: @@ -23758,6 +23989,33 @@ components: x-expandableFields: - back - front + legal_entity_directorship_declaration: + description: '' + properties: + date: + description: >- + The Unix timestamp marking when the directorship declaration + attestation was made. + format: unix-time + nullable: true + type: integer + ip: + description: >- + The IP address from which the directorship declaration attestation + was made. + maxLength: 5000 + nullable: true + type: string + user_agent: + description: >- + The user-agent string from the browser where the directorship + declaration attestation was made. + maxLength: 5000 + nullable: true + type: string + title: LegalEntityDirectorshipDeclaration + type: object + x-expandableFields: [] legal_entity_dob: description: '' properties: @@ -24829,12 +25087,15 @@ components: properties: billing_details: $ref: '#/components/schemas/treasury_shared_resource_billing_details' + financial_account: + $ref: >- + #/components/schemas/outbound_transfers_payment_method_details_financial_account type: description: The type of the payment method used in the OutboundTransfer. enum: + - financial_account - us_bank_account type: string - x-stripeBypassValidation: true us_bank_account: $ref: >- #/components/schemas/outbound_transfers_payment_method_details_us_bank_account @@ -24845,7 +25106,26 @@ components: type: object x-expandableFields: - billing_details + - financial_account - us_bank_account + outbound_transfers_payment_method_details_financial_account: + description: '' + properties: + id: + description: Token of the FinancialAccount. + maxLength: 5000 + type: string + network: + description: The rails used to send funds. + enum: + - stripe + type: string + required: + - id + - network + title: outbound_transfers_payment_method_details_financial_account + type: object + x-expandableFields: [] outbound_transfers_payment_method_details_us_bank_account: description: '' properties: @@ -26591,6 +26871,11 @@ components: - $ref: '#/components/schemas/payment_method_options_p24' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + pay_by_bank: + anyOf: + - $ref: '#/components/schemas/payment_method_options_pay_by_bank' + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client payco: anyOf: - $ref: >- @@ -26699,6 +26984,7 @@ components: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -27674,6 +27960,7 @@ components: - multibanco - oxxo - p24 + - pay_by_bank - paynow - paypal - pix @@ -28478,6 +28765,7 @@ components: - SA - SB - SC + - SD - SE - SG - SH @@ -28532,7 +28820,6 @@ components: - ZW - ZZ type: string - x-stripeBypassValidation: true type: array required: - allowed_countries @@ -28796,6 +29083,8 @@ components: $ref: '#/components/schemas/payment_method_oxxo' p24: $ref: '#/components/schemas/payment_method_p24' + pay_by_bank: + $ref: '#/components/schemas/payment_method_pay_by_bank' payco: $ref: '#/components/schemas/payment_method_payco' paynow: @@ -28857,6 +29146,7 @@ components: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -28922,6 +29212,7 @@ components: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -29797,6 +30088,9 @@ components: maxLength: 5000 nullable: true type: string + pay_by_bank: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties paynow: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties @@ -29870,6 +30164,7 @@ components: - multibanco - oxxo - p24 + - pay_by_bank - paynow - paypal - promptpay @@ -29958,6 +30253,8 @@ components: $ref: '#/components/schemas/payment_method_details_oxxo' p24: $ref: '#/components/schemas/payment_method_details_p24' + pay_by_bank: + $ref: '#/components/schemas/payment_method_details_pay_by_bank' payco: $ref: '#/components/schemas/payment_method_details_payco' paynow: @@ -30042,6 +30339,7 @@ components: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -31820,6 +32118,12 @@ components: title: payment_method_details_passthrough_card type: object x-expandableFields: [] + payment_method_details_pay_by_bank: + description: '' + properties: {} + title: payment_method_details_pay_by_bank + type: object + x-expandableFields: [] payment_method_details_payco: description: '' properties: @@ -31847,6 +32151,14 @@ components: payment_method_details_paypal: description: '' properties: + country: + description: >- + Two-letter ISO code representing the buyer's country. Values are + provided by PayPal directly (if supported) at the time of + authorization or settlement. They cannot be set or mutated. + maxLength: 5000 + nullable: true + type: string payer_email: description: >- Owner's email. Values are provided by PayPal directly @@ -33640,6 +33952,12 @@ components: title: payment_method_options_p24 type: object x-expandableFields: [] + payment_method_options_pay_by_bank: + description: '' + properties: {} + title: payment_method_options_pay_by_bank + type: object + x-expandableFields: [] payment_method_options_paynow: description: '' properties: @@ -34066,6 +34384,12 @@ components: title: payment_method_p24 type: object x-expandableFields: [] + payment_method_pay_by_bank: + description: '' + properties: {} + title: payment_method_pay_by_bank + type: object + x-expandableFields: [] payment_method_payco: description: '' properties: {} @@ -34081,6 +34405,14 @@ components: payment_method_paypal: description: '' properties: + country: + description: >- + Two-letter ISO code representing the buyer's country. Values are + provided by PayPal directly (if supported) at the time of + authorization or settlement. They cannot be set or mutated. + maxLength: 5000 + nullable: true + type: string payer_email: description: >- Owner's email. Values are provided by PayPal directly @@ -34774,6 +35106,34 @@ components: x-expandableFields: - address - tax_ids + payment_pages_checkout_session_discount: + description: '' + properties: + coupon: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/coupon' + description: Coupon attached to the Checkout Session. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/coupon' + promotion_code: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/promotion_code' + description: Promotion code attached to the Checkout Session. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/promotion_code' + title: PaymentPagesCheckoutSessionDiscount + type: object + x-expandableFields: + - coupon + - promotion_code payment_pages_checkout_session_invoice_creation: description: '' properties: @@ -34935,7 +35295,7 @@ components: countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, - IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. + IR, KP, MH, FM, NF, MP, PW, SY, UM, VI`. items: enum: - AC @@ -35122,6 +35482,7 @@ components: - SA - SB - SC + - SD - SE - SG - SH @@ -35176,7 +35537,6 @@ components: - ZW - ZZ type: string - x-stripeBypassValidation: true type: array required: - allowed_countries @@ -47296,6 +47656,9 @@ components: hkd: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config + jpy: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config myr: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config @@ -47328,6 +47691,7 @@ components: - eur - gbp - hkd + - jpy - myr - nok - nzd @@ -48904,6 +49268,8 @@ components: description: Unique identifier for the object. maxLength: 5000 type: string + is_default: + type: boolean livemode: description: >- Has the value `true` if the object exists in live mode or the value @@ -48919,6 +49285,11 @@ components: additional information about the object in a structured format. nullable: true type: object + nickname: + description: The nickname for the FinancialAccount. + maxLength: 5000 + nullable: true + type: string object: description: >- String representing the object's type. Objects of the same type @@ -50882,6 +51253,8 @@ components: $ref: '#/components/schemas/treasury.credit_reversal' outbound_payment: $ref: '#/components/schemas/treasury.outbound_payment' + outbound_transfer: + $ref: '#/components/schemas/treasury.outbound_transfer' payout: $ref: '#/components/schemas/payout' type: @@ -50890,9 +51263,9 @@ components: - credit_reversal - other - outbound_payment + - outbound_transfer - payout type: string - x-stripeBypassValidation: true required: - type title: TreasuryReceivedCreditsResourceSourceFlowsDetails @@ -50900,6 +51273,7 @@ components: x-expandableFields: - credit_reversal - outbound_payment + - outbound_transfer - payout treasury_received_credits_resource_status_transitions: description: '' @@ -51442,7 +51816,7 @@ info: details. termsOfService: 'https://stripe.com/us/terms/' title: Stripe API - version: 2024-12-18.acacia + version: 2025-01-27.acacia x-stripeSpecFilename: spec3 openapi: 3.0.0 paths: @@ -51682,6 +52056,82 @@ paths: - enabled title: base_config_param type: object + financial_account: + properties: + enabled: + type: boolean + features: + properties: + disable_stripe_user_authentication: + type: boolean + external_account_collection: + type: boolean + send_money: + type: boolean + transfer_balance: + type: boolean + title: financial_account_features_param + type: object + required: + - enabled + title: financial_account_config_param + type: object + financial_account_transactions: + properties: + enabled: + type: boolean + features: + properties: + card_spend_dispute_management: + type: boolean + title: financial_account_transactions_features_param + type: object + required: + - enabled + title: financial_account_transactions_config_param + type: object + issuing_card: + properties: + enabled: + type: boolean + features: + properties: + card_management: + type: boolean + card_spend_dispute_management: + type: boolean + cardholder_management: + type: boolean + spend_control_management: + type: boolean + title: issuing_card_features_param + type: object + required: + - enabled + title: issuing_card_config_param + type: object + issuing_cards_list: + properties: + enabled: + type: boolean + features: + properties: + card_management: + type: boolean + card_spend_dispute_management: + type: boolean + cardholder_management: + type: boolean + disable_stripe_user_authentication: + type: boolean + spend_control_management: + type: boolean + title: issuing_cards_list_features_param + type: object + required: + - enabled + title: issuing_cards_list_config_param + type: object notification_banner: properties: enabled: @@ -52413,6 +52863,12 @@ paths: type: boolean title: capability_param type: object + pay_by_bank_payments: + properties: + requested: + type: boolean + title: capability_param + type: object payco_payments: properties: requested: @@ -52601,6 +53057,18 @@ paths: type: object directors_provided: type: boolean + directorship_declaration: + properties: + date: + format: unix-time + type: integer + ip: + type: string + user_agent: + maxLength: 5000 + type: string + title: company_directorship_declaration + type: object executives_provided: type: boolean export_license_id: @@ -52632,6 +53100,12 @@ paths: type: string title: company_ownership_declaration type: object + ownership_exemption_reason: + enum: + - '' + - qualified_entity_exceeds_ownership_threshold + - qualifies_as_financial_institution + type: string phone: maxLength: 5000 type: string @@ -52822,6 +53296,15 @@ paths: type: array title: documents_param type: object + proof_of_ultimate_beneficial_ownership: + properties: + files: + items: + maxLength: 500 + type: string + type: array + title: documents_param + type: object title: documents_specs type: object email: @@ -53834,6 +54317,12 @@ paths: type: boolean title: capability_param type: object + pay_by_bank_payments: + properties: + requested: + type: boolean + title: capability_param + type: object payco_payments: properties: requested: @@ -54022,6 +54511,18 @@ paths: type: object directors_provided: type: boolean + directorship_declaration: + properties: + date: + format: unix-time + type: integer + ip: + type: string + user_agent: + maxLength: 5000 + type: string + title: company_directorship_declaration + type: object executives_provided: type: boolean export_license_id: @@ -54053,6 +54554,12 @@ paths: type: string title: company_ownership_declaration type: object + ownership_exemption_reason: + enum: + - '' + - qualified_entity_exceeds_ownership_threshold + - qualifies_as_financial_institution + type: string phone: maxLength: 5000 type: string @@ -54188,6 +54695,15 @@ paths: type: array title: documents_param type: object + proof_of_ultimate_beneficial_ownership: + properties: + files: + items: + maxLength: 500 + type: string + type: array + title: documents_param + type: object title: documents_specs type: object email: @@ -65363,6 +65879,7 @@ paths: - setup - subscription type: string + x-stripeBypassValidation: true payment_intent_data: description: >- A subset of parameters to be passed to PaymentIntent @@ -65883,6 +66400,10 @@ paths: type: boolean title: payment_method_options_param type: object + pay_by_bank: + properties: {} + title: payment_method_options_param + type: object payco: properties: capture_method: @@ -66126,6 +66647,7 @@ paths: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -66412,6 +66934,7 @@ paths: - SA - SB - SC + - SD - SE - SG - SH @@ -66466,7 +66989,6 @@ paths: - ZW - ZZ type: string - x-stripeBypassValidation: true type: array required: - allowed_countries @@ -72917,6 +73439,7 @@ paths: name: ending_before required: false schema: + maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. @@ -72949,6 +73472,7 @@ paths: name: starting_after required: false schema: + maxLength: 5000 type: string style: form - description: >- @@ -72991,6 +73515,7 @@ paths: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -79253,7 +79778,9 @@ paths: objects.

operationId: GetFinancialConnectionsTransactions parameters: - - description: The ID of the Stripe account whose transactions will be retrieved. + - description: >- + The ID of the Financial Connections Account whose transactions will + be retrieved. in: query name: account required: true @@ -98110,6 +98637,10 @@ paths: x-stripeBypassValidation: true title: param type: object + pay_by_bank: + properties: {} + title: param + type: object payco: properties: {} title: param @@ -98207,6 +98738,7 @@ paths: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -99119,6 +99651,14 @@ paths: - enum: - '' type: string + pay_by_bank: + anyOf: + - properties: {} + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string payco: anyOf: - properties: @@ -100350,6 +100890,10 @@ paths: x-stripeBypassValidation: true title: param type: object + pay_by_bank: + properties: {} + title: param + type: object payco: properties: {} title: param @@ -100447,6 +100991,7 @@ paths: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -101359,6 +101904,14 @@ paths: - enum: - '' type: string + pay_by_bank: + anyOf: + - properties: {} + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string payco: anyOf: - properties: @@ -102744,6 +103297,10 @@ paths: x-stripeBypassValidation: true title: param type: object + pay_by_bank: + properties: {} + title: param + type: object payco: properties: {} title: param @@ -102841,6 +103398,7 @@ paths: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -103753,6 +104311,14 @@ paths: - enum: - '' type: string + pay_by_bank: + anyOf: + - properties: {} + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string payco: anyOf: - properties: @@ -105132,6 +105698,7 @@ paths: - multibanco - oxxo - p24 + - pay_by_bank - paynow - paypal - pix @@ -105367,6 +105934,7 @@ paths: - SA - SB - SC + - SD - SE - SG - SH @@ -105421,7 +105989,6 @@ paths: - ZW - ZZ type: string - x-stripeBypassValidation: true type: array required: - allowed_countries @@ -105647,6 +106214,9 @@ paths: payment_method_types: explode: true style: deepObject + phone_number_collection: + explode: true + style: deepObject restrictions: explode: true style: deepObject @@ -106110,6 +106680,7 @@ paths: - multibanco - oxxo - p24 + - pay_by_bank - paynow - paypal - pix @@ -106132,6 +106703,20 @@ paths: Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). + phone_number_collection: + description: >- + Controls phone number collection settings during checkout. + + + We recommend that you review your privacy policy and check + with your legal contacts. + properties: + enabled: + type: boolean + required: + - enabled + title: phone_number_collection_params + type: object restrictions: anyOf: - properties: @@ -106341,6 +106926,7 @@ paths: - SA - SB - SC + - SD - SE - SG - SH @@ -106395,7 +106981,6 @@ paths: - ZW - ZZ type: string - x-stripeBypassValidation: true type: array required: - allowed_countries @@ -106850,6 +107435,9 @@ paths: p24: explode: true style: deepObject + pay_by_bank: + explode: true + style: deepObject paynow: explode: true style: deepObject @@ -107551,6 +108139,27 @@ paths: child configuration. maxLength: 100 type: string + pay_by_bank: + description: >- + Pay by bank is a redirect payment method backed by bank + transfers. A customer is redirected to their bank to + authorize a bank transfer for a given amount. This removes a + lot of the error risks inherent in waiting for the customer + to initiate a transfer themselves, and is less expensive + than card payments. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object paynow: description: >- PayNow is a Singapore-based payment method that allows @@ -107958,6 +108567,9 @@ paths: p24: explode: true style: deepObject + pay_by_bank: + explode: true + style: deepObject paynow: explode: true style: deepObject @@ -108656,6 +109268,27 @@ paths: type: object title: payment_method_param type: object + pay_by_bank: + description: >- + Pay by bank is a redirect payment method backed by bank + transfers. A customer is redirected to their bank to + authorize a bank transfer for a given amount. This removes a + lot of the error risks inherent in waiting for the customer + to initiate a transfer themselves, and is less expensive + than card payments. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object paynow: description: >- PayNow is a Singapore-based payment method that allows @@ -109259,6 +109892,7 @@ paths: name: ending_before required: false schema: + maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. @@ -109291,6 +109925,7 @@ paths: name: starting_after required: false schema: + maxLength: 5000 type: string style: form - description: >- @@ -109333,6 +109968,7 @@ paths: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -109520,6 +110156,9 @@ paths: p24: explode: true style: deepObject + pay_by_bank: + explode: true + style: deepObject payco: explode: true style: deepObject @@ -110074,6 +110713,13 @@ paths: x-stripeBypassValidation: true title: param type: object + pay_by_bank: + description: >- + If this is a `pay_by_bank` PaymentMethod, this hash contains + details about the PayByBank payment method. + properties: {} + title: param + type: object payco: description: >- If this is a `payco` PaymentMethod, this hash contains @@ -110218,6 +110864,7 @@ paths: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -110375,6 +111022,9 @@ paths: naver_pay: explode: true style: deepObject + pay_by_bank: + explode: true + style: deepObject us_bank_account: explode: true style: deepObject @@ -110512,6 +111162,13 @@ paths: x-stripeBypassValidation: true title: param type: object + pay_by_bank: + description: >- + If this is a `pay_by_bank` PaymentMethod, this hash contains + details about the PayByBank payment method. + properties: {} + title: param + type: object us_bank_account: description: >- If this is an `us_bank_account` PaymentMethod, this hash @@ -119031,6 +119688,10 @@ paths: x-stripeBypassValidation: true title: param type: object + pay_by_bank: + properties: {} + title: param + type: object payco: properties: {} title: param @@ -119128,6 +119789,7 @@ paths: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -120094,6 +120756,10 @@ paths: x-stripeBypassValidation: true title: param type: object + pay_by_bank: + properties: {} + title: param + type: object payco: properties: {} title: param @@ -120191,6 +120857,7 @@ paths: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -121149,6 +121816,10 @@ paths: x-stripeBypassValidation: true title: param type: object + pay_by_bank: + properties: {} + title: param + type: object payco: properties: {} title: param @@ -121246,6 +121917,7 @@ paths: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -132250,6 +132922,20 @@ paths: type: integer title: currency_specific_config type: object + jpy: + properties: + fixed_amounts: + items: + type: integer + type: array + percentages: + items: + type: integer + type: array + smart_tip_threshold: + type: integer + title: currency_specific_config + type: object myr: properties: fixed_amounts: @@ -132694,6 +133380,20 @@ paths: type: integer title: currency_specific_config type: object + jpy: + properties: + fixed_amounts: + items: + type: integer + type: array + percentages: + items: + type: integer + type: array + smart_tip_threshold: + type: integer + title: currency_specific_config + type: object myr: properties: fixed_amounts: @@ -134423,6 +135123,10 @@ paths: x-stripeBypassValidation: true title: param type: object + pay_by_bank: + properties: {} + title: param + type: object payco: properties: {} title: param @@ -134520,6 +135224,7 @@ paths: - naver_pay - oxxo - p24 + - pay_by_bank - payco - paynow - paypal @@ -139056,6 +139761,18 @@ paths: type: object directors_provided: type: boolean + directorship_declaration: + properties: + date: + format: unix-time + type: integer + ip: + type: string + user_agent: + maxLength: 5000 + type: string + title: company_directorship_declaration + type: object executives_provided: type: boolean export_license_id: @@ -139089,6 +139806,12 @@ paths: type: object ownership_declaration_shown_and_signed: type: boolean + ownership_exemption_reason: + enum: + - '' + - qualified_entity_exceeds_ownership_threshold + - qualifies_as_financial_institution + type: string phone: maxLength: 5000 type: string @@ -141619,6 +142342,9 @@ paths: metadata: explode: true style: deepObject + nickname: + explode: true + style: deepObject platform_restrictions: explode: true style: deepObject @@ -141742,6 +142468,14 @@ paths: value to them. All keys can be unset by posting an empty value to `metadata`. type: object + nickname: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + description: The nickname for the FinancialAccount. platform_restrictions: description: >- The set of functionalities that the platform can restrict on @@ -141850,9 +142584,15 @@ paths: features: explode: true style: deepObject + forwarding_settings: + explode: true + style: deepObject metadata: explode: true style: deepObject + nickname: + explode: true + style: deepObject platform_restrictions: explode: true style: deepObject @@ -141962,6 +142702,26 @@ paths: type: object title: feature_access type: object + forwarding_settings: + description: >- + A different bank account where funds can be + deposited/debited in order to get the closing FA's balance + to $0 + properties: + financial_account: + type: string + payment_method: + maxLength: 5000 + type: string + type: + enum: + - financial_account + - payment_method + type: string + required: + - type + title: forwarding_settings + type: object metadata: additionalProperties: type: string @@ -141974,6 +142734,14 @@ paths: value to them. All keys can be unset by posting an empty value to `metadata`. type: object + nickname: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + description: The nickname for the FinancialAccount. platform_restrictions: description: >- The set of functionalities that the platform can restrict on @@ -142007,6 +142775,76 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Update a FinancialAccount + '/v1/treasury/financial_accounts/{financial_account}/close': + post: + description: >- +

Closes a FinancialAccount. A FinancialAccount can only be closed if + it has a zero balance, has no pending InboundTransfers, and has canceled + all attached Issuing cards.

+ operationId: PostTreasuryFinancialAccountsFinancialAccountClose + parameters: + - in: path + name: financial_account + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + forwarding_settings: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + forwarding_settings: + description: >- + A different bank account where funds can be + deposited/debited in order to get the closing FA's balance + to $0 + properties: + financial_account: + type: string + payment_method: + maxLength: 5000 + type: string + type: + enum: + - financial_account + - payment_method + type: string + required: + - type + title: forwarding_settings + type: object + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/treasury.financial_account' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Close a FinancialAccount '/v1/treasury/financial_accounts/{financial_account}/features': get: description: >- @@ -143160,6 +143998,9 @@ paths: content: application/x-www-form-urlencoded: encoding: + destination_payment_method_data: + explode: true + style: deepObject destination_payment_method_options: explode: true style: deepObject @@ -143195,6 +144036,22 @@ paths: OutboundTransfer. maxLength: 5000 type: string + destination_payment_method_data: + description: >- + Hash used to generate the PaymentMethod to be used for this + OutboundTransfer. Exclusive with + `destination_payment_method`. + properties: + financial_account: + type: string + type: + enum: + - financial_account + type: string + required: + - type + title: payment_method_data + type: object destination_payment_method_options: description: Hash describing payment method configuration details. properties: @@ -143414,9 +144271,9 @@ paths: - credit_reversal - other - outbound_payment + - outbound_transfer - payout type: string - x-stripeBypassValidation: true required: - source_flow_type title: linked_flows_param @@ -144424,6 +145281,7 @@ paths: - 2024-10-28.acacia - 2024-11-20.acacia - 2024-12-18.acacia + - 2025-01-27.acacia maxLength: 5000 type: string x-stripeBypassValidation: true diff --git a/packages/openapi-typescript/package.json b/packages/openapi-typescript/package.json index 840375631..c2d68bf64 100644 --- a/packages/openapi-typescript/package.json +++ b/packages/openapi-typescript/package.json @@ -60,7 +60,7 @@ "typescript": "^5.x" }, "dependencies": { - "@redocly/openapi-core": "^1.27.0", + "@redocly/openapi-core": "^1.27.2", "ansi-colors": "^4.1.3", "change-case": "^5.4.4", "parse-json": "^8.1.0", @@ -75,7 +75,7 @@ "esbuild": "^0.24.2", "execa": "^8.0.1", "strip-ansi": "^7.1.0", - "typescript": "^5.7.2", + "typescript": "^5.7.3", "vite-node": "^2.1.8" } } diff --git a/packages/swr-openapi/package.json b/packages/swr-openapi/package.json index 6a3b52aeb..5b33cc520 100644 --- a/packages/swr-openapi/package.json +++ b/packages/swr-openapi/package.json @@ -69,7 +69,7 @@ }, "dependencies": { "openapi-typescript-helpers": "workspace:^", - "type-fest": "^4.31.0" + "type-fest": "^4.33.0" }, "devDependencies": { "@arethetypeswrong/cli": "^0.16.4", @@ -83,6 +83,6 @@ "openapi-typescript": "workspace:^", "react": "18.3.1", "swr": "2.2.5", - "typescript": "^5.7.2" + "typescript": "^5.7.3" } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 4091df50f..b1d2c3b98 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -15,17 +15,17 @@ importers: specifier: ^0.5.0 version: 0.5.0 '@changesets/cli': - specifier: ^2.27.11 - version: 2.27.11 + specifier: ^2.27.12 + version: 2.27.12 '@playwright/test': - specifier: ^1.49.1 - version: 1.49.1 + specifier: ^1.50.0 + version: 1.50.0 '@size-limit/preset-small-lib': specifier: ^11.1.6 version: 11.1.6(size-limit@11.1.6) '@types/node': - specifier: ^22.10.5 - version: 22.10.5 + specifier: ^22.10.10 + version: 22.10.10 del-cli: specifier: ^5.1.0 version: 5.1.0 @@ -36,29 +36,29 @@ importers: specifier: ^11.1.6 version: 11.1.6 turbo: - specifier: ^2.3.3 - version: 2.3.3 + specifier: ^2.3.4 + version: 2.3.4 typescript: - specifier: ^5.7.2 - version: 5.7.2 + specifier: ^5.7.3 + version: 5.7.3 vitest: specifier: ^2.1.8 - version: 2.1.8(@types/node@22.10.5)(jsdom@20.0.3)(msw@2.7.0(@types/node@22.10.5)(typescript@5.7.2)) + version: 2.1.8(@types/node@22.10.10)(jsdom@20.0.3)(msw@2.7.0(@types/node@22.10.10)(typescript@5.7.3)) docs: devDependencies: '@shikijs/vitepress-twoslash': - specifier: ^1.26.1 - version: 1.26.1(typescript@5.7.2) + specifier: ^1.29.1 + version: 1.29.1(typescript@5.7.3) openapi-metadata: specifier: workspace:* version: link:../packages/openapi-metadata vite: - specifier: ^6.0.7 - version: 6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1) + specifier: ^6.0.11 + version: 6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1) vitepress: - specifier: 1.5.0 - version: 1.5.0(@algolia/client-search@5.18.0)(@types/node@22.10.5)(@types/react@18.3.18)(axios@1.7.9)(change-case@5.4.4)(postcss@8.4.49)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)(typescript@5.7.2) + specifier: 1.6.3 + version: 1.6.3(@algolia/client-search@5.20.0)(@types/node@22.10.10)(@types/react@18.3.18)(axios@1.7.9)(change-case@5.4.4)(postcss@8.5.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)(typescript@5.7.3) packages/openapi-fetch: dependencies: @@ -94,26 +94,26 @@ importers: specifier: ^0.25.0 version: 0.25.0 openapi-typescript-fetch: - specifier: ^2.0.0 - version: 2.0.0 + specifier: ^2.1.0 + version: 2.1.0 superagent: specifier: ^10.1.1 version: 10.1.1 typescript: - specifier: ^5.7.2 - version: 5.7.2 + specifier: ^5.7.3 + version: 5.7.3 undici: specifier: ^6.21.1 version: 6.21.1 vite: - specifier: ^6.0.7 - version: 6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1) + specifier: ^6.0.11 + version: 6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1) packages/openapi-fetch/examples/nextjs: dependencies: next: specifier: 15.1.2 - version: 15.1.2(@playwright/test@1.49.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + version: 15.1.2(@playwright/test@1.50.0)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) openapi-fetch: specifier: workspace:^ version: link:../.. @@ -134,45 +134,45 @@ importers: specifier: workspace:^ version: link:../../../openapi-typescript typescript: - specifier: ^5.7.2 - version: 5.7.2 + specifier: ^5.7.3 + version: 5.7.3 packages/openapi-fetch/examples/sveltekit: dependencies: '@sveltejs/vite-plugin-svelte-inspector': specifier: ^4.0.1 - version: 4.0.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)) + version: 4.0.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)) openapi-fetch: specifier: workspace:^ version: link:../.. devDependencies: '@sveltejs/adapter-auto': specifier: ^3.3.1 - version: 3.3.1(@sveltejs/kit@2.15.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1))) + version: 3.3.1(@sveltejs/kit@2.16.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1))) '@sveltejs/kit': - specifier: ^2.15.1 - version: 2.15.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)) + specifier: ^2.16.1 + version: 2.16.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)) '@sveltejs/vite-plugin-svelte': specifier: ^5.0.3 - version: 5.0.3(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)) + version: 5.0.3(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)) openapi-typescript: specifier: workspace:^ version: link:../../../openapi-typescript svelte: - specifier: ^5.16.1 - version: 5.16.1 + specifier: ^5.19.3 + version: 5.19.3 svelte-check: specifier: ^3.8.6 - version: 3.8.6(@babel/core@7.26.0)(postcss@8.4.49)(svelte@5.16.1) + version: 3.8.6(@babel/core@7.26.7)(postcss@8.5.1)(svelte@5.19.3) tslib: specifier: ^2.8.1 version: 2.8.1 typescript: - specifier: ^5.7.2 - version: 5.7.2 + specifier: ^5.7.3 + version: 5.7.3 vite: - specifier: ^6.0.7 - version: 6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1) + specifier: ^6.0.11 + version: 6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1) packages/openapi-fetch/examples/vue-3: dependencies: @@ -181,14 +181,14 @@ importers: version: link:../.. vue: specifier: ^3.5.13 - version: 3.5.13(typescript@5.7.2) + version: 3.5.13(typescript@5.7.3) devDependencies: '@tsconfig/node20': specifier: ^20.1.4 version: 20.1.4 '@vitejs/plugin-vue': specifier: ^5.2.1 - version: 5.2.1(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1))(vue@3.5.13(typescript@5.7.2)) + version: 5.2.1(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1))(vue@3.5.13(typescript@5.7.3)) '@vue/tsconfig': specifier: ^0.5.1 version: 0.5.1 @@ -196,14 +196,14 @@ importers: specifier: workspace:^ version: link:../../../openapi-typescript typescript: - specifier: ^5.7.2 - version: 5.7.2 + specifier: ^5.7.3 + version: 5.7.3 vite: - specifier: ^6.0.7 - version: 6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1) + specifier: ^6.0.11 + version: 6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1) vue-tsc: specifier: ^2.2.0 - version: 2.2.0(typescript@5.7.2) + version: 2.2.0(typescript@5.7.3) packages/openapi-metadata: dependencies: @@ -237,7 +237,7 @@ importers: version: 0.2.2 tsup: specifier: ^8.3.5 - version: 8.3.5(@swc/core@1.10.4(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.4.49)(typescript@5.7.2)(yaml@2.5.1) + version: 8.3.5(@swc/core@1.10.4(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.5.1)(typescript@5.7.2)(yaml@2.5.1) type-fest: specifier: ^4.31.0 version: 4.31.0 @@ -246,7 +246,7 @@ importers: version: 5.7.2 unplugin-swc: specifier: ^1.5.1 - version: 1.5.1(@swc/core@1.10.4(@swc/helpers@0.5.15))(rollup@4.29.1) + version: 1.5.1(@swc/core@1.10.4(@swc/helpers@0.5.15))(rollup@4.32.0) packages/openapi-react-query: dependencies: @@ -255,17 +255,17 @@ importers: version: link:../openapi-typescript-helpers devDependencies: '@tanstack/react-query': - specifier: ^5.62.14 - version: 5.62.14(react@18.3.1) + specifier: ^5.64.2 + version: 5.64.2(react@18.3.1) '@testing-library/react': - specifier: ^16.1.0 - version: 16.1.0(@testing-library/dom@10.1.0)(@types/react-dom@18.3.5(@types/react@18.3.1))(@types/react@18.3.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) + specifier: ^16.2.0 + version: 16.2.0(@testing-library/dom@10.1.0)(@types/react-dom@18.3.5(@types/react@18.3.1))(@types/react@18.3.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1) '@types/react': specifier: 18.3.1 version: 18.3.1 '@vitejs/plugin-react': specifier: ^4.3.4 - version: 4.3.4(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)) + version: 4.3.4(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)) del-cli: specifier: ^5.1.0 version: 5.1.0 @@ -277,7 +277,7 @@ importers: version: 8.0.1 msw: specifier: ^2.7.0 - version: 2.7.0(@types/node@22.10.5)(typescript@5.7.2) + version: 2.7.0(@types/node@22.10.10)(typescript@5.7.3) openapi-fetch: specifier: workspace:^ version: link:../openapi-fetch @@ -294,8 +294,8 @@ importers: packages/openapi-typescript: dependencies: '@redocly/openapi-core': - specifier: ^1.27.0 - version: 1.27.0(supports-color@9.4.0) + specifier: ^1.27.2 + version: 1.27.2(supports-color@9.4.0) ansi-colors: specifier: ^4.1.3 version: 4.1.3 @@ -334,17 +334,17 @@ importers: specifier: ^7.1.0 version: 7.1.0 typescript: - specifier: ^5.7.2 - version: 5.7.2 + specifier: ^5.7.3 + version: 5.7.3 vite-node: specifier: ^2.1.8 - version: 2.1.8(@types/node@22.10.5)(supports-color@9.4.0) + version: 2.1.8(@types/node@22.10.10)(supports-color@9.4.0) packages/openapi-typescript-helpers: devDependencies: typescript: - specifier: ^5.7.2 - version: 5.7.2 + specifier: ^5.7.3 + version: 5.7.3 packages/swr-openapi: dependencies: @@ -352,8 +352,8 @@ importers: specifier: workspace:^ version: link:../openapi-typescript-helpers type-fest: - specifier: ^4.31.0 - version: 4.31.0 + specifier: ^4.33.0 + version: 4.33.0 devDependencies: '@arethetypeswrong/cli': specifier: ^0.16.4 @@ -389,8 +389,8 @@ importers: specifier: 2.2.5 version: 2.2.5(react@18.3.1) typescript: - specifier: ^5.7.2 - version: 5.7.2 + specifier: ^5.7.3 + version: 5.7.3 packages: @@ -414,56 +414,56 @@ packages: '@algolia/client-search': '>= 4.9.1 < 6' algoliasearch: '>= 4.9.1 < 6' - '@algolia/client-abtesting@5.18.0': - resolution: {integrity: sha512-DLIrAukjsSrdMNNDx1ZTks72o4RH/1kOn8Wx5zZm8nnqFexG+JzY4SANnCNEjnFQPJTTvC+KpgiNW/CP2lumng==} + '@algolia/client-abtesting@5.20.0': + resolution: {integrity: sha512-YaEoNc1Xf2Yk6oCfXXkZ4+dIPLulCx8Ivqj0OsdkHWnsI3aOJChY5qsfyHhDBNSOhqn2ilgHWxSfyZrjxBcAww==} engines: {node: '>= 14.0.0'} - '@algolia/client-analytics@5.18.0': - resolution: {integrity: sha512-0VpGG2uQW+h2aejxbG8VbnMCQ9ary9/ot7OASXi6OjE0SRkYQ/+pkW+q09+IScif3pmsVVYggmlMPtAsmYWHng==} + '@algolia/client-analytics@5.20.0': + resolution: {integrity: sha512-CIT9ni0+5sYwqehw+t5cesjho3ugKQjPVy/iPiJvtJX4g8Cdb6je6SPt2uX72cf2ISiXCAX9U3cY0nN0efnRDw==} engines: {node: '>= 14.0.0'} - '@algolia/client-common@5.18.0': - resolution: {integrity: sha512-X1WMSC+1ve2qlMsemyTF5bIjwipOT+m99Ng1Tyl36ZjQKTa54oajBKE0BrmM8LD8jGdtukAgkUhFoYOaRbMcmQ==} + '@algolia/client-common@5.20.0': + resolution: {integrity: sha512-iSTFT3IU8KNpbAHcBUJw2HUrPnMXeXLyGajmCL7gIzWOsYM4GabZDHXOFx93WGiXMti1dymz8k8R+bfHv1YZmA==} engines: {node: '>= 14.0.0'} - '@algolia/client-insights@5.18.0': - resolution: {integrity: sha512-FAJRNANUOSs/FgYOJ/Njqp+YTe4TMz2GkeZtfsw1TMiA5mVNRS/nnMpxas9771aJz7KTEWvK9GwqPs0K6RMYWg==} + '@algolia/client-insights@5.20.0': + resolution: {integrity: sha512-w9RIojD45z1csvW1vZmAko82fqE/Dm+Ovsy2ElTsjFDB0HMAiLh2FO86hMHbEXDPz6GhHKgGNmBRiRP8dDPgJg==} engines: {node: '>= 14.0.0'} - '@algolia/client-personalization@5.18.0': - resolution: {integrity: sha512-I2dc94Oiwic3SEbrRp8kvTZtYpJjGtg5y5XnqubgnA15AgX59YIY8frKsFG8SOH1n2rIhUClcuDkxYQNXJLg+w==} + '@algolia/client-personalization@5.20.0': + resolution: {integrity: sha512-p/hftHhrbiHaEcxubYOzqVV4gUqYWLpTwK+nl2xN3eTrSW9SNuFlAvUBFqPXSVBqc6J5XL9dNKn3y8OA1KElSQ==} engines: {node: '>= 14.0.0'} - '@algolia/client-query-suggestions@5.18.0': - resolution: {integrity: sha512-x6XKIQgKFTgK/bMasXhghoEjHhmgoP61pFPb9+TaUJ32aKOGc65b12usiGJ9A84yS73UDkXS452NjyP50Knh/g==} + '@algolia/client-query-suggestions@5.20.0': + resolution: {integrity: sha512-m4aAuis5vZi7P4gTfiEs6YPrk/9hNTESj3gEmGFgfJw3hO2ubdS4jSId1URd6dGdt0ax2QuapXufcrN58hPUcw==} engines: {node: '>= 14.0.0'} - '@algolia/client-search@5.18.0': - resolution: {integrity: sha512-qI3LcFsVgtvpsBGR7aNSJYxhsR+Zl46+958ODzg8aCxIcdxiK7QEVLMJMZAR57jGqW0Lg/vrjtuLFDMfSE53qA==} + '@algolia/client-search@5.20.0': + resolution: {integrity: sha512-KL1zWTzrlN4MSiaK1ea560iCA/UewMbS4ZsLQRPoDTWyrbDKVbztkPwwv764LAqgXk0fvkNZvJ3IelcK7DqhjQ==} engines: {node: '>= 14.0.0'} - '@algolia/ingestion@1.18.0': - resolution: {integrity: sha512-bGvJg7HnGGm+XWYMDruZXWgMDPVt4yCbBqq8DM6EoaMBK71SYC4WMfIdJaw+ABqttjBhe6aKNRkWf/bbvYOGyw==} + '@algolia/ingestion@1.20.0': + resolution: {integrity: sha512-shj2lTdzl9un4XJblrgqg54DoK6JeKFO8K8qInMu4XhE2JuB8De6PUuXAQwiRigZupbI0xq8aM0LKdc9+qiLQA==} engines: {node: '>= 14.0.0'} - '@algolia/monitoring@1.18.0': - resolution: {integrity: sha512-lBssglINIeGIR+8KyzH05NAgAmn1BCrm5D2T6pMtr/8kbTHvvrm1Zvcltc5dKUQEFyyx3J5+MhNc7kfi8LdjVw==} + '@algolia/monitoring@1.20.0': + resolution: {integrity: sha512-aF9blPwOhKtWvkjyyXh9P5peqmhCA1XxLBRgItT+K6pbT0q4hBDQrCid+pQZJYy4HFUKjB/NDDwyzFhj/rwKhw==} engines: {node: '>= 14.0.0'} - '@algolia/recommend@5.18.0': - resolution: {integrity: sha512-uSnkm0cdAuFwdMp4pGT5vHVQ84T6AYpTZ3I0b3k/M3wg4zXDhl3aCiY8NzokEyRLezz/kHLEEcgb/tTTobOYVw==} + '@algolia/recommend@5.20.0': + resolution: {integrity: sha512-T6B/WPdZR3b89/F9Vvk6QCbt/wrLAtrGoL8z4qPXDFApQ8MuTFWbleN/4rHn6APWO3ps+BUePIEbue2rY5MlRw==} engines: {node: '>= 14.0.0'} - '@algolia/requester-browser-xhr@5.18.0': - resolution: {integrity: sha512-1XFjW0C3pV0dS/9zXbV44cKI+QM4ZIz9cpatXpsjRlq6SUCpLID3DZHsXyE6sTb8IhyPaUjk78GEJT8/3hviqg==} + '@algolia/requester-browser-xhr@5.20.0': + resolution: {integrity: sha512-t6//lXsq8E85JMenHrI6mhViipUT5riNhEfCcvtRsTV+KIBpC6Od18eK864dmBhoc5MubM0f+sGpKOqJIlBSCg==} engines: {node: '>= 14.0.0'} - '@algolia/requester-fetch@5.18.0': - resolution: {integrity: sha512-0uodeNdAHz1YbzJh6C5xeQ4T6x5WGiUxUq3GOaT/R4njh5t78dq+Rb187elr7KtnjUmETVVuCvmEYaThfTHzNg==} + '@algolia/requester-fetch@5.20.0': + resolution: {integrity: sha512-FHxYGqRY+6bgjKsK4aUsTAg6xMs2S21elPe4Y50GB0Y041ihvw41Vlwy2QS6K9ldoftX4JvXodbKTcmuQxywdQ==} engines: {node: '>= 14.0.0'} - '@algolia/requester-node-http@5.18.0': - resolution: {integrity: sha512-tZCqDrqJ2YE2I5ukCQrYN8oiF6u3JIdCxrtKq+eniuLkjkO78TKRnXrVcKZTmfFJyyDK8q47SfDcHzAA3nHi6w==} + '@algolia/requester-node-http@5.20.0': + resolution: {integrity: sha512-kmtQClq/w3vtPteDSPvaW9SPZL/xrIgMrxZyAgsFwrJk0vJxqyC5/hwHmrCraDnStnGSADnLpBf4SpZnwnkwWw==} engines: {node: '>= 14.0.0'} '@ampproject/remapping@2.3.0': @@ -489,20 +489,20 @@ packages: resolution: {integrity: sha512-RJlIHRueQgwWitWgF8OdFYGZX328Ax5BCemNGlqHfplnRT9ESi8JkFlvaVYbS+UubVY6dpv87Fs2u5M29iNFVQ==} engines: {node: '>=6.9.0'} - '@babel/compat-data@7.26.3': - resolution: {integrity: sha512-nHIxvKPniQXpmQLb0vhY3VaFb3S0YrTAwpOWJZh1wn3oJPjJk9Asva204PsBdmAE8vpzfHudT8DB0scYvy9q0g==} + '@babel/compat-data@7.26.5': + resolution: {integrity: sha512-XvcZi1KWf88RVbF9wn8MN6tYFloU5qX8KjuF3E1PVBmJ9eypXfs4GRiJwLuTZL0iSnJUKn1BFPa5BPZZJyFzPg==} engines: {node: '>=6.9.0'} - '@babel/core@7.26.0': - resolution: {integrity: sha512-i1SLeK+DzNnQ3LL/CswPCa/E5u4lh1k6IAEphON8F+cXt0t9euTshDru0q7/IqMa1PMPz5RnHuHscF8/ZJsStg==} + '@babel/core@7.26.7': + resolution: {integrity: sha512-SRijHmF0PSPgLIBYlWnG0hyeJLwXE2CgpsXaMOrtt2yp9/86ALw6oUlj9KYuZ0JN07T4eBMVIW4li/9S1j2BGA==} engines: {node: '>=6.9.0'} - '@babel/generator@7.26.3': - resolution: {integrity: sha512-6FF/urZvD0sTeO7k6/B15pMLC4CHUv1426lzr3N01aHJTl046uCAh9LXW/fzeXXjPNCJ6iABW5XaWOsIZB93aQ==} + '@babel/generator@7.26.5': + resolution: {integrity: sha512-2caSP6fN9I7HOe6nqhtft7V4g7/V/gfDsC3Ag4W7kEzzvRGKqiv0pu0HogPiZ3KaVSoNDhUws6IJjDjpfmYIXw==} engines: {node: '>=6.9.0'} - '@babel/helper-compilation-targets@7.25.9': - resolution: {integrity: sha512-j9Db8Suy6yV/VHa4qzrj9yZfZxhLWQdVnRlXxmKLYlhWUVB1sB2G5sxuWYXk/whHD9iW76PmNzxZ4UCnTQTVEQ==} + '@babel/helper-compilation-targets@7.26.5': + resolution: {integrity: sha512-IXuyn5EkouFJscIDuFF5EsiSolseme1s0CZB+QxVugqJLYmKdxI1VfIBOst0SUu4rnk2Z7kqTwmoO1lp3HIfnA==} engines: {node: '>=6.9.0'} '@babel/helper-module-imports@7.25.9': @@ -515,8 +515,8 @@ packages: peerDependencies: '@babel/core': ^7.0.0 - '@babel/helper-plugin-utils@7.25.9': - resolution: {integrity: sha512-kSMlyUVdWe25rEsRGviIgOWnoT/nfABVWlqt9N19/dIPWViAOW2s9wznP5tURbs/IDuNk4gPy3YdYRgH3uxhBw==} + '@babel/helper-plugin-utils@7.26.5': + resolution: {integrity: sha512-RS+jZcRdZdRFzMyr+wcsaqOmld1/EqTghfaBGQQd/WnRdzdlvSZ//kF7U8VQTxf1ynZ4cjUcYgjVGx13ewNPMg==} engines: {node: '>=6.9.0'} '@babel/helper-string-parser@7.25.9': @@ -531,8 +531,8 @@ packages: resolution: {integrity: sha512-e/zv1co8pp55dNdEcCynfj9X7nyUKUXoUEwfXqaZt0omVOmDe9oOTdKStH4GmAw6zxMFs50ZayuMfHDKlO7Tfw==} engines: {node: '>=6.9.0'} - '@babel/helpers@7.26.0': - resolution: {integrity: sha512-tbhNuIxNcVb21pInl3ZSjksLCvgdZy9KwJ8brv993QtIVKJBBkYXz4q4ZbAv31GdnC+R90np23L5FbEBlthAEw==} + '@babel/helpers@7.26.7': + resolution: {integrity: sha512-8NHiL98vsi0mbPQmYAGWwfcFaOy4j2HY49fXJCfuDcdE7fMIsH9a7GdaeXpIBsbT7307WU8KCMp5pUVDNL4f9A==} engines: {node: '>=6.9.0'} '@babel/parser@7.26.3': @@ -540,6 +540,11 @@ packages: engines: {node: '>=6.0.0'} hasBin: true + '@babel/parser@7.26.7': + resolution: {integrity: sha512-kEvgGGgEjRUutvdVvZhbn/BxVt+5VSpwXz1j3WYXQbXDo8KzFOPNG2GQbdAiNq8g6wn1yKk7C/qrke03a84V+w==} + engines: {node: '>=6.0.0'} + hasBin: true + '@babel/plugin-transform-react-jsx-self@7.25.9': resolution: {integrity: sha512-y8quW6p0WHkEhmErnfe58r7x0A70uKphQm8Sp8cV7tjNQwK56sNVK0M73LK3WuYmsuyrftut4xAkjjgU0twaMg==} engines: {node: '>=6.9.0'} @@ -552,22 +557,26 @@ packages: peerDependencies: '@babel/core': ^7.0.0-0 - '@babel/runtime@7.26.0': - resolution: {integrity: sha512-FDSOghenHTiToteC/QRlv2q3DhPZ/oOXTBoirfWNx1Cx3TMVcGWQtMMmQcSvb/JjpNeGzx8Pq/b4fKEJuWm1sw==} + '@babel/runtime@7.26.7': + resolution: {integrity: sha512-AOPI3D+a8dXnja+iwsUqGRjr1BbZIe771sXdapOtYI531gSqpi92vXivKcq2asu/DFpdl1ceFAKZyRzK2PCVcQ==} engines: {node: '>=6.9.0'} '@babel/template@7.25.9': resolution: {integrity: sha512-9DGttpmPvIxBb/2uwpVo3dqJ+O6RooAFOS+lB+xDqoE2PVCE8nfoHMdZLpfCQRLwvohzXISPZcgxt80xLfsuwg==} engines: {node: '>=6.9.0'} - '@babel/traverse@7.26.4': - resolution: {integrity: sha512-fH+b7Y4p3yqvApJALCPJcwb0/XaOSgtK4pzV6WVjPR5GLFQBRI7pfoX2V2iM48NXvX07NUxxm1Vw98YjqTcU5w==} + '@babel/traverse@7.26.7': + resolution: {integrity: sha512-1x1sgeyRLC3r5fQOM0/xtQKsYjyxmFjaOrLJNtZ81inNjyJHGIolTULPiSc/2qe1/qfpFLisLQYFnnZl7QoedA==} engines: {node: '>=6.9.0'} '@babel/types@7.26.3': resolution: {integrity: sha512-vN5p+1kl59GVKMvTHt55NzzmYVxprfJD+ql7U9NFIfKCBkYE55LYtS+WtPlaYOyzydrKI8Nezd+aZextrd+FMA==} engines: {node: '>=6.9.0'} + '@babel/types@7.26.7': + resolution: {integrity: sha512-t8kDRGrKXyp6+tjUh7hw2RLyclsW4TRoRvRHtSyAX9Bb5ldlFh+90YAYY6awRXrlB4G5G2izNeGySpATlFzmOg==} + engines: {node: '>=6.9.0'} + '@bcoe/v8-coverage@0.2.3': resolution: {integrity: sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==} @@ -639,8 +648,8 @@ packages: '@bundled-es-modules/tough-cookie@0.1.6': resolution: {integrity: sha512-dvMHbL464C0zI+Yqxbz6kZ5TOEp7GLW+pry/RWndAR8MJQAXZ2rPmIs8tziTZjeIyhSNZgZbCePtfSbdWqStJw==} - '@changesets/apply-release-plan@7.0.7': - resolution: {integrity: sha512-qnPOcmmmnD0MfMg9DjU1/onORFyRpDXkMMl2IJg9mECY6RnxL3wN0TCCc92b2sXt1jt8DgjAUUsZYGUGTdYIXA==} + '@changesets/apply-release-plan@7.0.8': + resolution: {integrity: sha512-qjMUj4DYQ1Z6qHawsn7S71SujrExJ+nceyKKyI9iB+M5p9lCL55afuEd6uLBPRpLGWQwkwvWegDHtwHJb1UjpA==} '@changesets/assemble-release-plan@6.0.5': resolution: {integrity: sha512-IgvBWLNKZd6k4t72MBTBK3nkygi0j3t3zdC1zrfusYo0KpdsvnDjrMM9vPnTCLCMlfNs55jRL4gIMybxa64FCQ==} @@ -651,8 +660,8 @@ packages: '@changesets/changelog-github@0.5.0': resolution: {integrity: sha512-zoeq2LJJVcPJcIotHRJEEA2qCqX0AQIeFE+L21L8sRLPVqDhSXY8ZWAt2sohtBpFZkBwu+LUwMSKRr2lMy3LJA==} - '@changesets/cli@2.27.11': - resolution: {integrity: sha512-1QislpE+nvJgSZZo9+Lj3Lno5pKBgN46dAV8IVxKJy9wX8AOrs9nn5pYVZuDpoxWJJCALmbfOsHkyxujgetQSg==} + '@changesets/cli@2.27.12': + resolution: {integrity: sha512-9o3fOfHYOvBnyEn0mcahB7wzaA3P4bGJf8PNqGit5PKaMEFdsRixik+txkrJWd2VX+O6wRFXpxQL8j/1ANKE9g==} hasBin: true '@changesets/config@3.0.5': @@ -1018,17 +1027,17 @@ packages: cpu: [x64] os: [win32] - '@floating-ui/core@1.6.8': - resolution: {integrity: sha512-7XJ9cPU+yI2QeLS+FCSlqNFZJq8arvswefkZrYI1yQBbftw6FyrZOxYSh+9S7z7TpeWlRt9zJ5IhM1WIL334jA==} + '@floating-ui/core@1.6.9': + resolution: {integrity: sha512-uMXCuQ3BItDUbAMhIXw7UPXRfAlOAvZzdK9BWpE60MCn+Svt3aLn9jsPTi/WNGlRUu2uI0v5S7JiIUsbsvh3fw==} '@floating-ui/dom@1.1.1': resolution: {integrity: sha512-TpIO93+DIujg3g7SykEAGZMDtbJRrmnYRCNYSjJlvIbGhBjRSNTLVbNeDQBrzy9qDgUbiWdc7KA0uZHZ2tJmiw==} - '@floating-ui/utils@0.2.8': - resolution: {integrity: sha512-kym7SodPp8/wloecOpcmSnWJsK7M0E5Wg8UcFA+uO4B9s5d0ywXOEro/8HM9x0rW+TljRzul/14UYz3TleT3ig==} + '@floating-ui/utils@0.2.9': + resolution: {integrity: sha512-MDWhGtE+eHw5JW7lq4qhc5yRLS11ERl1c7Z6Xd0a58DozHES6EnNNwUWbMiG4J9Cgj053Bhk8zvlhFYKVhULwg==} - '@iconify-json/simple-icons@1.2.18': - resolution: {integrity: sha512-ae4ig7fxNXME1wl5og7Ocp82TM4jyz6IsOyI8GrteSbvHR9gaPu2Z01Amn5V/xo1Y7A7/+EH/3Ovpy2az/gYbg==} + '@iconify-json/simple-icons@1.2.21': + resolution: {integrity: sha512-aqbIuVshMZ2fNEhm25//9DoKudboXF3CpoEQJJlHl9gVSVNOTr4cgaCIZvgSEYmys2HHEfmhcpoZIhoEFZS8SQ==} '@iconify/types@2.0.0': resolution: {integrity: sha512-+wluvCrRhXrhyOmRDJ3q8mux9JkKy5SJ/v8ol2tu4FVjyYvtEzkc/3pK15ET6RKg4b4w4BmTk1+gsCUhf21Ykg==} @@ -1138,14 +1147,14 @@ packages: cpu: [x64] os: [win32] - '@inquirer/confirm@5.1.1': - resolution: {integrity: sha512-vVLSbGci+IKQvDOtzpPTCOiEJCNidHcAq9JYVoWTW0svb5FiwSLotkM+JXNXejfjnzVYV9n0DTBythl9+XgTxg==} + '@inquirer/confirm@5.1.3': + resolution: {integrity: sha512-fuF9laMmHoOgWapF9h9hv6opA5WvmGFHsTYGCmuFxcghIhEhb3dN0CdQR4BUMqa2H506NCj8cGX4jwMsE4t6dA==} engines: {node: '>=18'} peerDependencies: '@types/node': '>=18' - '@inquirer/core@10.1.2': - resolution: {integrity: sha512-bHd96F3ezHg1mf/J0Rb4CV8ndCN0v28kUlrHqP7+ECm1C/A+paB7Xh2lbMk6x+kweQC+rZOxM/YeKikzxco8bQ==} + '@inquirer/core@10.1.4': + resolution: {integrity: sha512-5y4/PUJVnRb4bwWY67KLdebWOhOc7xj5IP2J80oWXa64mVag24rwQ1VAdnj7/eDY/odhguW0zQ1Mp1pj6fO/2w==} engines: {node: '>=18'} '@inquirer/figures@1.0.9': @@ -1193,8 +1202,8 @@ packages: '@manypkg/get-packages@1.1.3': resolution: {integrity: sha512-fo+QhuU3qE/2TQMQmbVMqaQ6EWbMhi4ABWP+O4AM1NqPBuy0OrApV5LO6BrrgnhtAHS2NH6RrVk9OL181tTi8A==} - '@mswjs/interceptors@0.37.4': - resolution: {integrity: sha512-YUenGsnvhhuBkabJZrga8dv/8QFRBe/isTb5CYvmzaI/IISLIkKp8kItSu9URY9tsJLvkPkq2W48OU/piDvfnA==} + '@mswjs/interceptors@0.37.5': + resolution: {integrity: sha512-AAwRb5vXFcY4L+FvZ7LZusDuZ0vEe0Zm8ohn1FM6/X7A3bj4mqmkAcGRWuvC2JwSygNwHAAmMnAI73vPHeqsHA==} engines: {node: '>=18'} '@next/env@15.1.2': @@ -1273,8 +1282,8 @@ packages: resolution: {integrity: sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==} engines: {node: '>=14'} - '@playwright/test@1.49.1': - resolution: {integrity: sha512-Ky+BVzPz8pL6PQxHqNRW1k3mIyv933LML7HktS8uik0bUXNCdPhoS/kLihiO1tMf/egaJb4IutXd7UywvXEW+g==} + '@playwright/test@1.50.0': + resolution: {integrity: sha512-ZGNXbt+d65EGjBORQHuYKj+XhCewlwpnSd/EDuLPZGSiEWmgOJB5RmMCCYGy5aMfTs9wx61RivfDKi8H/hcMvw==} engines: {node: '>=18'} hasBin: true @@ -1284,11 +1293,11 @@ packages: '@redocly/ajv@8.11.2': resolution: {integrity: sha512-io1JpnwtIcvojV7QKDUSIuMN/ikdOUd1ReEnUnMKGfDVridQZ31J0MmIuqwuRjWDZfmvr+Q0MqCcfHM2gTivOg==} - '@redocly/config@0.17.1': - resolution: {integrity: sha512-CEmvaJuG7pm2ylQg53emPmtgm4nW2nxBgwXzbVEHpGas/lGnMyN8Zlkgiz6rPw0unASg6VW3wlz27SOL5XFHYQ==} + '@redocly/config@0.20.2': + resolution: {integrity: sha512-b9sP9IOV0AW6ZZGh+fgffhU9xvMRSvVodPLWzoW1GvoxhUja3ZbPOCrI54VBowPocZ+9a7pIqNt0Ge32Sh34pA==} - '@redocly/openapi-core@1.27.0': - resolution: {integrity: sha512-C3EU9NYbo7bCc9SduHrk6/liUuuBqVfJHOhfbscNCR1443Rdpz3s+bB2Xhso9mdQJT0JjklRn2WTANjavl2Zng==} + '@redocly/openapi-core@1.27.2': + resolution: {integrity: sha512-qVrDc27DHpeO2NRCMeRdb4299nijKQE3BY0wrA+WUHlOLScorIi/y7JzammLk22IaTvjR9Mv9aTAdjE1aUwJnA==} engines: {node: '>=14.19.0', npm: '>=7.0.0'} '@rollup/pluginutils@5.1.4': @@ -1305,122 +1314,235 @@ packages: cpu: [arm] os: [android] + '@rollup/rollup-android-arm-eabi@4.32.0': + resolution: {integrity: sha512-G2fUQQANtBPsNwiVFg4zKiPQyjVKZCUdQUol53R8E71J7AsheRMV/Yv/nB8giOcOVqP7//eB5xPqieBYZe9bGg==} + cpu: [arm] + os: [android] + '@rollup/rollup-android-arm64@4.29.1': resolution: {integrity: sha512-CaRfrV0cd+NIIcVVN/jx+hVLN+VRqnuzLRmfmlzpOzB87ajixsN/+9L5xNmkaUUvEbI5BmIKS+XTwXsHEb65Ew==} cpu: [arm64] os: [android] + '@rollup/rollup-android-arm64@4.32.0': + resolution: {integrity: sha512-qhFwQ+ljoymC+j5lXRv8DlaJYY/+8vyvYmVx074zrLsu5ZGWYsJNLjPPVJJjhZQpyAKUGPydOq9hRLLNvh1s3A==} + cpu: [arm64] + os: [android] + '@rollup/rollup-darwin-arm64@4.29.1': resolution: {integrity: sha512-2ORr7T31Y0Mnk6qNuwtyNmy14MunTAMx06VAPI6/Ju52W10zk1i7i5U3vlDRWjhOI5quBcrvhkCHyF76bI7kEw==} cpu: [arm64] os: [darwin] + '@rollup/rollup-darwin-arm64@4.32.0': + resolution: {integrity: sha512-44n/X3lAlWsEY6vF8CzgCx+LQaoqWGN7TzUfbJDiTIOjJm4+L2Yq+r5a8ytQRGyPqgJDs3Rgyo8eVL7n9iW6AQ==} + cpu: [arm64] + os: [darwin] + '@rollup/rollup-darwin-x64@4.29.1': resolution: {integrity: sha512-j/Ej1oanzPjmN0tirRd5K2/nncAhS9W6ICzgxV+9Y5ZsP0hiGhHJXZ2JQ53iSSjj8m6cRY6oB1GMzNn2EUt6Ng==} cpu: [x64] os: [darwin] + '@rollup/rollup-darwin-x64@4.32.0': + resolution: {integrity: sha512-F9ct0+ZX5Np6+ZDztxiGCIvlCaW87HBdHcozUfsHnj1WCUTBUubAoanhHUfnUHZABlElyRikI0mgcw/qdEm2VQ==} + cpu: [x64] + os: [darwin] + '@rollup/rollup-freebsd-arm64@4.29.1': resolution: {integrity: sha512-91C//G6Dm/cv724tpt7nTyP+JdN12iqeXGFM1SqnljCmi5yTXriH7B1r8AD9dAZByHpKAumqP1Qy2vVNIdLZqw==} cpu: [arm64] os: [freebsd] + '@rollup/rollup-freebsd-arm64@4.32.0': + resolution: {integrity: sha512-JpsGxLBB2EFXBsTLHfkZDsXSpSmKD3VxXCgBQtlPcuAqB8TlqtLcbeMhxXQkCDv1avgwNjF8uEIbq5p+Cee0PA==} + cpu: [arm64] + os: [freebsd] + '@rollup/rollup-freebsd-x64@4.29.1': resolution: {integrity: sha512-hEioiEQ9Dec2nIRoeHUP6hr1PSkXzQaCUyqBDQ9I9ik4gCXQZjJMIVzoNLBRGet+hIUb3CISMh9KXuCcWVW/8w==} cpu: [x64] os: [freebsd] + '@rollup/rollup-freebsd-x64@4.32.0': + resolution: {integrity: sha512-wegiyBT6rawdpvnD9lmbOpx5Sph+yVZKHbhnSP9MqUEDX08G4UzMU+D87jrazGE7lRSyTRs6NEYHtzfkJ3FjjQ==} + cpu: [x64] + os: [freebsd] + '@rollup/rollup-linux-arm-gnueabihf@4.29.1': resolution: {integrity: sha512-Py5vFd5HWYN9zxBv3WMrLAXY3yYJ6Q/aVERoeUFwiDGiMOWsMs7FokXihSOaT/PMWUty/Pj60XDQndK3eAfE6A==} cpu: [arm] os: [linux] + '@rollup/rollup-linux-arm-gnueabihf@4.32.0': + resolution: {integrity: sha512-3pA7xecItbgOs1A5H58dDvOUEboG5UfpTq3WzAdF54acBbUM+olDJAPkgj1GRJ4ZqE12DZ9/hNS2QZk166v92A==} + cpu: [arm] + os: [linux] + '@rollup/rollup-linux-arm-musleabihf@4.29.1': resolution: {integrity: sha512-RiWpGgbayf7LUcuSNIbahr0ys2YnEERD4gYdISA06wa0i8RALrnzflh9Wxii7zQJEB2/Eh74dX4y/sHKLWp5uQ==} cpu: [arm] os: [linux] + '@rollup/rollup-linux-arm-musleabihf@4.32.0': + resolution: {integrity: sha512-Y7XUZEVISGyge51QbYyYAEHwpGgmRrAxQXO3siyYo2kmaj72USSG8LtlQQgAtlGfxYiOwu+2BdbPjzEpcOpRmQ==} + cpu: [arm] + os: [linux] + '@rollup/rollup-linux-arm64-gnu@4.29.1': resolution: {integrity: sha512-Z80O+taYxTQITWMjm/YqNoe9d10OX6kDh8X5/rFCMuPqsKsSyDilvfg+vd3iXIqtfmp+cnfL1UrYirkaF8SBZA==} cpu: [arm64] os: [linux] + '@rollup/rollup-linux-arm64-gnu@4.32.0': + resolution: {integrity: sha512-r7/OTF5MqeBrZo5omPXcTnjvv1GsrdH8a8RerARvDFiDwFpDVDnJyByYM/nX+mvks8XXsgPUxkwe/ltaX2VH7w==} + cpu: [arm64] + os: [linux] + '@rollup/rollup-linux-arm64-musl@4.29.1': resolution: {integrity: sha512-fOHRtF9gahwJk3QVp01a/GqS4hBEZCV1oKglVVq13kcK3NeVlS4BwIFzOHDbmKzt3i0OuHG4zfRP0YoG5OF/rA==} cpu: [arm64] os: [linux] + '@rollup/rollup-linux-arm64-musl@4.32.0': + resolution: {integrity: sha512-HJbifC9vex9NqnlodV2BHVFNuzKL5OnsV2dvTw6e1dpZKkNjPG6WUq+nhEYV6Hv2Bv++BXkwcyoGlXnPrjAKXw==} + cpu: [arm64] + os: [linux] + '@rollup/rollup-linux-loongarch64-gnu@4.29.1': resolution: {integrity: sha512-5a7q3tnlbcg0OodyxcAdrrCxFi0DgXJSoOuidFUzHZ2GixZXQs6Tc3CHmlvqKAmOs5eRde+JJxeIf9DonkmYkw==} cpu: [loong64] os: [linux] + '@rollup/rollup-linux-loongarch64-gnu@4.32.0': + resolution: {integrity: sha512-VAEzZTD63YglFlWwRj3taofmkV1V3xhebDXffon7msNz4b14xKsz7utO6F8F4cqt8K/ktTl9rm88yryvDpsfOw==} + cpu: [loong64] + os: [linux] + '@rollup/rollup-linux-powerpc64le-gnu@4.29.1': resolution: {integrity: sha512-9b4Mg5Yfz6mRnlSPIdROcfw1BU22FQxmfjlp/CShWwO3LilKQuMISMTtAu/bxmmrE6A902W2cZJuzx8+gJ8e9w==} cpu: [ppc64] os: [linux] + '@rollup/rollup-linux-powerpc64le-gnu@4.32.0': + resolution: {integrity: sha512-Sts5DST1jXAc9YH/iik1C9QRsLcCoOScf3dfbY5i4kH9RJpKxiTBXqm7qU5O6zTXBTEZry69bGszr3SMgYmMcQ==} + cpu: [ppc64] + os: [linux] + '@rollup/rollup-linux-riscv64-gnu@4.29.1': resolution: {integrity: sha512-G5pn0NChlbRM8OJWpJFMX4/i8OEU538uiSv0P6roZcbpe/WfhEO+AT8SHVKfp8qhDQzaz7Q+1/ixMy7hBRidnQ==} cpu: [riscv64] os: [linux] + '@rollup/rollup-linux-riscv64-gnu@4.32.0': + resolution: {integrity: sha512-qhlXeV9AqxIyY9/R1h1hBD6eMvQCO34ZmdYvry/K+/MBs6d1nRFLm6BOiITLVI+nFAAB9kUB6sdJRKyVHXnqZw==} + cpu: [riscv64] + os: [linux] + '@rollup/rollup-linux-s390x-gnu@4.29.1': resolution: {integrity: sha512-WM9lIkNdkhVwiArmLxFXpWndFGuOka4oJOZh8EP3Vb8q5lzdSCBuhjavJsw68Q9AKDGeOOIHYzYm4ZFvmWez5g==} cpu: [s390x] os: [linux] + '@rollup/rollup-linux-s390x-gnu@4.32.0': + resolution: {integrity: sha512-8ZGN7ExnV0qjXa155Rsfi6H8M4iBBwNLBM9lcVS+4NcSzOFaNqmt7djlox8pN1lWrRPMRRQ8NeDlozIGx3Omsw==} + cpu: [s390x] + os: [linux] + '@rollup/rollup-linux-x64-gnu@4.29.1': resolution: {integrity: sha512-87xYCwb0cPGZFoGiErT1eDcssByaLX4fc0z2nRM6eMtV9njAfEE6OW3UniAoDhX4Iq5xQVpE6qO9aJbCFumKYQ==} cpu: [x64] os: [linux] + '@rollup/rollup-linux-x64-gnu@4.32.0': + resolution: {integrity: sha512-VDzNHtLLI5s7xd/VubyS10mq6TxvZBp+4NRWoW+Hi3tgV05RtVm4qK99+dClwTN1McA6PHwob6DEJ6PlXbY83A==} + cpu: [x64] + os: [linux] + '@rollup/rollup-linux-x64-musl@4.29.1': resolution: {integrity: sha512-xufkSNppNOdVRCEC4WKvlR1FBDyqCSCpQeMMgv9ZyXqqtKBfkw1yfGMTUTs9Qsl6WQbJnsGboWCp7pJGkeMhKA==} cpu: [x64] os: [linux] + '@rollup/rollup-linux-x64-musl@4.32.0': + resolution: {integrity: sha512-qcb9qYDlkxz9DxJo7SDhWxTWV1gFuwznjbTiov289pASxlfGbaOD54mgbs9+z94VwrXtKTu+2RqwlSTbiOqxGg==} + cpu: [x64] + os: [linux] + '@rollup/rollup-win32-arm64-msvc@4.29.1': resolution: {integrity: sha512-F2OiJ42m77lSkizZQLuC+jiZ2cgueWQL5YC9tjo3AgaEw+KJmVxHGSyQfDUoYR9cci0lAywv2Clmckzulcq6ig==} cpu: [arm64] os: [win32] + '@rollup/rollup-win32-arm64-msvc@4.32.0': + resolution: {integrity: sha512-pFDdotFDMXW2AXVbfdUEfidPAk/OtwE/Hd4eYMTNVVaCQ6Yl8et0meDaKNL63L44Haxv4UExpv9ydSf3aSayDg==} + cpu: [arm64] + os: [win32] + '@rollup/rollup-win32-ia32-msvc@4.29.1': resolution: {integrity: sha512-rYRe5S0FcjlOBZQHgbTKNrqxCBUmgDJem/VQTCcTnA2KCabYSWQDrytOzX7avb79cAAweNmMUb/Zw18RNd4mng==} cpu: [ia32] os: [win32] + '@rollup/rollup-win32-ia32-msvc@4.32.0': + resolution: {integrity: sha512-/TG7WfrCAjeRNDvI4+0AAMoHxea/USWhAzf9PVDFHbcqrQ7hMMKp4jZIy4VEjk72AAfN5k4TiSMRXRKf/0akSw==} + cpu: [ia32] + os: [win32] + '@rollup/rollup-win32-x64-msvc@4.29.1': resolution: {integrity: sha512-+10CMg9vt1MoHj6x1pxyjPSMjHTIlqs8/tBztXvPAx24SKs9jwVnKqHJumlH/IzhaPUaj3T6T6wfZr8okdXaIg==} cpu: [x64] os: [win32] - '@shikijs/core@1.26.1': - resolution: {integrity: sha512-yeo7sG+WZQblKPclUOKRPwkv1PyoHYkJ4gP9DzhFJbTdueKR7wYTI1vfF/bFi1NTgc545yG/DzvVhZgueVOXMA==} + '@rollup/rollup-win32-x64-msvc@4.32.0': + resolution: {integrity: sha512-5hqO5S3PTEO2E5VjCePxv40gIgyS2KvO7E7/vvC/NbIW4SIRamkMr1hqj+5Y67fbBWv/bQLB6KelBQmXlyCjWA==} + cpu: [x64] + os: [win32] + + '@shikijs/core@1.29.1': + resolution: {integrity: sha512-Mo1gGGkuOYjDu5H8YwzmOuly9vNr8KDVkqj9xiKhhhFS8jisAtDSEWB9hzqRHLVQgFdA310e8XRJcW4tYhRB2A==} + + '@shikijs/core@2.1.0': + resolution: {integrity: sha512-v795KDmvs+4oV0XD05YLzfDMe9ISBgNjtFxP4PAEv5DqyeghO1/TwDqs9ca5/E6fuO95IcAcWqR6cCX9TnqLZA==} + + '@shikijs/engine-javascript@1.29.1': + resolution: {integrity: sha512-Hpi8k9x77rCQ7F/7zxIOUruNkNidMyBnP5qAGbLFqg4kRrg1HZhkB8btib5EXbQWTtLb5gBHOdBwshk20njD7Q==} + + '@shikijs/engine-javascript@2.1.0': + resolution: {integrity: sha512-cgIUdAliOsoaa0rJz/z+jvhrpRd+fVAoixVFEVxUq5FA+tHgBZAIfVJSgJNVRj2hs/wZ1+4hMe82eKAThVh0nQ==} + + '@shikijs/engine-oniguruma@1.29.1': + resolution: {integrity: sha512-gSt2WhLNgEeLstcweQOSp+C+MhOpTsgdNXRqr3zP6M+BUBZ8Md9OU2BYwUYsALBxHza7hwaIWtFHjQ/aOOychw==} + + '@shikijs/engine-oniguruma@2.1.0': + resolution: {integrity: sha512-Ujik33wEDqgqY2WpjRDUBECGcKPv3eGGkoXPujIXvokLaRmGky8NisSk8lHUGeSFxo/Cz5sgFej9sJmA9yeepg==} + + '@shikijs/langs@1.29.1': + resolution: {integrity: sha512-iERn4HlyuT044/FgrvLOaZgKVKf3PozjKjyV/RZ5GnlyYEAZFcgwHGkYboeBv2IybQG1KVS/e7VGgiAU4JY2Gw==} - '@shikijs/engine-javascript@1.26.1': - resolution: {integrity: sha512-CRhA0b8CaSLxS0E9A4Bzcb3LKBNpykfo9F85ozlNyArxjo2NkijtiwrJZ6eHa+NT5I9Kox2IXVdjUsP4dilsmw==} + '@shikijs/langs@2.1.0': + resolution: {integrity: sha512-Jn0gS4rPgerMDPj1ydjgFzZr5fAIoMYz4k7ZT3LJxWWBWA6lokK0pumUwVtb+MzXtlpjxOaQejLprmLbvMZyww==} - '@shikijs/engine-oniguruma@1.26.1': - resolution: {integrity: sha512-F5XuxN1HljLuvfXv7d+mlTkV7XukC1cawdtOo+7pKgPD83CAB1Sf8uHqP3PK0u7njFH0ZhoXE1r+0JzEgAQ+kg==} + '@shikijs/themes@1.29.1': + resolution: {integrity: sha512-lb11zf72Vc9uxkl+aec2oW1HVTHJ2LtgZgumb4Rr6By3y/96VmlU44bkxEb8WBWH3RUtbqAJEN0jljD9cF7H7g==} - '@shikijs/langs@1.26.1': - resolution: {integrity: sha512-oz/TQiIqZejEIZbGtn68hbJijAOTtYH4TMMSWkWYozwqdpKR3EXgILneQy26WItmJjp3xVspHdiUxUCws4gtuw==} + '@shikijs/themes@2.1.0': + resolution: {integrity: sha512-oS2mU6+bz+8TKutsjBxBA7Z3vrQk21RCmADLpnu8cy3tZD6Rw0FKqDyXNtwX52BuIDKHxZNmRlTdG3vtcYv3NQ==} - '@shikijs/themes@1.26.1': - resolution: {integrity: sha512-JDxVn+z+wgLCiUhBGx2OQrLCkKZQGzNH3nAxFir4PjUcYiyD8Jdms9izyxIogYmSwmoPTatFTdzyrRKbKlSfPA==} + '@shikijs/transformers@2.1.0': + resolution: {integrity: sha512-3sfvh6OKUVkT5wZFU1xxiq1qqNIuCwUY3yOb9ZGm19y80UZ/eoroLE2orGNzfivyTxR93GfXXZC/ghPR0/SBow==} - '@shikijs/transformers@1.26.1': - resolution: {integrity: sha512-IRLJEP7YxkRMsHo367+7qDlpWjsUu6O79pdlUlkcbF1A5TrF1Ln0FBNrgHA/i9p+IKXiiKNATURa6WXh3iq7Uw==} + '@shikijs/twoslash@2.1.0': + resolution: {integrity: sha512-tgZEk78/g1ceC/mS3xA50aIc2rArl+oiphZEdAXaoioLVNebDChhV93NzcXu4NAq4pCogfBbD5HV8qO38+fQyQ==} - '@shikijs/twoslash@1.26.1': - resolution: {integrity: sha512-jgRt6c6y+rXVfpcLIAY8luCKDiadhozrLS1+xjXA6WcZ/5wCAB2oj+ubue+14UZkg2yLJaH0X7N8N2J7/X1YJQ==} + '@shikijs/types@1.29.1': + resolution: {integrity: sha512-aBqAuhYRp5vSir3Pc9+QPu9WESBOjUo03ao0IHLC4TyTioSsp/SkbAZSrIH4ghYYC1T1KTEpRSBa83bas4RnPA==} - '@shikijs/types@1.26.1': - resolution: {integrity: sha512-d4B00TKKAMaHuFYgRf3L0gwtvqpW4hVdVwKcZYbBfAAQXspgkbWqnFfuFl3MDH6gLbsubOcr+prcnsqah3ny7Q==} + '@shikijs/types@2.1.0': + resolution: {integrity: sha512-OFOdHA6VEVbiQvepJ8yqicC6VmBrKxFFhM2EsHHrZESqLVAXOSeRDiuSYV185lIgp15TVic5vYBYNhTsk1xHLg==} - '@shikijs/vitepress-twoslash@1.26.1': - resolution: {integrity: sha512-doNqlJ+oOkC98cgiJSFJ3T/RZMBTiutQ3xw8EB8Xr6Qbk1/5Tfg+eOpI/2h2HTHdEafC2jzkgWK/l7Te1u5aWA==} + '@shikijs/vitepress-twoslash@1.29.1': + resolution: {integrity: sha512-X3xSyWZhjYSOJFotI2yzXwtNl6DMAL64cCE+Morj5Bab85oNtYoOhVsl0mBEaer9Pjfeydja+h/yEq2/2bXA3g==} '@shikijs/vscode-textmate@10.0.1': resolution: {integrity: sha512-fTIQwLF+Qhuws31iw7Ncl1R3HUDtGwIipiJ9iU+UsDUwMhegFcQKQHd51nZjb7CArq0MvON8rbgCGQYWHUKAdg==} @@ -1451,8 +1573,8 @@ packages: peerDependencies: '@sveltejs/kit': ^2.0.0 - '@sveltejs/kit@2.15.1': - resolution: {integrity: sha512-8t7D3hQHbUDMiaQ2RVnjJJ/+Ur4Fn/tkeySJCsHtX346Q9cp3LAnav8xXdfuqYNJwpUGX0x3BqF1uvbmXQw93A==} + '@sveltejs/kit@2.16.1': + resolution: {integrity: sha512-2pF5sgGJx9brYZ/9nNDYnh5KX0JguPF14dnvvtf/MqrvlWrDj/e7Rk3LBJPecFLLK1GRs6ZniD24gFPqZm/NFw==} engines: {node: '>=18.13'} hasBin: true peerDependencies: @@ -1553,11 +1675,11 @@ packages: '@swc/types@0.1.17': resolution: {integrity: sha512-V5gRru+aD8YVyCOMAjMpWR1Ui577DD5KSJsHP8RAxopAH22jFz6GZd/qxqjO6MJHQhcsjvjOFXyDhyLQUnMveQ==} - '@tanstack/query-core@5.62.12': - resolution: {integrity: sha512-6igFeBgymHkCxVgaEk+yiLwkMf9haui/EQLmI3o9CatOyDThEoFKe8toLWvWliZC/Jf+h7NwHi/zjfyLArr1ow==} + '@tanstack/query-core@5.64.2': + resolution: {integrity: sha512-hdO8SZpWXoADNTWXV9We8CwTkXU88OVWRBcsiFrk7xJQnhm6WRlweDzMD+uH+GnuieTBVSML6xFa17C2cNV8+g==} - '@tanstack/react-query@5.62.14': - resolution: {integrity: sha512-ev/6eVdJvX9vpomKmFuXsrQb6TwqqBn/7OeB0KZkHjEYk/Bo1XBMj8wRmobn8pqdU8lK271tUjt+0B0UQ9MZ6A==} + '@tanstack/react-query@5.64.2': + resolution: {integrity: sha512-3pakNscZNm8KJkxmovvtZ4RaXLyiYYobwleTMvpIGUoKRa8j8VlrQKNl5W8VUEfVfZKkikvXVddLuWMbcSCA1Q==} peerDependencies: react: ^18 || ^19 @@ -1565,8 +1687,8 @@ packages: resolution: {integrity: sha512-wdsYKy5zupPyLCW2Je5DLHSxSfbIp6h80WoHOQc+RPtmPGA52O9x5MJEkv92Sjonpq+poOAtUKhh1kBGAXBrNA==} engines: {node: '>=18'} - '@testing-library/react@16.1.0': - resolution: {integrity: sha512-Q2ToPvg0KsVL0ohND9A3zLJWcOXXcO8IDu3fj11KhNt0UlCWyFyvnCIBkd12tidB2lkiVRG8VFqdhcqhqnAQtg==} + '@testing-library/react@16.2.0': + resolution: {integrity: sha512-2cSskAvA1QNtKc8Y9VJQRv0tm3hLVgxRGDB+KYhIaPQJ1I+RHbhIXcM+zClKXzMes/wshsMVzf4B9vS4IZpqDQ==} engines: {node: '>=18'} peerDependencies: '@testing-library/dom': ^10.0.0 @@ -1641,12 +1763,15 @@ packages: '@types/minimist@1.2.5': resolution: {integrity: sha512-hov8bUuiLiyFPGyFPE1lwWhmzYbirOXQNNo40+y3zow8aFVTeyn3VWL0VFFfdNddA8S4Vf0Tc062rzyNr7Paag==} - '@types/ms@0.7.34': - resolution: {integrity: sha512-nG96G3Wp6acyAgJqGasjODb+acrI7KltPiRxzHPXnP3NgI28bpQDRv53olbqGXbfcgF5aiiHmO3xpwEpS5Ld9g==} + '@types/ms@2.1.0': + resolution: {integrity: sha512-GsCCIZDE/p3i96vtEqx+7dBUGXrc7zeSK3wwPHIaRThS+9OhWIXRqzs4d6k1SVU8g91DrNRWxWUGhp5KXQb2VA==} '@types/node@12.20.55': resolution: {integrity: sha512-J8xLz7q2OFulZ2cyGTLE1TbbZcjpno7FaN6zdJNrgAdrJ+DZzh/uFR6YrTb4C+nXakvud8Q4+rbhoIWlYQbUFQ==} + '@types/node@22.10.10': + resolution: {integrity: sha512-X47y/mPNzxviAGY5TcYPtYL8JsY3kAq2n8fMmKoRCxq/c4v4pyGNCzM2R6+M5/umG4ZfHuT+sgqDYqWc9rJ6ww==} + '@types/node@22.10.5': resolution: {integrity: sha512-F8Q+SeGimwOo86fiovQh8qiXfFEh2/ocYv7tU5pJ3EXMSSxk1Joj5wefpFK2fHTf/N6HKGSxIDBT9f3gCxXPkQ==} @@ -1687,8 +1812,8 @@ packages: peerDependencies: typescript: '*' - '@ungap/structured-clone@1.2.1': - resolution: {integrity: sha512-fEzPV3hSkSMltkw152tJKNARhOupqbH96MZWyRjNaYZOMIzbrTeQDG+MTc6Mr2pgzFQzFxAfmhGDNP5QK++2ZA==} + '@ungap/structured-clone@1.3.0': + resolution: {integrity: sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==} '@vitejs/plugin-react@4.3.4': resolution: {integrity: sha512-SCCPBJtYLdE8PX/7ZQAs1QAZ8Jqwih+0VBLum1EGqmCCQal+MIUqLCzj3ZUy8ufbC0cAM4LRlSTm7IQJwWT4ug==} @@ -1765,14 +1890,14 @@ packages: '@vue/compiler-vue2@2.7.16': resolution: {integrity: sha512-qYC3Psj9S/mfu9uVi5WvNZIzq+xnXMhOwbTFKKDD7b1lhpnn71jXSFdTQ+WsIEk0ONCd7VV2IMm7ONl6tbQ86A==} - '@vue/devtools-api@7.6.8': - resolution: {integrity: sha512-ma6dY/sZR36zALVsV1W7eC57c6IJPXsy8SNgZn1PLVWU4z4dPn5TIBmnF4stmdJ4sQcixqKaQ8pwjbMPzEZwiA==} + '@vue/devtools-api@7.7.1': + resolution: {integrity: sha512-Cexc8GimowoDkJ6eNelOPdYIzsu2mgNyp0scOQ3tiaYSb9iok6LOESSsJvHaI+ib3joRfqRJNLkHFjhNuWA5dg==} - '@vue/devtools-kit@7.6.8': - resolution: {integrity: sha512-JhJ8M3sPU+v0P2iZBF2DkdmR9L0dnT5RXJabJqX6o8KtFs3tebdvfoXV2Dm3BFuqeECuMJIfF1aCzSt+WQ4wrw==} + '@vue/devtools-kit@7.7.1': + resolution: {integrity: sha512-yhZ4NPnK/tmxGtLNQxmll90jIIXdb2jAhPF76anvn5M/UkZCiLJy28bYgPIACKZ7FCosyKoaope89/RsFJll1w==} - '@vue/devtools-shared@7.6.8': - resolution: {integrity: sha512-9MBPO5Z3X1nYGFqTJyohl6Gmf/J7UNN1oicHdyzBVZP4jnhZ4c20MgtaHDIzWmHDHCMYVS5bwKxT3jxh7gOOKA==} + '@vue/devtools-shared@7.7.1': + resolution: {integrity: sha512-BtgF7kHq4BHG23Lezc/3W2UhK2ga7a8ohAIAGJMBr4BkxUFzhqntQtCiuL1ijo2ztWnmusymkirgqUrXoQKumA==} '@vue/language-core@2.1.10': resolution: {integrity: sha512-DAI289d0K3AB5TUG3xDp9OuQ71CnrujQwJrQnfuZDwo6eGNf0UoRlPuaVNO+Zrn65PC3j0oB2i7mNmVPggeGeQ==} @@ -1810,11 +1935,11 @@ packages: '@vue/tsconfig@0.5.1': resolution: {integrity: sha512-VcZK7MvpjuTPx2w6blwnwZAu5/LgBUtejFOi3pPGQFXQN5Ela03FUtd2Qtg4yWGGissVL0dr6Ro1LfOFh+PCuQ==} - '@vueuse/core@11.3.0': - resolution: {integrity: sha512-7OC4Rl1f9G8IT6rUfi9JrKiXy4bfmHhZ5x2Ceojy0jnd3mHNEvV4JaRygH362ror6/NZ+Nl+n13LPzGiPN8cKA==} + '@vueuse/core@12.5.0': + resolution: {integrity: sha512-GVyH1iYqNANwcahAx8JBm6awaNgvR/SwZ1fjr10b8l1HIgDp82ngNbfzJUgOgWEoxjL+URAggnlilAEXwCOZtg==} - '@vueuse/integrations@11.3.0': - resolution: {integrity: sha512-5fzRl0apQWrDezmobchoiGTkGw238VWESxZHazfhP3RM7pDSiyXy18QbfYkILoYNTd23HPAfQTJpkUc5QbkwTw==} + '@vueuse/integrations@12.5.0': + resolution: {integrity: sha512-HYLt8M6mjUfcoUOzyBcX2RjpfapIwHPBmQJtTmXOQW845Y/Osu9VuTJ5kPvnmWJ6IUa05WpblfOwZ+P0G4iZsQ==} peerDependencies: async-validator: ^4 axios: ^1 @@ -1854,11 +1979,11 @@ packages: universal-cookie: optional: true - '@vueuse/metadata@11.3.0': - resolution: {integrity: sha512-pwDnDspTqtTo2HwfLw4Rp6yywuuBdYnPYDq+mO38ZYKGebCUQC/nVj/PXSiK9HX5otxLz8Fn7ECPbjiRz2CC3g==} + '@vueuse/metadata@12.5.0': + resolution: {integrity: sha512-Ui7Lo2a7AxrMAXRF+fAp9QsXuwTeeZ8fIB9wsLHqzq9MQk+2gMYE2IGJW48VMJ8ecvCB3z3GsGLKLbSasQ5Qlg==} - '@vueuse/shared@11.3.0': - resolution: {integrity: sha512-P8gSSWQeucH5821ek2mn/ciCk+MS/zoRKqdQIM3bHq6p7GXDAJLmnRRKmF5F65sAVJIfzQlwR3aDzwCn10s8hA==} + '@vueuse/shared@12.5.0': + resolution: {integrity: sha512-vMpcL1lStUU6O+kdj6YdHDixh0odjPAUM15uJ9f7MY781jcYkIwFA4iv2EfoIPO6vBmvutI1HxxAwmf0cx5ISQ==} abab@2.0.6: resolution: {integrity: sha512-j2afSsaIENvHZN2B8GOpF566vZ5WVk5opAiMTvWgaQT8DkbOqsTfvNAvHoRGU2zzP8cPoqys+xHTRDWW8L+/BA==} @@ -1897,15 +2022,15 @@ packages: resolution: {integrity: sha512-0poP0T7el6Vq3rstR8Mn4V/IQrpBLO6POkUSrN7RhyY+GF/InCFShQzsQ39T25gkHhLgSLByyAz+Kjb+c2L98w==} engines: {node: '>=12'} - algoliasearch@5.18.0: - resolution: {integrity: sha512-/tfpK2A4FpS0o+S78o3YSdlqXr0MavJIDlFK3XZrlXLy7vaRXJvW5jYg3v5e/wCaF8y0IpMjkYLhoV6QqfpOgw==} + algoliasearch@5.20.0: + resolution: {integrity: sha512-groO71Fvi5SWpxjI9Ia+chy0QBwT61mg6yxJV27f5YFf+Mw+STT75K6SHySpP8Co5LsCrtsbCH5dJZSRtkSKaQ==} engines: {node: '>= 14.0.0'} alien-signals@0.2.2: resolution: {integrity: sha512-cZIRkbERILsBOXTQmMrxc9hgpxglstn69zm+F1ARf4aPAzdAFYd6sBq87ErO0Fj3DV94tglcyHG5kQz9nDC/8A==} - alien-signals@0.4.12: - resolution: {integrity: sha512-Og0PgAihxlp1R22bsoBsyhhMG4+qhU+fkkLPoGBQkYVc3qt9rYnrwYTf+M6kqUqUZpf3rXDnpL90iKa0QcSVVg==} + alien-signals@0.4.14: + resolution: {integrity: sha512-itUAVzhczTmP2U5yX67xVpsbbOiquusbWVyA9N+sy6+r6YVbFkahXvNCeEPWEOMhwDYwbVbGHFkVL03N9I5g+Q==} ansi-colors@4.1.3: resolution: {integrity: sha512-/6w/C21Pm1A7aZitlI5Ni/2J6FFQN8i1Cvz3kHABAAbw93v/NlvKdVOqz7CCWz/3iv/JplRSEEZ83XION15ovw==} @@ -2015,8 +2140,8 @@ packages: resolution: {integrity: sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==} engines: {node: '>=8'} - browserslist@4.24.3: - resolution: {integrity: sha512-1CPmv8iobE2fyRMV97dAcMVegvvWKxmq94hkLiAkUGwKVTyDLw33K+ZxiFrREKmmps4rIw6grcCFCnTMSZ/YiA==} + browserslist@4.24.4: + resolution: {integrity: sha512-KDi1Ny1gSePi1vm0q4oxSF8b4DR44GF4BbmS2YdhPLOEqd8pDviZOGH/GsmRwoWJ2+5Lr085X7naowMwKHDG1A==} engines: {node: ^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7} hasBin: true @@ -2065,8 +2190,8 @@ packages: resolution: {integrity: sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==} engines: {node: '>=10'} - caniuse-lite@1.0.30001690: - resolution: {integrity: sha512-5ExiE3qQN6oF8Clf8ifIDcMRCRE/dMGcETG/XGMD8/XiXm6HXQgQTh1yZYLXXpSOsEUlJm1Xr7kGULZTuGtP/w==} + caniuse-lite@1.0.30001695: + resolution: {integrity: sha512-vHyLade6wTgI2u1ec3WQBxv+2BrTERV28UXQu9LO6lZ9pYeMk34vjXFLOxo1A4UBA8XTL4njRQZdno/yYaSmWw==} ccount@2.0.1: resolution: {integrity: sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==} @@ -2319,8 +2444,8 @@ packages: resolution: {integrity: sha512-VfxadyCECXgQlkoEAjeghAr5gY3Hf+IKjKb+X8tGVDtveCjN+USwprd2q3QXBR9T1+x2DG0XZF5/w+7HAtSaXA==} engines: {node: '>=10'} - decimal.js@10.4.3: - resolution: {integrity: sha512-VBBaLc1MgL5XpzgIP7ny5Z6Nx3UrRkIViUkPUdtl9aya5amy3De1gsUUSB1g3+3sExYNjCAsAznmukyxCb1GRA==} + decimal.js@10.5.0: + resolution: {integrity: sha512-8vDa8Qxvr/+d94hSh5P3IJwI5t8/c0KsMp+g8bNw9cY2icONa5aPfvKeieW1WlG0WQYwwhJ7mjui2xtiePQSXw==} decode-named-character-reference@1.0.2: resolution: {integrity: sha512-O8x12RzrUF8xyVcY0KJowWsmaJxQbmy0/EtnNtHRpsOcT7dFk5W598coHqBVpmWo1oQQfsCqfCmkZN5DJrZVdg==} @@ -2406,8 +2531,8 @@ packages: ee-first@1.1.1: resolution: {integrity: sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==} - electron-to-chromium@1.5.76: - resolution: {integrity: sha512-CjVQyG7n7Sr+eBXE86HIulnL5N8xZY1sgmOPGuq/F0Rr0FJq63lg0kEtOIDfZBk44FnDLf6FUJ+dsJcuiUDdDQ==} + electron-to-chromium@1.5.88: + resolution: {integrity: sha512-K3C2qf1o+bGzbilTDCTBhTQcMS9KW60yTAaTeeXsfvQuTDDwlokLam/AdqlqcSy9u4UainDgsHV23ksXAOgamw==} emoji-regex-xs@1.0.0: resolution: {integrity: sha512-LRlerrMYoIDrT6jgpeZ2YYl/L8EulRTt5hQcYjy5AInh7HWXKimpqx68aknBFpGL2+/IcogTcaydJEgaTmOpDg==} @@ -2458,8 +2583,8 @@ packages: es-module-lexer@1.6.0: resolution: {integrity: sha512-qqnD1yMU6tk/jnaMosogGySTZP8YtUgAffA9nMN+E/rjxcfRQ6IEk7IiozUjgxKoFHBGjTLnrHB/YC45r/59EQ==} - es-object-atoms@1.0.0: - resolution: {integrity: sha512-MZ4iQ6JwHOBQjahnjwaC1ZtIBH+2ohjamzAO3oaHcXYup7qxjF2fixyH+Q71voWHeOkI2q/TnJao/KfXYIZWbw==} + es-object-atoms@1.1.1: + resolution: {integrity: sha512-FGgH2h8zKNim9ljj7dankFPcICIK9Cp5bm+c2gQSYePhpaG5+esrLODihIorn+Pe6FGJzWhXQotPv73jTaldXA==} engines: {node: '>= 0.4'} es6-promise@3.3.1: @@ -2491,16 +2616,16 @@ packages: engines: {node: '>=6.0'} hasBin: true - esm-env@1.2.1: - resolution: {integrity: sha512-U9JedYYjCnadUlXk7e1Kr+aENQhtUaoaV9+gZm1T8LC/YBAPJx3NSPIAurFOC0U5vrdSevnUJS2/wUVxGwPhng==} + esm-env@1.2.2: + resolution: {integrity: sha512-Epxrv+Nr/CaL4ZcFGPJIYLWFom+YeV1DqMLHJoEd9SYRxNbaFruBwfEX/kkHUJf55j2+TUbmDcmuilbP1TmXHA==} esprima@4.0.1: resolution: {integrity: sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==} engines: {node: '>=4'} hasBin: true - esrap@1.3.2: - resolution: {integrity: sha512-C4PXusxYhFT98GjLSmb20k9PREuUdporer50dhzGuJu9IJXktbMddVCMLAERl5dAHyAi73GWWCE4FVHGP1794g==} + esrap@1.4.3: + resolution: {integrity: sha512-Xddc1RsoFJ4z9nR7W7BFaEPIp4UXoeQ0+077UdWLxbafMQFyU79sQJMk7kxNgRwQ9/aVgaKacCHC2pUACGwmYw==} estraverse@5.3.0: resolution: {integrity: sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==} @@ -2549,14 +2674,18 @@ packages: resolution: {integrity: sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==} engines: {node: '>=8.6.0'} + fast-glob@3.3.3: + resolution: {integrity: sha512-7MptL8U0cqcFdzIzwOTHoilX9x5BrNqye7Z/LuC7kCMRio1EMSyqRK3BEAUD7sXRq4iT4AzTVuZdhgQ2TCvYLg==} + engines: {node: '>=8.6.0'} + fast-safe-stringify@2.1.1: resolution: {integrity: sha512-W+KJc2dmILlPplD/H4K9l9LcAHAfPtP6BY84uVLXQ6Evcz9Lcg33Y2z1IVblT6xdY54PXYVHEv+0Wpq8Io6zkA==} fastq@1.17.1: resolution: {integrity: sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==} - fdir@6.4.2: - resolution: {integrity: sha512-KnhMXsKSPZlAhp7+IjUkRZKPb4fUyccpDrdFXbi4QL1qkmFh9kVY09Yox+n4MaOb3lHZ1Tv829C3oaaXoMYPDQ==} + fdir@6.4.3: + resolution: {integrity: sha512-PMXmW2y1hDDfTSRc9gaXIuCCRpuoz3Kaz8cUelp3smouvfT632ozg2vrT6lJsHKKOF59YLbOGfAWGUcKEfRMQw==} peerDependencies: picomatch: ^3 || ^4 peerDependenciesMeta: @@ -2594,8 +2723,8 @@ packages: '@nuxt/kit': optional: true - focus-trap@7.6.2: - resolution: {integrity: sha512-9FhUxK1hVju2+AiQIDJ5Dd//9R2n2RAfJ0qfhF4IHGHgcoEUTMpbTeG/zbEuwaiYXfuAH6XE0/aCyxDdRM+W5w==} + focus-trap@7.6.4: + resolution: {integrity: sha512-xx560wGBk7seZ6y933idtjJQc1l+ck+pI3sKvhKozdBV1dRZoKhkW5xoCaFv9tQiX5RH1xfSxjuNu6g+lmN/gw==} follow-redirects@1.15.9: resolution: {integrity: sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ==} @@ -2625,8 +2754,8 @@ packages: resolution: {integrity: sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==} engines: {node: '>= 0.6'} - fs-extra@11.2.0: - resolution: {integrity: sha512-PmDi3uwK5nFuXh7XDTlVnS17xJS7vW36is2+w3xcv8SVxiB4NyATf4ctkVY5bkSjX0Y4nbvZCq1/EjtEyr9ktw==} + fs-extra@11.3.0: + resolution: {integrity: sha512-Z4XaCL6dUDHfP/jT25jJKMmtxvuwbkrD1vNSMFlo9lNLY2c5FHYSQgHPRZUjAB26TpDEoW9HCOgplrdbaPV/ew==} engines: {node: '>=14.14'} fs-extra@7.0.1: @@ -2693,9 +2822,6 @@ packages: resolution: {integrity: sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==} engines: {node: '>=4'} - globalyzer@0.1.0: - resolution: {integrity: sha512-40oNTM9UfG6aBmuKxk/giHn5nQ8RVz/SS4Ir6zgzOv9/qC3kKZ9v4etGTcJbEl/NyVQH7FGU7d+X1egr57Md2Q==} - globby@11.1.0: resolution: {integrity: sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==} engines: {node: '>=10'} @@ -2704,9 +2830,6 @@ packages: resolution: {integrity: sha512-Y1zNGV+pzQdh7H39l9zgB4PJqjRNqydvdYCDG4HFXM4XuvSaQQlEc91IU1yALL8gUTDomgBAfz3XJdmUS+oo0w==} engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} - globrex@0.1.2: - resolution: {integrity: sha512-uHJgbwAMwNFf5mLst7IWLNg14x1CkeqglJb/K3doi4dw6q2IvAAmM/Y81kevy83wP+Sst+nutFTYOGg3d1lsxg==} - gopd@1.2.0: resolution: {integrity: sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==} engines: {node: '>= 0.4'} @@ -3218,8 +3341,8 @@ packages: micromark-util-sanitize-uri@2.0.1: resolution: {integrity: sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ==} - micromark-util-subtokenize@2.0.3: - resolution: {integrity: sha512-VXJJuNxYWSoYL6AJ6OQECCFGhIU2GGHMw8tahogePBrjkG8aCCas3ibkp7RnVOSTClg2is05/R7maAhF1XyQMg==} + micromark-util-subtokenize@2.0.4: + resolution: {integrity: sha512-N6hXjrin2GTJDe3MVjf5FuXpm12PGm80BrUAeub9XFXca8JZbP+oIwY4LJSVwFUCL1IPm/WwSVUN7goFHmSGGQ==} micromark-util-symbol@2.0.1: resolution: {integrity: sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==} @@ -3429,8 +3552,8 @@ packages: resolution: {integrity: sha512-VXJjc87FScF88uafS3JllDgvAm+c/Slfz06lorj2uAY34rlUu0Nt+v8wreiImcrgAjjIHp1rXpTDlLOGw29WwQ==} engines: {node: '>=18'} - oniguruma-to-es@0.10.0: - resolution: {integrity: sha512-zapyOUOCJxt+xhiNRPPMtfJkHGsZ98HHB9qJEkdT8BGytO/+kpe4m1Ngf0MzbzTmhacn11w9yGeDP6tzDhnCdg==} + oniguruma-to-es@2.3.0: + resolution: {integrity: sha512-bwALDxriqfKGfUufKGGepCzu9x7nJQuoRoAFp4AnwehhC2crqrDIAP/uN2qdlsAvSMpeRC3+Yzhqc7hLmle5+g==} openapi-types@12.1.3: resolution: {integrity: sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==} @@ -3439,8 +3562,8 @@ packages: resolution: {integrity: sha512-nN/TnIcGbP58qYgwEEy5FrAAjePcYgfMaCe3tsmYyTgI3v4RR9v8os14L+LEWDvV50+CmqiyTzRkKKtJeb6Ybg==} hasBin: true - openapi-typescript-fetch@2.0.0: - resolution: {integrity: sha512-9YkzVKIx9RVIET0lFjJOuf15VjI9AUsoNByBk5WYM66xVlAKDNy8anj08Ci3zZA+HgTwdDamYz5FCVYt2VoHkA==} + openapi-typescript-fetch@2.1.0: + resolution: {integrity: sha512-gNHMIhyol0qyxmnOGdt8vTfEDXWsAXUY/twGpwFEWHPeSPO3oZhJhJBPAFX02Uch3YGKFr/IrD5n/zdGuutvXw==} engines: {node: '>= 12.0.0', npm: '>= 7.0.0'} os-tmpdir@1.0.2: @@ -3582,13 +3705,13 @@ packages: resolution: {integrity: sha512-saLsH7WeYYPiD25LDuLRRY/i+6HaPYr6G1OUlN39otzkSTxKnubR9RTxS3/Kk50s1g2JTgFwWQDQyplC5/SHZg==} engines: {node: '>= 6'} - playwright-core@1.49.1: - resolution: {integrity: sha512-BzmpVcs4kE2CH15rWfzpjzVGhWERJfmnXmniSyKeRZUs9Ws65m+RGIi7mjJK/euCegfn3i7jvqWeWyHe9y3Vgg==} + playwright-core@1.50.0: + resolution: {integrity: sha512-CXkSSlr4JaZs2tZHI40DsZUN/NIwgaUPsyLuOAaIZp2CyF2sN5MM5NJsyB188lFSSozFxQ5fPT4qM+f0tH/6wQ==} engines: {node: '>=18'} hasBin: true - playwright@1.49.1: - resolution: {integrity: sha512-VYL8zLoNTBxVOrJBbDuRgDWa3i+mfQgDTrL8Ah9QXZ7ax4Dsj0MSq5bYgytRnDVVe+njoKnfsYkH3HzqVj5UZA==} + playwright@1.50.0: + resolution: {integrity: sha512-+GinGfGTrd2IfX1TA4N2gNmeIksSb+IAe589ZH+FlmpV3MYTx6+buChGIuDLQwrGNCw2lWibqV50fU510N7S+w==} engines: {node: '>=18'} hasBin: true @@ -3618,8 +3741,8 @@ packages: resolution: {integrity: sha512-PS08Iboia9mts/2ygV3eLpY5ghnUcfLV/EXTOW1E2qYxJKGGBUtNjN76FYHnMs36RmARn41bC0AZmn+rR0OVpQ==} engines: {node: ^10 || ^12 || >=14} - postcss@8.4.49: - resolution: {integrity: sha512-OCVPnIObs4N29kxTjzLfUryOkvZEq+pf8jTF0lg8E7uETuWHA+v7j3c/xJmiqpX450191LlmZfUKkXxkTry7nA==} + postcss@8.5.1: + resolution: {integrity: sha512-6oz2beyjc5VMn/KV1pPw8fliQkhBXrVn1Z3TVyqZxU8kZpzEKhBdmCFqI6ZbmGtamQvQGuU1sgPTk8ZrXDD7jQ==} engines: {node: ^10 || ^12 || >=14} preact@10.25.4: @@ -3660,8 +3783,8 @@ packages: resolution: {integrity: sha512-+38qI9SOr8tfZ4QmJNplMUxqjbe7LKvvZgWdExBOmd+egZTtjLB67Gu0HRX3u/XOq7UU2Nx6nsjvS16Z9uwfpg==} engines: {node: '>=0.6'} - qs@6.13.1: - resolution: {integrity: sha512-EJPeIn0CYrGu+hli1xilKAPXODtJ12T0sP63Ijx2/khC2JtuaN3JyNIpvmnkmaEtha9ocbG4A4cMcr+TvqvwQg==} + qs@6.14.0: + resolution: {integrity: sha512-YWWTjgABSKcvs/nWBi9PycY/JiPJqOD4JA6o9Sej2AtvSGarXxKC3OQSk4pAarbdQlKAh5D4FCQkJNkW+GAn3w==} engines: {node: '>=0.6'} querystringify@2.2.0: @@ -3719,9 +3842,9 @@ packages: resolution: {integrity: sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==} engines: {node: '>=8.10.0'} - readdirp@4.0.2: - resolution: {integrity: sha512-yDMz9g+VaZkqBYS/ozoBJwaBhTbZo3UNYQHNRw1D3UFQB8oHB4uS/tAODO+ZLjGWmUbKnIlOWO+aaIiAxrUWHA==} - engines: {node: '>= 14.16.0'} + readdirp@4.1.1: + resolution: {integrity: sha512-h80JrZu/MHUZCyHu5ciuoI0+WxsCxzxJTILn6Fs8rxSnFPh+UVHYfeIxK1nVGugMqkfC4vJcBOYbkfkwYK0+gw==} + engines: {node: '>= 14.18.0'} redent@4.0.0: resolution: {integrity: sha512-tYkDkVVtYkSVhuQ4zBgfvciymHaeuel+zFKXShfDnFP5SyVEP7qo70Rf1jTOTCx3vGNAbnEi/xFkcfQVMIBWag==} @@ -3783,6 +3906,11 @@ packages: engines: {node: '>=18.0.0', npm: '>=8.0.0'} hasBin: true + rollup@4.32.0: + resolution: {integrity: sha512-JmrhfQR31Q4AuNBjjAX4s+a/Pu/Q8Q9iwjWBsjRH1q52SPFE2NqRMK6fUZKKnvKO6id+h7JIRf0oYsph53eATg==} + engines: {node: '>=18.0.0', npm: '>=8.0.0'} + hasBin: true + run-parallel@1.2.0: resolution: {integrity: sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==} @@ -3844,8 +3972,11 @@ packages: resolution: {integrity: sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==} engines: {node: '>=8'} - shiki@1.26.1: - resolution: {integrity: sha512-Gqg6DSTk3wYqaZ5OaYtzjcdxcBvX5kCy24yvRJEgjT5U+WHlmqCThLuBUx0juyxQBi+6ug53IGeuQS07DWwpcw==} + shiki@1.29.1: + resolution: {integrity: sha512-TghWKV9pJTd/N+IgAIVJtr0qZkB7FfFCUrrEJc0aRmZupo3D1OCVRknQWVRVA7AX/M0Ld7QfoAruPzr3CnUJuw==} + + shiki@2.1.0: + resolution: {integrity: sha512-yvKPdNGLXZv7WC4bl7JBbU3CEcUxnBanvMez8MG3gZXKpClGL4bHqFyLhTx+2zUvbjClUANs/S22HXb7aeOgmA==} side-channel-list@1.0.0: resolution: {integrity: sha512-FCLHtRD/gnpCiCHEiJLOwdmFP+wzCmDEkc9y7NsYxeF4u7Btsn1ZuwgwJGxImImHicJArLP4R0yX4c2KCrMrTA==} @@ -4084,8 +4215,8 @@ packages: typescript: optional: true - svelte@5.16.1: - resolution: {integrity: sha512-FsA1OjAKMAFSDob6j/Tv2ZV9rY4SeqPd1WXQlQkFkePAozSHLp6tbkU9qa1xJ+uTRzMSM2Vx3USdsYZBXd3H3g==} + svelte@5.19.3: + resolution: {integrity: sha512-rb/bkYG9jq67OCWikMvaPnfOobyGn0JizVDwHpdeBtLiNXPMcoA9GTFC3BhptP7xGNquUU8J5GiS7PlGlfDAFA==} engines: {node: '>=18'} swr@2.2.5: @@ -4114,9 +4245,6 @@ packages: thenify@3.3.1: resolution: {integrity: sha512-RVZSIV5IG10Hk3enotrhvz0T9em6cyHBLkH/YAZuKqd8hRkKhSfCGIcP2KUY0EPxndzANBmNllzWPwak+bheSw==} - tiny-glob@0.2.9: - resolution: {integrity: sha512-g/55ssRPUjShh+xkfx9UPDXqhckHEsHr4Vd9zX55oSdGZc/MD0m3sferOkwWtp98bv+kcVfEHtRJgBVJzelrzg==} - tinybench@2.9.0: resolution: {integrity: sha512-0+DUvqWMValLmha6lr4kD8iAMK1HzV0/aKnCtWb9v9641TnP/MFb7Pc2bxoxQjTXAErryXVgUOfv2YqNllqGeg==} @@ -4208,38 +4336,38 @@ packages: typescript: optional: true - turbo-darwin-64@2.3.3: - resolution: {integrity: sha512-bxX82xe6du/3rPmm4aCC5RdEilIN99VUld4HkFQuw+mvFg6darNBuQxyWSHZTtc25XgYjQrjsV05888w1grpaA==} + turbo-darwin-64@2.3.4: + resolution: {integrity: sha512-uOi/cUIGQI7uakZygH+cZQ5D4w+aMLlVCN2KTGot+cmefatps2ZmRRufuHrEM0Rl63opdKD8/JIu+54s25qkfg==} cpu: [x64] os: [darwin] - turbo-darwin-arm64@2.3.3: - resolution: {integrity: sha512-DYbQwa3NsAuWkCUYVzfOUBbSUBVQzH5HWUFy2Kgi3fGjIWVZOFk86ss+xsWu//rlEAfYwEmopigsPYSmW4X15A==} + turbo-darwin-arm64@2.3.4: + resolution: {integrity: sha512-IIM1Lq5R+EGMtM1YFGl4x8Xkr0MWb4HvyU8N4LNoQ1Be5aycrOE+VVfH+cDg/Q4csn+8bxCOxhRp5KmUflrVTQ==} cpu: [arm64] os: [darwin] - turbo-linux-64@2.3.3: - resolution: {integrity: sha512-eHj9OIB0dFaP6BxB88jSuaCLsOQSYWBgmhy2ErCu6D2GG6xW3b6e2UWHl/1Ho9FsTg4uVgo4DB9wGsKa5erjUA==} + turbo-linux-64@2.3.4: + resolution: {integrity: sha512-1aD2EfR7NfjFXNH3mYU5gybLJEFi2IGOoKwoPLchAFRQ6OEJQj201/oNo9CDL75IIrQo64/NpEgVyZtoPlfhfA==} cpu: [x64] os: [linux] - turbo-linux-arm64@2.3.3: - resolution: {integrity: sha512-NmDE/NjZoDj1UWBhMtOPmqFLEBKhzGS61KObfrDEbXvU3lekwHeoPvAMfcovzswzch+kN2DrtbNIlz+/rp8OCg==} + turbo-linux-arm64@2.3.4: + resolution: {integrity: sha512-MxTpdKwxCaA5IlybPxgGLu54fT2svdqTIxRd0TQmpRJIjM0s4kbM+7YiLk0mOh6dGqlWPUsxz/A0Mkn8Xr5o7Q==} cpu: [arm64] os: [linux] - turbo-windows-64@2.3.3: - resolution: {integrity: sha512-O2+BS4QqjK3dOERscXqv7N2GXNcqHr9hXumkMxDj/oGx9oCatIwnnwx34UmzodloSnJpgSqjl8iRWiY65SmYoQ==} + turbo-windows-64@2.3.4: + resolution: {integrity: sha512-yyCrWqcRGu1AOOlrYzRnizEtdkqi+qKP0MW9dbk9OsMDXaOI5jlWtTY/AtWMkLw/czVJ7yS9Ex1vi9DB6YsFvw==} cpu: [x64] os: [win32] - turbo-windows-arm64@2.3.3: - resolution: {integrity: sha512-dW4ZK1r6XLPNYLIKjC4o87HxYidtRRcBeo/hZ9Wng2XM/MqqYkAyzJXJGgRMsc0MMEN9z4+ZIfnSNBrA0b08ag==} + turbo-windows-arm64@2.3.4: + resolution: {integrity: sha512-PggC3qH+njPfn1PDVwKrQvvQby8X09ufbqZ2Ha4uSu+5TvPorHHkAbZVHKYj2Y+tvVzxRzi4Sv6NdHXBS9Be5w==} cpu: [arm64] os: [win32] - turbo@2.3.3: - resolution: {integrity: sha512-DUHWQAcC8BTiUZDRzAYGvpSpGLiaOQPfYXlCieQbwUvmml/LRGIe3raKdrOPOoiX0DYlzxs2nH6BoWJoZrj8hA==} + turbo@2.3.4: + resolution: {integrity: sha512-1kiLO5C0Okh5ay1DbHsxkPsw9Sjsbjzm6cF85CpWjR0BIyBFNDbKqtUyqGADRS1dbbZoQanJZVj4MS5kk8J42Q==} hasBin: true twoslash-protocol@0.2.12: @@ -4267,6 +4395,10 @@ packages: resolution: {integrity: sha512-yCxltHW07Nkhv/1F6wWBr8kz+5BGMfP+RbRSYFnegVb0qV/UMT0G0ElBloPVerqn4M2ZV80Ir1FtCcYv1cT6vQ==} engines: {node: '>=16'} + type-fest@4.33.0: + resolution: {integrity: sha512-s6zVrxuyKbbAsSAD5ZPTB77q4YIdRctkTbJ2/Dqlinwz+8ooH2gd+YA7VA6Pa93KML9GockVvoxjZ2vHP+mu8g==} + engines: {node: '>=16'} + type-is@1.6.18: resolution: {integrity: sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==} engines: {node: '>= 0.6'} @@ -4281,6 +4413,11 @@ packages: engines: {node: '>=14.17'} hasBin: true + typescript@5.7.3: + resolution: {integrity: sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw==} + engines: {node: '>=14.17'} + hasBin: true + uglify-js@3.19.3: resolution: {integrity: sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ==} engines: {node: '>=0.8.0'} @@ -4337,8 +4474,8 @@ packages: resolution: {integrity: sha512-5liCNPuJW8dqh3+DM6uNM2EI3MLLpCKp/KY+9pB5M2S2SR2qvvDHhKgBOaTWEbZTAws3CXfB0rKTIolWKL05VQ==} engines: {node: '>=14.0.0'} - update-browserslist-db@1.1.1: - resolution: {integrity: sha512-R8UzCaa9Az+38REPiJ1tXlImTJXlVfgHZsglwBD/k6nj76ctsH1E3q4doGrukiLQd3sGQYu56r5+lo5r94l29A==} + update-browserslist-db@1.1.2: + resolution: {integrity: sha512-PPypAm5qvlD7XMZC3BujecnaOxwhrtoFR+Dqkk5Aa/6DssiH0ibKoketaj9w8LP7Bont1rYeoV5plxD7RTEPRg==} hasBin: true peerDependencies: browserslist: '>= 4.21.0' @@ -4380,8 +4517,8 @@ packages: engines: {node: ^18.0.0 || >=20.0.0} hasBin: true - vite@5.4.11: - resolution: {integrity: sha512-c7jFQRklXua0mTzneGW9QVyxFjUgwcihC4bXEtujIo2ouWCe1Ajt/amn2PCxYnhYfd5k09JX3SB7OYWFKYqj8Q==} + vite@5.4.14: + resolution: {integrity: sha512-EK5cY7Q1D8JNhSaPKVK4pwBFvaTmZxEnoKXLG/U9gmdDcihQGNzFlgIvaxezFR4glP1LsuiedwMBqCXH3wZccA==} engines: {node: ^18.0.0 || >=20.0.0} hasBin: true peerDependencies: @@ -4411,8 +4548,8 @@ packages: terser: optional: true - vite@6.0.7: - resolution: {integrity: sha512-RDt8r/7qx9940f8FcOIAH9PTViRrghKaK2K1jY3RaAURrEUbm9Du1mJ72G+jlhtG3WwodnfzY8ORQZbBavZEAQ==} + vite@6.0.11: + resolution: {integrity: sha512-4VL9mQPKoHy4+FE0NnRE/kbY51TOfaknxAjt3fJbGJxhIpBZiqVzlZDEesWWsuREXHwNdAoOFZ9MkPEVXczHwg==} engines: {node: ^18.0.0 || ^20.0.0 || >=22.0.0} hasBin: true peerDependencies: @@ -4459,8 +4596,8 @@ packages: vite: optional: true - vitepress@1.5.0: - resolution: {integrity: sha512-q4Q/G2zjvynvizdB3/bupdYkCJe2umSAMv9Ju4d92E6/NXJ59z70xB0q5p/4lpRyAwflDsbwy1mLV9Q5+nlB+g==} + vitepress@1.6.3: + resolution: {integrity: sha512-fCkfdOk8yRZT8GD9BFqusW3+GggWYZ/rYncOfmgcDtP3ualNHCAg+Robxp2/6xfH1WwPHtGpPwv7mbA3qomtBw==} hasBin: true peerDependencies: markdown-it-mathjax3: ^4 @@ -4499,17 +4636,6 @@ packages: vscode-uri@3.0.8: resolution: {integrity: sha512-AyFQ0EVmsOZOlAnxoFOGOq1SQDWAB7C6aqMGS23svWAllfOaxbuFvcT8D1i8z3Gyn8fraVeZNNmN6e9bxxXkKw==} - vue-demi@0.14.10: - resolution: {integrity: sha512-nMZBOwuzabUO0nLgIcc6rycZEebF6eeUfaiQx9+WSk8e29IbLvPU9feI6tqW4kTo3hvoYAJkMh8n8D0fuISphg==} - engines: {node: '>=12'} - hasBin: true - peerDependencies: - '@vue/composition-api': ^1.0.0-rc.1 - vue: ^3.0.0-0 || ^2.6.0 - peerDependenciesMeta: - '@vue/composition-api': - optional: true - vue-resize@2.0.0-alpha.1: resolution: {integrity: sha512-7+iqOueLU7uc9NrMfrzbG8hwMqchfVfSzpVlCMeJQe4pyibqyoifDNbKTZvwxZKDvGkB+PdFeKvnGZMoEb8esg==} peerDependencies: @@ -4665,110 +4791,110 @@ packages: snapshots: - '@algolia/autocomplete-core@1.17.7(@algolia/client-search@5.18.0)(algoliasearch@5.18.0)(search-insights@2.13.0)': + '@algolia/autocomplete-core@1.17.7(@algolia/client-search@5.20.0)(algoliasearch@5.20.0)(search-insights@2.13.0)': dependencies: - '@algolia/autocomplete-plugin-algolia-insights': 1.17.7(@algolia/client-search@5.18.0)(algoliasearch@5.18.0)(search-insights@2.13.0) - '@algolia/autocomplete-shared': 1.17.7(@algolia/client-search@5.18.0)(algoliasearch@5.18.0) + '@algolia/autocomplete-plugin-algolia-insights': 1.17.7(@algolia/client-search@5.20.0)(algoliasearch@5.20.0)(search-insights@2.13.0) + '@algolia/autocomplete-shared': 1.17.7(@algolia/client-search@5.20.0)(algoliasearch@5.20.0) transitivePeerDependencies: - '@algolia/client-search' - algoliasearch - search-insights - '@algolia/autocomplete-plugin-algolia-insights@1.17.7(@algolia/client-search@5.18.0)(algoliasearch@5.18.0)(search-insights@2.13.0)': + '@algolia/autocomplete-plugin-algolia-insights@1.17.7(@algolia/client-search@5.20.0)(algoliasearch@5.20.0)(search-insights@2.13.0)': dependencies: - '@algolia/autocomplete-shared': 1.17.7(@algolia/client-search@5.18.0)(algoliasearch@5.18.0) + '@algolia/autocomplete-shared': 1.17.7(@algolia/client-search@5.20.0)(algoliasearch@5.20.0) search-insights: 2.13.0 transitivePeerDependencies: - '@algolia/client-search' - algoliasearch - '@algolia/autocomplete-preset-algolia@1.17.7(@algolia/client-search@5.18.0)(algoliasearch@5.18.0)': + '@algolia/autocomplete-preset-algolia@1.17.7(@algolia/client-search@5.20.0)(algoliasearch@5.20.0)': dependencies: - '@algolia/autocomplete-shared': 1.17.7(@algolia/client-search@5.18.0)(algoliasearch@5.18.0) - '@algolia/client-search': 5.18.0 - algoliasearch: 5.18.0 + '@algolia/autocomplete-shared': 1.17.7(@algolia/client-search@5.20.0)(algoliasearch@5.20.0) + '@algolia/client-search': 5.20.0 + algoliasearch: 5.20.0 - '@algolia/autocomplete-shared@1.17.7(@algolia/client-search@5.18.0)(algoliasearch@5.18.0)': + '@algolia/autocomplete-shared@1.17.7(@algolia/client-search@5.20.0)(algoliasearch@5.20.0)': dependencies: - '@algolia/client-search': 5.18.0 - algoliasearch: 5.18.0 + '@algolia/client-search': 5.20.0 + algoliasearch: 5.20.0 - '@algolia/client-abtesting@5.18.0': + '@algolia/client-abtesting@5.20.0': dependencies: - '@algolia/client-common': 5.18.0 - '@algolia/requester-browser-xhr': 5.18.0 - '@algolia/requester-fetch': 5.18.0 - '@algolia/requester-node-http': 5.18.0 + '@algolia/client-common': 5.20.0 + '@algolia/requester-browser-xhr': 5.20.0 + '@algolia/requester-fetch': 5.20.0 + '@algolia/requester-node-http': 5.20.0 - '@algolia/client-analytics@5.18.0': + '@algolia/client-analytics@5.20.0': dependencies: - '@algolia/client-common': 5.18.0 - '@algolia/requester-browser-xhr': 5.18.0 - '@algolia/requester-fetch': 5.18.0 - '@algolia/requester-node-http': 5.18.0 + '@algolia/client-common': 5.20.0 + '@algolia/requester-browser-xhr': 5.20.0 + '@algolia/requester-fetch': 5.20.0 + '@algolia/requester-node-http': 5.20.0 - '@algolia/client-common@5.18.0': {} + '@algolia/client-common@5.20.0': {} - '@algolia/client-insights@5.18.0': + '@algolia/client-insights@5.20.0': dependencies: - '@algolia/client-common': 5.18.0 - '@algolia/requester-browser-xhr': 5.18.0 - '@algolia/requester-fetch': 5.18.0 - '@algolia/requester-node-http': 5.18.0 + '@algolia/client-common': 5.20.0 + '@algolia/requester-browser-xhr': 5.20.0 + '@algolia/requester-fetch': 5.20.0 + '@algolia/requester-node-http': 5.20.0 - '@algolia/client-personalization@5.18.0': + '@algolia/client-personalization@5.20.0': dependencies: - '@algolia/client-common': 5.18.0 - '@algolia/requester-browser-xhr': 5.18.0 - '@algolia/requester-fetch': 5.18.0 - '@algolia/requester-node-http': 5.18.0 + '@algolia/client-common': 5.20.0 + '@algolia/requester-browser-xhr': 5.20.0 + '@algolia/requester-fetch': 5.20.0 + '@algolia/requester-node-http': 5.20.0 - '@algolia/client-query-suggestions@5.18.0': + '@algolia/client-query-suggestions@5.20.0': dependencies: - '@algolia/client-common': 5.18.0 - '@algolia/requester-browser-xhr': 5.18.0 - '@algolia/requester-fetch': 5.18.0 - '@algolia/requester-node-http': 5.18.0 + '@algolia/client-common': 5.20.0 + '@algolia/requester-browser-xhr': 5.20.0 + '@algolia/requester-fetch': 5.20.0 + '@algolia/requester-node-http': 5.20.0 - '@algolia/client-search@5.18.0': + '@algolia/client-search@5.20.0': dependencies: - '@algolia/client-common': 5.18.0 - '@algolia/requester-browser-xhr': 5.18.0 - '@algolia/requester-fetch': 5.18.0 - '@algolia/requester-node-http': 5.18.0 + '@algolia/client-common': 5.20.0 + '@algolia/requester-browser-xhr': 5.20.0 + '@algolia/requester-fetch': 5.20.0 + '@algolia/requester-node-http': 5.20.0 - '@algolia/ingestion@1.18.0': + '@algolia/ingestion@1.20.0': dependencies: - '@algolia/client-common': 5.18.0 - '@algolia/requester-browser-xhr': 5.18.0 - '@algolia/requester-fetch': 5.18.0 - '@algolia/requester-node-http': 5.18.0 + '@algolia/client-common': 5.20.0 + '@algolia/requester-browser-xhr': 5.20.0 + '@algolia/requester-fetch': 5.20.0 + '@algolia/requester-node-http': 5.20.0 - '@algolia/monitoring@1.18.0': + '@algolia/monitoring@1.20.0': dependencies: - '@algolia/client-common': 5.18.0 - '@algolia/requester-browser-xhr': 5.18.0 - '@algolia/requester-fetch': 5.18.0 - '@algolia/requester-node-http': 5.18.0 + '@algolia/client-common': 5.20.0 + '@algolia/requester-browser-xhr': 5.20.0 + '@algolia/requester-fetch': 5.20.0 + '@algolia/requester-node-http': 5.20.0 - '@algolia/recommend@5.18.0': + '@algolia/recommend@5.20.0': dependencies: - '@algolia/client-common': 5.18.0 - '@algolia/requester-browser-xhr': 5.18.0 - '@algolia/requester-fetch': 5.18.0 - '@algolia/requester-node-http': 5.18.0 + '@algolia/client-common': 5.20.0 + '@algolia/requester-browser-xhr': 5.20.0 + '@algolia/requester-fetch': 5.20.0 + '@algolia/requester-node-http': 5.20.0 - '@algolia/requester-browser-xhr@5.18.0': + '@algolia/requester-browser-xhr@5.20.0': dependencies: - '@algolia/client-common': 5.18.0 + '@algolia/client-common': 5.20.0 - '@algolia/requester-fetch@5.18.0': + '@algolia/requester-fetch@5.20.0': dependencies: - '@algolia/client-common': 5.18.0 + '@algolia/client-common': 5.20.0 - '@algolia/requester-node-http@5.18.0': + '@algolia/requester-node-http@5.20.0': dependencies: - '@algolia/client-common': 5.18.0 + '@algolia/client-common': 5.20.0 '@ampproject/remapping@2.3.0': dependencies: @@ -4810,20 +4936,20 @@ snapshots: js-tokens: 4.0.0 picocolors: 1.1.1 - '@babel/compat-data@7.26.3': {} + '@babel/compat-data@7.26.5': {} - '@babel/core@7.26.0': + '@babel/core@7.26.7': dependencies: '@ampproject/remapping': 2.3.0 '@babel/code-frame': 7.26.2 - '@babel/generator': 7.26.3 - '@babel/helper-compilation-targets': 7.25.9 - '@babel/helper-module-transforms': 7.26.0(@babel/core@7.26.0) - '@babel/helpers': 7.26.0 - '@babel/parser': 7.26.3 + '@babel/generator': 7.26.5 + '@babel/helper-compilation-targets': 7.26.5 + '@babel/helper-module-transforms': 7.26.0(@babel/core@7.26.7) + '@babel/helpers': 7.26.7 + '@babel/parser': 7.26.7 '@babel/template': 7.25.9 - '@babel/traverse': 7.26.4 - '@babel/types': 7.26.3 + '@babel/traverse': 7.26.7 + '@babel/types': 7.26.7 convert-source-map: 2.0.0 debug: 4.4.0(supports-color@9.4.0) gensync: 1.0.0-beta.2 @@ -4832,39 +4958,39 @@ snapshots: transitivePeerDependencies: - supports-color - '@babel/generator@7.26.3': + '@babel/generator@7.26.5': dependencies: - '@babel/parser': 7.26.3 - '@babel/types': 7.26.3 + '@babel/parser': 7.26.7 + '@babel/types': 7.26.7 '@jridgewell/gen-mapping': 0.3.8 '@jridgewell/trace-mapping': 0.3.25 jsesc: 3.1.0 - '@babel/helper-compilation-targets@7.25.9': + '@babel/helper-compilation-targets@7.26.5': dependencies: - '@babel/compat-data': 7.26.3 + '@babel/compat-data': 7.26.5 '@babel/helper-validator-option': 7.25.9 - browserslist: 4.24.3 + browserslist: 4.24.4 lru-cache: 5.1.1 semver: 6.3.1 '@babel/helper-module-imports@7.25.9': dependencies: - '@babel/traverse': 7.26.4 - '@babel/types': 7.26.3 + '@babel/traverse': 7.26.7 + '@babel/types': 7.26.7 transitivePeerDependencies: - supports-color - '@babel/helper-module-transforms@7.26.0(@babel/core@7.26.0)': + '@babel/helper-module-transforms@7.26.0(@babel/core@7.26.7)': dependencies: - '@babel/core': 7.26.0 + '@babel/core': 7.26.7 '@babel/helper-module-imports': 7.25.9 '@babel/helper-validator-identifier': 7.25.9 - '@babel/traverse': 7.26.4 + '@babel/traverse': 7.26.7 transitivePeerDependencies: - supports-color - '@babel/helper-plugin-utils@7.25.9': {} + '@babel/helper-plugin-utils@7.26.5': {} '@babel/helper-string-parser@7.25.9': {} @@ -4872,42 +4998,46 @@ snapshots: '@babel/helper-validator-option@7.25.9': {} - '@babel/helpers@7.26.0': + '@babel/helpers@7.26.7': dependencies: '@babel/template': 7.25.9 - '@babel/types': 7.26.3 + '@babel/types': 7.26.7 '@babel/parser@7.26.3': dependencies: '@babel/types': 7.26.3 - '@babel/plugin-transform-react-jsx-self@7.25.9(@babel/core@7.26.0)': + '@babel/parser@7.26.7': dependencies: - '@babel/core': 7.26.0 - '@babel/helper-plugin-utils': 7.25.9 + '@babel/types': 7.26.7 - '@babel/plugin-transform-react-jsx-source@7.25.9(@babel/core@7.26.0)': + '@babel/plugin-transform-react-jsx-self@7.25.9(@babel/core@7.26.7)': dependencies: - '@babel/core': 7.26.0 - '@babel/helper-plugin-utils': 7.25.9 + '@babel/core': 7.26.7 + '@babel/helper-plugin-utils': 7.26.5 - '@babel/runtime@7.26.0': + '@babel/plugin-transform-react-jsx-source@7.25.9(@babel/core@7.26.7)': + dependencies: + '@babel/core': 7.26.7 + '@babel/helper-plugin-utils': 7.26.5 + + '@babel/runtime@7.26.7': dependencies: regenerator-runtime: 0.14.1 '@babel/template@7.25.9': dependencies: '@babel/code-frame': 7.26.2 - '@babel/parser': 7.26.3 - '@babel/types': 7.26.3 + '@babel/parser': 7.26.7 + '@babel/types': 7.26.7 - '@babel/traverse@7.26.4': + '@babel/traverse@7.26.7': dependencies: '@babel/code-frame': 7.26.2 - '@babel/generator': 7.26.3 - '@babel/parser': 7.26.3 + '@babel/generator': 7.26.5 + '@babel/parser': 7.26.7 '@babel/template': 7.25.9 - '@babel/types': 7.26.3 + '@babel/types': 7.26.7 debug: 4.4.0(supports-color@9.4.0) globals: 11.12.0 transitivePeerDependencies: @@ -4918,6 +5048,11 @@ snapshots: '@babel/helper-string-parser': 7.25.9 '@babel/helper-validator-identifier': 7.25.9 + '@babel/types@7.26.7': + dependencies: + '@babel/helper-string-parser': 7.25.9 + '@babel/helper-validator-identifier': 7.25.9 + '@bcoe/v8-coverage@0.2.3': {} '@biomejs/biome@1.9.4': @@ -4972,7 +5107,7 @@ snapshots: '@types/tough-cookie': 4.0.5 tough-cookie: 4.1.4 - '@changesets/apply-release-plan@7.0.7': + '@changesets/apply-release-plan@7.0.8': dependencies: '@changesets/config': 3.0.5 '@changesets/get-version-range-type': 0.4.0 @@ -5009,9 +5144,9 @@ snapshots: transitivePeerDependencies: - encoding - '@changesets/cli@2.27.11': + '@changesets/cli@2.27.12': dependencies: - '@changesets/apply-release-plan': 7.0.7 + '@changesets/apply-release-plan': 7.0.8 '@changesets/assemble-release-plan': 6.0.5 '@changesets/changelog-git': 0.2.0 '@changesets/config': 3.0.5 @@ -5134,9 +5269,9 @@ snapshots: '@docsearch/css@3.8.2': {} - '@docsearch/js@3.8.2(@algolia/client-search@5.18.0)(@types/react@18.3.18)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)': + '@docsearch/js@3.8.2(@algolia/client-search@5.20.0)(@types/react@18.3.18)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)': dependencies: - '@docsearch/react': 3.8.2(@algolia/client-search@5.18.0)(@types/react@18.3.18)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0) + '@docsearch/react': 3.8.2(@algolia/client-search@5.20.0)(@types/react@18.3.18)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0) preact: 10.25.4 transitivePeerDependencies: - '@algolia/client-search' @@ -5145,12 +5280,12 @@ snapshots: - react-dom - search-insights - '@docsearch/react@3.8.2(@algolia/client-search@5.18.0)(@types/react@18.3.18)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)': + '@docsearch/react@3.8.2(@algolia/client-search@5.20.0)(@types/react@18.3.18)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)': dependencies: - '@algolia/autocomplete-core': 1.17.7(@algolia/client-search@5.18.0)(algoliasearch@5.18.0)(search-insights@2.13.0) - '@algolia/autocomplete-preset-algolia': 1.17.7(@algolia/client-search@5.18.0)(algoliasearch@5.18.0) + '@algolia/autocomplete-core': 1.17.7(@algolia/client-search@5.20.0)(algoliasearch@5.20.0)(search-insights@2.13.0) + '@algolia/autocomplete-preset-algolia': 1.17.7(@algolia/client-search@5.20.0)(algoliasearch@5.20.0) '@docsearch/css': 3.8.2 - algoliasearch: 5.18.0 + algoliasearch: 5.20.0 optionalDependencies: '@types/react': 18.3.18 react: 18.3.1 @@ -5308,17 +5443,17 @@ snapshots: '@esbuild/win32-x64@0.24.2': optional: true - '@floating-ui/core@1.6.8': + '@floating-ui/core@1.6.9': dependencies: - '@floating-ui/utils': 0.2.8 + '@floating-ui/utils': 0.2.9 '@floating-ui/dom@1.1.1': dependencies: - '@floating-ui/core': 1.6.8 + '@floating-ui/core': 1.6.9 - '@floating-ui/utils@0.2.8': {} + '@floating-ui/utils@0.2.9': {} - '@iconify-json/simple-icons@1.2.18': + '@iconify-json/simple-icons@1.2.21': dependencies: '@iconify/types': 2.0.0 @@ -5399,13 +5534,34 @@ snapshots: '@img/sharp-win32-x64@0.33.5': optional: true - '@inquirer/confirm@5.1.1(@types/node@22.10.5)': + '@inquirer/confirm@5.1.3(@types/node@22.10.10)': dependencies: - '@inquirer/core': 10.1.2(@types/node@22.10.5) + '@inquirer/core': 10.1.4(@types/node@22.10.10) + '@inquirer/type': 3.0.2(@types/node@22.10.10) + '@types/node': 22.10.10 + + '@inquirer/confirm@5.1.3(@types/node@22.10.5)': + dependencies: + '@inquirer/core': 10.1.4(@types/node@22.10.5) '@inquirer/type': 3.0.2(@types/node@22.10.5) '@types/node': 22.10.5 + optional: true - '@inquirer/core@10.1.2(@types/node@22.10.5)': + '@inquirer/core@10.1.4(@types/node@22.10.10)': + dependencies: + '@inquirer/figures': 1.0.9 + '@inquirer/type': 3.0.2(@types/node@22.10.10) + ansi-escapes: 4.3.2 + cli-width: 4.1.0 + mute-stream: 2.0.0 + signal-exit: 4.1.0 + strip-ansi: 6.0.1 + wrap-ansi: 6.2.0 + yoctocolors-cjs: 2.1.2 + transitivePeerDependencies: + - '@types/node' + + '@inquirer/core@10.1.4(@types/node@22.10.5)': dependencies: '@inquirer/figures': 1.0.9 '@inquirer/type': 3.0.2(@types/node@22.10.5) @@ -5418,12 +5574,18 @@ snapshots: yoctocolors-cjs: 2.1.2 transitivePeerDependencies: - '@types/node' + optional: true '@inquirer/figures@1.0.9': {} + '@inquirer/type@3.0.2(@types/node@22.10.10)': + dependencies: + '@types/node': 22.10.10 + '@inquirer/type@3.0.2(@types/node@22.10.5)': dependencies: '@types/node': 22.10.5 + optional: true '@isaacs/cliui@8.0.2': dependencies: @@ -5457,21 +5619,21 @@ snapshots: '@manypkg/find-root@1.1.0': dependencies: - '@babel/runtime': 7.26.0 + '@babel/runtime': 7.26.7 '@types/node': 12.20.55 find-up: 4.1.0 fs-extra: 8.1.0 '@manypkg/get-packages@1.1.3': dependencies: - '@babel/runtime': 7.26.0 + '@babel/runtime': 7.26.7 '@changesets/types': 4.1.0 '@manypkg/find-root': 1.1.0 fs-extra: 8.1.0 globby: 11.1.0 read-yaml-file: 1.1.0 - '@mswjs/interceptors@0.37.4': + '@mswjs/interceptors@0.37.5': dependencies: '@open-draft/deferred-promise': 2.2.0 '@open-draft/logger': 0.3.0 @@ -5530,9 +5692,9 @@ snapshots: '@pkgjs/parseargs@0.11.0': optional: true - '@playwright/test@1.49.1': + '@playwright/test@1.50.0': dependencies: - playwright: 1.49.1 + playwright: 1.50.0 '@polka/url@1.0.0-next.28': {} @@ -5543,12 +5705,12 @@ snapshots: require-from-string: 2.0.2 uri-js-replace: 1.0.1 - '@redocly/config@0.17.1': {} + '@redocly/config@0.20.2': {} - '@redocly/openapi-core@1.27.0(supports-color@9.4.0)': + '@redocly/openapi-core@1.27.2(supports-color@9.4.0)': dependencies: '@redocly/ajv': 8.11.2 - '@redocly/config': 0.17.1 + '@redocly/config': 0.20.2 colorette: 1.4.0 https-proxy-agent: 7.0.6(supports-color@9.4.0) js-levenshtein: 1.1.6 @@ -5561,128 +5723,219 @@ snapshots: - encoding - supports-color - '@rollup/pluginutils@5.1.4(rollup@4.29.1)': + '@rollup/pluginutils@5.1.4(rollup@4.32.0)': dependencies: '@types/estree': 1.0.6 estree-walker: 2.0.2 picomatch: 4.0.2 optionalDependencies: - rollup: 4.29.1 + rollup: 4.32.0 '@rollup/rollup-android-arm-eabi@4.29.1': optional: true + '@rollup/rollup-android-arm-eabi@4.32.0': + optional: true + '@rollup/rollup-android-arm64@4.29.1': optional: true + '@rollup/rollup-android-arm64@4.32.0': + optional: true + '@rollup/rollup-darwin-arm64@4.29.1': optional: true + '@rollup/rollup-darwin-arm64@4.32.0': + optional: true + '@rollup/rollup-darwin-x64@4.29.1': optional: true + '@rollup/rollup-darwin-x64@4.32.0': + optional: true + '@rollup/rollup-freebsd-arm64@4.29.1': optional: true + '@rollup/rollup-freebsd-arm64@4.32.0': + optional: true + '@rollup/rollup-freebsd-x64@4.29.1': optional: true + '@rollup/rollup-freebsd-x64@4.32.0': + optional: true + '@rollup/rollup-linux-arm-gnueabihf@4.29.1': optional: true + '@rollup/rollup-linux-arm-gnueabihf@4.32.0': + optional: true + '@rollup/rollup-linux-arm-musleabihf@4.29.1': optional: true + '@rollup/rollup-linux-arm-musleabihf@4.32.0': + optional: true + '@rollup/rollup-linux-arm64-gnu@4.29.1': optional: true + '@rollup/rollup-linux-arm64-gnu@4.32.0': + optional: true + '@rollup/rollup-linux-arm64-musl@4.29.1': optional: true + '@rollup/rollup-linux-arm64-musl@4.32.0': + optional: true + '@rollup/rollup-linux-loongarch64-gnu@4.29.1': optional: true + '@rollup/rollup-linux-loongarch64-gnu@4.32.0': + optional: true + '@rollup/rollup-linux-powerpc64le-gnu@4.29.1': optional: true + '@rollup/rollup-linux-powerpc64le-gnu@4.32.0': + optional: true + '@rollup/rollup-linux-riscv64-gnu@4.29.1': optional: true + '@rollup/rollup-linux-riscv64-gnu@4.32.0': + optional: true + '@rollup/rollup-linux-s390x-gnu@4.29.1': optional: true + '@rollup/rollup-linux-s390x-gnu@4.32.0': + optional: true + '@rollup/rollup-linux-x64-gnu@4.29.1': optional: true + '@rollup/rollup-linux-x64-gnu@4.32.0': + optional: true + '@rollup/rollup-linux-x64-musl@4.29.1': optional: true + '@rollup/rollup-linux-x64-musl@4.32.0': + optional: true + '@rollup/rollup-win32-arm64-msvc@4.29.1': optional: true + '@rollup/rollup-win32-arm64-msvc@4.32.0': + optional: true + '@rollup/rollup-win32-ia32-msvc@4.29.1': optional: true + '@rollup/rollup-win32-ia32-msvc@4.32.0': + optional: true + '@rollup/rollup-win32-x64-msvc@4.29.1': optional: true - '@shikijs/core@1.26.1': + '@rollup/rollup-win32-x64-msvc@4.32.0': + optional: true + + '@shikijs/core@1.29.1': + dependencies: + '@shikijs/engine-javascript': 1.29.1 + '@shikijs/engine-oniguruma': 1.29.1 + '@shikijs/types': 1.29.1 + '@shikijs/vscode-textmate': 10.0.1 + '@types/hast': 3.0.4 + hast-util-to-html: 9.0.4 + + '@shikijs/core@2.1.0': dependencies: - '@shikijs/engine-javascript': 1.26.1 - '@shikijs/engine-oniguruma': 1.26.1 - '@shikijs/types': 1.26.1 + '@shikijs/engine-javascript': 2.1.0 + '@shikijs/engine-oniguruma': 2.1.0 + '@shikijs/types': 2.1.0 '@shikijs/vscode-textmate': 10.0.1 '@types/hast': 3.0.4 hast-util-to-html: 9.0.4 - '@shikijs/engine-javascript@1.26.1': + '@shikijs/engine-javascript@1.29.1': + dependencies: + '@shikijs/types': 1.29.1 + '@shikijs/vscode-textmate': 10.0.1 + oniguruma-to-es: 2.3.0 + + '@shikijs/engine-javascript@2.1.0': dependencies: - '@shikijs/types': 1.26.1 + '@shikijs/types': 2.1.0 '@shikijs/vscode-textmate': 10.0.1 - oniguruma-to-es: 0.10.0 + oniguruma-to-es: 2.3.0 - '@shikijs/engine-oniguruma@1.26.1': + '@shikijs/engine-oniguruma@1.29.1': dependencies: - '@shikijs/types': 1.26.1 + '@shikijs/types': 1.29.1 '@shikijs/vscode-textmate': 10.0.1 - '@shikijs/langs@1.26.1': + '@shikijs/engine-oniguruma@2.1.0': + dependencies: + '@shikijs/types': 2.1.0 + '@shikijs/vscode-textmate': 10.0.1 + + '@shikijs/langs@1.29.1': + dependencies: + '@shikijs/types': 1.29.1 + + '@shikijs/langs@2.1.0': dependencies: - '@shikijs/types': 1.26.1 + '@shikijs/types': 2.1.0 - '@shikijs/themes@1.26.1': + '@shikijs/themes@1.29.1': dependencies: - '@shikijs/types': 1.26.1 + '@shikijs/types': 1.29.1 - '@shikijs/transformers@1.26.1': + '@shikijs/themes@2.1.0': dependencies: - shiki: 1.26.1 + '@shikijs/types': 2.1.0 - '@shikijs/twoslash@1.26.1(typescript@5.7.2)': + '@shikijs/transformers@2.1.0': dependencies: - '@shikijs/core': 1.26.1 - '@shikijs/types': 1.26.1 - twoslash: 0.2.12(typescript@5.7.2) + '@shikijs/core': 2.1.0 + '@shikijs/types': 2.1.0 + + '@shikijs/twoslash@2.1.0(typescript@5.7.3)': + dependencies: + '@shikijs/core': 2.1.0 + '@shikijs/types': 2.1.0 + twoslash: 0.2.12(typescript@5.7.3) transitivePeerDependencies: - supports-color - typescript - '@shikijs/types@1.26.1': + '@shikijs/types@1.29.1': + dependencies: + '@shikijs/vscode-textmate': 10.0.1 + '@types/hast': 3.0.4 + + '@shikijs/types@2.1.0': dependencies: '@shikijs/vscode-textmate': 10.0.1 '@types/hast': 3.0.4 - '@shikijs/vitepress-twoslash@1.26.1(typescript@5.7.2)': + '@shikijs/vitepress-twoslash@1.29.1(typescript@5.7.3)': dependencies: - '@shikijs/twoslash': 1.26.1(typescript@5.7.2) - floating-vue: 5.2.2(vue@3.5.13(typescript@5.7.2)) + '@shikijs/twoslash': 2.1.0(typescript@5.7.3) + floating-vue: 5.2.2(vue@3.5.13(typescript@5.7.3)) mdast-util-from-markdown: 2.0.2 mdast-util-gfm: 3.0.0 mdast-util-to-hast: 13.2.0 - shiki: 1.26.1 - twoslash: 0.2.12(typescript@5.7.2) - twoslash-vue: 0.2.12(typescript@5.7.2) - vue: 3.5.13(typescript@5.7.2) + shiki: 1.29.1 + twoslash: 0.2.12(typescript@5.7.3) + twoslash-vue: 0.2.12(typescript@5.7.3) + vue: 3.5.13(typescript@5.7.3) transitivePeerDependencies: - '@nuxt/kit' - supports-color @@ -5708,18 +5961,18 @@ snapshots: '@size-limit/file': 11.1.6(size-limit@11.1.6) size-limit: 11.1.6 - '@sveltejs/adapter-auto@3.3.1(@sveltejs/kit@2.15.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)))': + '@sveltejs/adapter-auto@3.3.1(@sveltejs/kit@2.16.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)))': dependencies: - '@sveltejs/kit': 2.15.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)) + '@sveltejs/kit': 2.16.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)) import-meta-resolve: 4.1.0 - '@sveltejs/kit@2.15.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1))': + '@sveltejs/kit@2.16.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1))': dependencies: - '@sveltejs/vite-plugin-svelte': 5.0.3(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)) + '@sveltejs/vite-plugin-svelte': 5.0.3(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)) '@types/cookie': 0.6.0 cookie: 0.6.0 devalue: 5.1.1 - esm-env: 1.2.1 + esm-env: 1.2.2 import-meta-resolve: 4.1.0 kleur: 4.1.5 magic-string: 0.30.17 @@ -5727,29 +5980,28 @@ snapshots: sade: 1.8.1 set-cookie-parser: 2.7.1 sirv: 3.0.0 - svelte: 5.16.1 - tiny-glob: 0.2.9 - vite: 6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1) + svelte: 5.19.3 + vite: 6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1) - '@sveltejs/vite-plugin-svelte-inspector@4.0.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1))': + '@sveltejs/vite-plugin-svelte-inspector@4.0.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1))': dependencies: - '@sveltejs/vite-plugin-svelte': 5.0.3(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)) + '@sveltejs/vite-plugin-svelte': 5.0.3(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)) debug: 4.4.0(supports-color@9.4.0) - svelte: 5.16.1 - vite: 6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1) + svelte: 5.19.3 + vite: 6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1) transitivePeerDependencies: - supports-color - '@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1))': + '@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1))': dependencies: - '@sveltejs/vite-plugin-svelte-inspector': 4.0.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.16.1)(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)) + '@sveltejs/vite-plugin-svelte-inspector': 4.0.1(@sveltejs/vite-plugin-svelte@5.0.3(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)))(svelte@5.19.3)(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)) debug: 4.4.0(supports-color@9.4.0) deepmerge: 4.3.1 kleur: 4.1.5 magic-string: 0.30.17 - svelte: 5.16.1 - vite: 6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1) - vitefu: 1.0.5(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)) + svelte: 5.19.3 + vite: 6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1) + vitefu: 1.0.5(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)) transitivePeerDependencies: - supports-color @@ -5810,17 +6062,17 @@ snapshots: dependencies: '@swc/counter': 0.1.3 - '@tanstack/query-core@5.62.12': {} + '@tanstack/query-core@5.64.2': {} - '@tanstack/react-query@5.62.14(react@18.3.1)': + '@tanstack/react-query@5.64.2(react@18.3.1)': dependencies: - '@tanstack/query-core': 5.62.12 + '@tanstack/query-core': 5.64.2 react: 18.3.1 '@testing-library/dom@10.1.0': dependencies: '@babel/code-frame': 7.26.2 - '@babel/runtime': 7.26.0 + '@babel/runtime': 7.26.7 '@types/aria-query': 5.0.4 aria-query: 5.3.0 chalk: 4.1.2 @@ -5828,9 +6080,9 @@ snapshots: lz-string: 1.5.0 pretty-format: 27.5.1 - '@testing-library/react@16.1.0(@testing-library/dom@10.1.0)(@types/react-dom@18.3.5(@types/react@18.3.1))(@types/react@18.3.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': + '@testing-library/react@16.2.0(@testing-library/dom@10.1.0)(@types/react-dom@18.3.5(@types/react@18.3.1))(@types/react@18.3.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)': dependencies: - '@babel/runtime': 7.26.0 + '@babel/runtime': 7.26.7 '@testing-library/dom': 10.1.0 react: 18.3.1 react-dom: 18.3.1(react@18.3.1) @@ -5847,30 +6099,30 @@ snapshots: '@types/babel__core@7.20.5': dependencies: - '@babel/parser': 7.26.3 - '@babel/types': 7.26.3 + '@babel/parser': 7.26.7 + '@babel/types': 7.26.7 '@types/babel__generator': 7.6.8 '@types/babel__template': 7.4.4 '@types/babel__traverse': 7.20.6 '@types/babel__generator@7.6.8': dependencies: - '@babel/types': 7.26.3 + '@babel/types': 7.26.7 '@types/babel__template@7.4.4': dependencies: - '@babel/parser': 7.26.3 - '@babel/types': 7.26.3 + '@babel/parser': 7.26.7 + '@babel/types': 7.26.7 '@types/babel__traverse@7.20.6': dependencies: - '@babel/types': 7.26.3 + '@babel/types': 7.26.7 '@types/cookie@0.6.0': {} '@types/debug@4.1.12': dependencies: - '@types/ms': 0.7.34 + '@types/ms': 2.1.0 '@types/degit@2.8.6': {} @@ -5901,10 +6153,14 @@ snapshots: '@types/minimist@1.2.5': {} - '@types/ms@0.7.34': {} + '@types/ms@2.1.0': {} '@types/node@12.20.55': {} + '@types/node@22.10.10': + dependencies: + undici-types: 6.20.0 + '@types/node@22.10.5': dependencies: undici-types: 6.20.0 @@ -5942,35 +6198,35 @@ snapshots: '@types/web-bluetooth@0.0.20': {} - '@typescript/vfs@1.6.0(typescript@5.7.2)': + '@typescript/vfs@1.6.0(typescript@5.7.3)': dependencies: debug: 4.4.0(supports-color@9.4.0) - typescript: 5.7.2 + typescript: 5.7.3 transitivePeerDependencies: - supports-color - '@ungap/structured-clone@1.2.1': {} + '@ungap/structured-clone@1.3.0': {} - '@vitejs/plugin-react@4.3.4(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1))': + '@vitejs/plugin-react@4.3.4(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1))': dependencies: - '@babel/core': 7.26.0 - '@babel/plugin-transform-react-jsx-self': 7.25.9(@babel/core@7.26.0) - '@babel/plugin-transform-react-jsx-source': 7.25.9(@babel/core@7.26.0) + '@babel/core': 7.26.7 + '@babel/plugin-transform-react-jsx-self': 7.25.9(@babel/core@7.26.7) + '@babel/plugin-transform-react-jsx-source': 7.25.9(@babel/core@7.26.7) '@types/babel__core': 7.20.5 react-refresh: 0.14.2 - vite: 6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1) + vite: 6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1) transitivePeerDependencies: - supports-color - '@vitejs/plugin-vue@5.2.1(vite@5.4.11(@types/node@22.10.5))(vue@3.5.13(typescript@5.7.2))': + '@vitejs/plugin-vue@5.2.1(vite@5.4.14(@types/node@22.10.10))(vue@3.5.13(typescript@5.7.3))': dependencies: - vite: 5.4.11(@types/node@22.10.5) - vue: 3.5.13(typescript@5.7.2) + vite: 5.4.14(@types/node@22.10.10) + vue: 3.5.13(typescript@5.7.3) - '@vitejs/plugin-vue@5.2.1(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1))(vue@3.5.13(typescript@5.7.2))': + '@vitejs/plugin-vue@5.2.1(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1))(vue@3.5.13(typescript@5.7.3))': dependencies: - vite: 6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1) - vue: 3.5.13(typescript@5.7.2) + vite: 6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1) + vue: 3.5.13(typescript@5.7.3) '@vitest/coverage-v8@2.1.8(vitest@2.1.8(@types/node@22.10.5)(jsdom@20.0.3)(msw@2.7.0(@types/node@22.10.5)(typescript@5.7.2)))': dependencies: @@ -5997,14 +6253,23 @@ snapshots: chai: 5.1.2 tinyrainbow: 1.2.0 - '@vitest/mocker@2.1.8(msw@2.7.0(@types/node@22.10.5)(typescript@5.7.2))(vite@5.4.11(@types/node@22.10.5))': + '@vitest/mocker@2.1.8(msw@2.7.0(@types/node@22.10.10)(typescript@5.7.3))(vite@5.4.14(@types/node@22.10.10))': + dependencies: + '@vitest/spy': 2.1.8 + estree-walker: 3.0.3 + magic-string: 0.30.17 + optionalDependencies: + msw: 2.7.0(@types/node@22.10.10)(typescript@5.7.3) + vite: 5.4.14(@types/node@22.10.10) + + '@vitest/mocker@2.1.8(msw@2.7.0(@types/node@22.10.5)(typescript@5.7.2))(vite@5.4.14(@types/node@22.10.10))': dependencies: '@vitest/spy': 2.1.8 estree-walker: 3.0.3 magic-string: 0.30.17 optionalDependencies: msw: 2.7.0(@types/node@22.10.5)(typescript@5.7.2) - vite: 5.4.11(@types/node@22.10.5) + vite: 5.4.14(@types/node@22.10.10) '@vitest/pretty-format@2.1.8': dependencies: @@ -6045,7 +6310,7 @@ snapshots: '@vue/compiler-core@3.5.13': dependencies: - '@babel/parser': 7.26.3 + '@babel/parser': 7.26.7 '@vue/shared': 3.5.13 entities: 4.5.0 estree-walker: 2.0.2 @@ -6058,14 +6323,14 @@ snapshots: '@vue/compiler-sfc@3.5.13': dependencies: - '@babel/parser': 7.26.3 + '@babel/parser': 7.26.7 '@vue/compiler-core': 3.5.13 '@vue/compiler-dom': 3.5.13 '@vue/compiler-ssr': 3.5.13 '@vue/shared': 3.5.13 estree-walker: 2.0.2 magic-string: 0.30.17 - postcss: 8.4.49 + postcss: 8.5.1 source-map-js: 1.2.1 '@vue/compiler-ssr@3.5.13': @@ -6078,13 +6343,13 @@ snapshots: de-indent: 1.0.2 he: 1.2.0 - '@vue/devtools-api@7.6.8': + '@vue/devtools-api@7.7.1': dependencies: - '@vue/devtools-kit': 7.6.8 + '@vue/devtools-kit': 7.7.1 - '@vue/devtools-kit@7.6.8': + '@vue/devtools-kit@7.7.1': dependencies: - '@vue/devtools-shared': 7.6.8 + '@vue/devtools-shared': 7.7.1 birpc: 0.2.19 hookable: 5.5.3 mitt: 3.0.1 @@ -6092,11 +6357,11 @@ snapshots: speakingurl: 14.0.1 superjson: 2.2.2 - '@vue/devtools-shared@7.6.8': + '@vue/devtools-shared@7.7.1': dependencies: rfdc: 1.4.1 - '@vue/language-core@2.1.10(typescript@5.7.2)': + '@vue/language-core@2.1.10(typescript@5.7.3)': dependencies: '@volar/language-core': 2.4.11 '@vue/compiler-dom': 3.5.13 @@ -6107,20 +6372,20 @@ snapshots: muggle-string: 0.4.1 path-browserify: 1.0.1 optionalDependencies: - typescript: 5.7.2 + typescript: 5.7.3 - '@vue/language-core@2.2.0(typescript@5.7.2)': + '@vue/language-core@2.2.0(typescript@5.7.3)': dependencies: '@volar/language-core': 2.4.11 '@vue/compiler-dom': 3.5.13 '@vue/compiler-vue2': 2.7.16 '@vue/shared': 3.5.13 - alien-signals: 0.4.12 + alien-signals: 0.4.14 minimatch: 9.0.5 muggle-string: 0.4.1 path-browserify: 1.0.1 optionalDependencies: - typescript: 5.7.2 + typescript: 5.7.3 '@vue/reactivity@3.5.13': dependencies: @@ -6138,47 +6403,44 @@ snapshots: '@vue/shared': 3.5.13 csstype: 3.1.3 - '@vue/server-renderer@3.5.13(vue@3.5.13(typescript@5.7.2))': + '@vue/server-renderer@3.5.13(vue@3.5.13(typescript@5.7.3))': dependencies: '@vue/compiler-ssr': 3.5.13 '@vue/shared': 3.5.13 - vue: 3.5.13(typescript@5.7.2) + vue: 3.5.13(typescript@5.7.3) '@vue/shared@3.5.13': {} '@vue/tsconfig@0.5.1': {} - '@vueuse/core@11.3.0(vue@3.5.13(typescript@5.7.2))': + '@vueuse/core@12.5.0(typescript@5.7.3)': dependencies: '@types/web-bluetooth': 0.0.20 - '@vueuse/metadata': 11.3.0 - '@vueuse/shared': 11.3.0(vue@3.5.13(typescript@5.7.2)) - vue-demi: 0.14.10(vue@3.5.13(typescript@5.7.2)) + '@vueuse/metadata': 12.5.0 + '@vueuse/shared': 12.5.0(typescript@5.7.3) + vue: 3.5.13(typescript@5.7.3) transitivePeerDependencies: - - '@vue/composition-api' - - vue + - typescript - '@vueuse/integrations@11.3.0(axios@1.7.9)(change-case@5.4.4)(focus-trap@7.6.2)(vue@3.5.13(typescript@5.7.2))': + '@vueuse/integrations@12.5.0(axios@1.7.9)(change-case@5.4.4)(focus-trap@7.6.4)(typescript@5.7.3)': dependencies: - '@vueuse/core': 11.3.0(vue@3.5.13(typescript@5.7.2)) - '@vueuse/shared': 11.3.0(vue@3.5.13(typescript@5.7.2)) - vue-demi: 0.14.10(vue@3.5.13(typescript@5.7.2)) + '@vueuse/core': 12.5.0(typescript@5.7.3) + '@vueuse/shared': 12.5.0(typescript@5.7.3) + vue: 3.5.13(typescript@5.7.3) optionalDependencies: axios: 1.7.9 change-case: 5.4.4 - focus-trap: 7.6.2 + focus-trap: 7.6.4 transitivePeerDependencies: - - '@vue/composition-api' - - vue + - typescript - '@vueuse/metadata@11.3.0': {} + '@vueuse/metadata@12.5.0': {} - '@vueuse/shared@11.3.0(vue@3.5.13(typescript@5.7.2))': + '@vueuse/shared@12.5.0(typescript@5.7.3)': dependencies: - vue-demi: 0.14.10(vue@3.5.13(typescript@5.7.2)) + vue: 3.5.13(typescript@5.7.3) transitivePeerDependencies: - - '@vue/composition-api' - - vue + - typescript abab@2.0.6: optional: true @@ -6219,25 +6481,25 @@ snapshots: clean-stack: 4.2.0 indent-string: 5.0.0 - algoliasearch@5.18.0: - dependencies: - '@algolia/client-abtesting': 5.18.0 - '@algolia/client-analytics': 5.18.0 - '@algolia/client-common': 5.18.0 - '@algolia/client-insights': 5.18.0 - '@algolia/client-personalization': 5.18.0 - '@algolia/client-query-suggestions': 5.18.0 - '@algolia/client-search': 5.18.0 - '@algolia/ingestion': 1.18.0 - '@algolia/monitoring': 1.18.0 - '@algolia/recommend': 5.18.0 - '@algolia/requester-browser-xhr': 5.18.0 - '@algolia/requester-fetch': 5.18.0 - '@algolia/requester-node-http': 5.18.0 + algoliasearch@5.20.0: + dependencies: + '@algolia/client-abtesting': 5.20.0 + '@algolia/client-analytics': 5.20.0 + '@algolia/client-common': 5.20.0 + '@algolia/client-insights': 5.20.0 + '@algolia/client-personalization': 5.20.0 + '@algolia/client-query-suggestions': 5.20.0 + '@algolia/client-search': 5.20.0 + '@algolia/ingestion': 1.20.0 + '@algolia/monitoring': 1.20.0 + '@algolia/recommend': 5.20.0 + '@algolia/requester-browser-xhr': 5.20.0 + '@algolia/requester-fetch': 5.20.0 + '@algolia/requester-node-http': 5.20.0 alien-signals@0.2.2: {} - alien-signals@0.4.12: {} + alien-signals@0.4.14: {} ansi-colors@4.1.3: {} @@ -6342,12 +6604,12 @@ snapshots: dependencies: fill-range: 7.1.1 - browserslist@4.24.3: + browserslist@4.24.4: dependencies: - caniuse-lite: 1.0.30001690 - electron-to-chromium: 1.5.76 + caniuse-lite: 1.0.30001695 + electron-to-chromium: 1.5.88 node-releases: 2.0.19 - update-browserslist-db: 1.1.1(browserslist@4.24.3) + update-browserslist-db: 1.1.2(browserslist@4.24.4) buffer-crc32@1.0.0: {} @@ -6387,7 +6649,7 @@ snapshots: camelcase@6.3.0: {} - caniuse-lite@1.0.30001690: {} + caniuse-lite@1.0.30001695: {} ccount@2.0.1: {} @@ -6436,7 +6698,7 @@ snapshots: chokidar@4.0.3: dependencies: - readdirp: 4.0.2 + readdirp: 4.1.1 ci-info@3.9.0: {} @@ -6611,7 +6873,7 @@ snapshots: decamelize@5.0.1: {} - decimal.js@10.4.3: + decimal.js@10.5.0: optional: true decode-named-character-reference@1.0.2: @@ -6687,7 +6949,7 @@ snapshots: ee-first@1.1.1: {} - electron-to-chromium@1.5.76: {} + electron-to-chromium@1.5.88: {} emoji-regex-xs@1.0.0: {} @@ -6722,7 +6984,7 @@ snapshots: es-module-lexer@1.6.0: {} - es-object-atoms@1.0.0: + es-object-atoms@1.1.1: dependencies: es-errors: 1.3.0 @@ -6797,11 +7059,11 @@ snapshots: source-map: 0.6.1 optional: true - esm-env@1.2.1: {} + esm-env@1.2.2: {} esprima@4.0.1: {} - esrap@1.3.2: + esrap@1.4.3: dependencies: '@jridgewell/sourcemap-codec': 1.5.0 @@ -6889,13 +7151,21 @@ snapshots: merge2: 1.4.1 micromatch: 4.0.8 + fast-glob@3.3.3: + dependencies: + '@nodelib/fs.stat': 2.0.5 + '@nodelib/fs.walk': 1.2.8 + glob-parent: 5.1.2 + merge2: 1.4.1 + micromatch: 4.0.8 + fast-safe-stringify@2.1.1: {} fastq@1.17.1: dependencies: reusify: 1.0.4 - fdir@6.4.2(picomatch@4.0.2): + fdir@6.4.3(picomatch@4.0.2): optionalDependencies: picomatch: 4.0.2 @@ -6933,13 +7203,13 @@ snapshots: locate-path: 6.0.0 path-exists: 4.0.0 - floating-vue@5.2.2(vue@3.5.13(typescript@5.7.2)): + floating-vue@5.2.2(vue@3.5.13(typescript@5.7.3)): dependencies: '@floating-ui/dom': 1.1.1 - vue: 3.5.13(typescript@5.7.2) - vue-resize: 2.0.0-alpha.1(vue@3.5.13(typescript@5.7.2)) + vue: 3.5.13(typescript@5.7.3) + vue-resize: 2.0.0-alpha.1(vue@3.5.13(typescript@5.7.3)) - focus-trap@7.6.2: + focus-trap@7.6.4: dependencies: tabbable: 6.2.0 @@ -6966,7 +7236,7 @@ snapshots: fresh@0.5.2: {} - fs-extra@11.2.0: + fs-extra@11.3.0: dependencies: graceful-fs: 4.2.11 jsonfile: 6.1.0 @@ -7005,7 +7275,7 @@ snapshots: call-bind-apply-helpers: 1.0.1 es-define-property: 1.0.1 es-errors: 1.3.0 - es-object-atoms: 1.0.0 + es-object-atoms: 1.1.1 function-bind: 1.1.2 get-proto: 1.0.1 gopd: 1.2.0 @@ -7016,7 +7286,7 @@ snapshots: get-proto@1.0.1: dependencies: dunder-proto: 1.0.1 - es-object-atoms: 1.0.0 + es-object-atoms: 1.1.1 get-stream@8.0.1: {} @@ -7044,13 +7314,11 @@ snapshots: globals@11.12.0: {} - globalyzer@0.1.0: {} - globby@11.1.0: dependencies: array-union: 2.1.0 dir-glob: 3.0.1 - fast-glob: 3.3.2 + fast-glob: 3.3.3 ignore: 5.3.2 merge2: 1.4.1 slash: 3.0.0 @@ -7063,8 +7331,6 @@ snapshots: merge2: 1.4.1 slash: 4.0.0 - globrex@0.1.2: {} - gopd@1.2.0: {} graceful-fs@4.2.11: {} @@ -7303,7 +7569,7 @@ snapshots: cssom: 0.5.0 cssstyle: 2.3.0 data-urls: 3.0.2 - decimal.js: 10.4.3 + decimal.js: 10.5.0 domexception: 4.0.0 escodegen: 2.1.0 form-data: 4.0.1 @@ -7556,7 +7822,7 @@ snapshots: dependencies: '@types/hast': 3.0.4 '@types/mdast': 4.0.4 - '@ungap/structured-clone': 1.2.1 + '@ungap/structured-clone': 1.3.0 devlop: 1.1.0 micromark-util-sanitize-uri: 2.0.1 trim-lines: 3.0.1 @@ -7620,7 +7886,7 @@ snapshots: micromark-util-html-tag-name: 2.0.1 micromark-util-normalize-identifier: 2.0.1 micromark-util-resolve-all: 2.0.1 - micromark-util-subtokenize: 2.0.3 + micromark-util-subtokenize: 2.0.4 micromark-util-symbol: 2.0.1 micromark-util-types: 2.0.1 @@ -7705,7 +7971,7 @@ snapshots: micromark-util-encode: 2.0.1 micromark-util-symbol: 2.0.1 - micromark-util-subtokenize@2.0.3: + micromark-util-subtokenize@2.0.4: dependencies: devlop: 1.1.0 micromark-util-chunked: 2.0.1 @@ -7732,7 +7998,7 @@ snapshots: micromark-util-normalize-identifier: 2.0.1 micromark-util-resolve-all: 2.0.1 micromark-util-sanitize-uri: 2.0.1 - micromark-util-subtokenize: 2.0.3 + micromark-util-subtokenize: 2.0.4 micromark-util-symbol: 2.0.1 micromark-util-types: 2.0.1 transitivePeerDependencies: @@ -7797,13 +8063,38 @@ snapshots: ms@2.1.3: {} + msw@2.7.0(@types/node@22.10.10)(typescript@5.7.3): + dependencies: + '@bundled-es-modules/cookie': 2.0.1 + '@bundled-es-modules/statuses': 1.0.1 + '@bundled-es-modules/tough-cookie': 0.1.6 + '@inquirer/confirm': 5.1.3(@types/node@22.10.10) + '@mswjs/interceptors': 0.37.5 + '@open-draft/deferred-promise': 2.2.0 + '@open-draft/until': 2.1.0 + '@types/cookie': 0.6.0 + '@types/statuses': 2.0.5 + graphql: 16.10.0 + headers-polyfill: 4.0.3 + is-node-process: 1.2.0 + outvariant: 1.4.3 + path-to-regexp: 6.3.0 + picocolors: 1.1.1 + strict-event-emitter: 0.5.1 + type-fest: 4.33.0 + yargs: 17.7.2 + optionalDependencies: + typescript: 5.7.3 + transitivePeerDependencies: + - '@types/node' + msw@2.7.0(@types/node@22.10.5)(typescript@5.7.2): dependencies: '@bundled-es-modules/cookie': 2.0.1 '@bundled-es-modules/statuses': 1.0.1 '@bundled-es-modules/tough-cookie': 0.1.6 - '@inquirer/confirm': 5.1.1(@types/node@22.10.5) - '@mswjs/interceptors': 0.37.4 + '@inquirer/confirm': 5.1.3(@types/node@22.10.5) + '@mswjs/interceptors': 0.37.5 '@open-draft/deferred-promise': 2.2.0 '@open-draft/until': 2.1.0 '@types/cookie': 0.6.0 @@ -7815,12 +8106,13 @@ snapshots: path-to-regexp: 6.3.0 picocolors: 1.1.1 strict-event-emitter: 0.5.1 - type-fest: 4.31.0 + type-fest: 4.33.0 yargs: 17.7.2 optionalDependencies: typescript: 5.7.2 transitivePeerDependencies: - '@types/node' + optional: true muggle-string@0.4.1: {} @@ -7844,13 +8136,13 @@ snapshots: neo-async@2.6.2: {} - next@15.1.2(@playwright/test@1.49.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1): + next@15.1.2(@playwright/test@1.50.0)(react-dom@18.3.1(react@18.3.1))(react@18.3.1): dependencies: '@next/env': 15.1.2 '@swc/counter': 0.1.3 '@swc/helpers': 0.5.15 busboy: 1.6.0 - caniuse-lite: 1.0.30001690 + caniuse-lite: 1.0.30001695 postcss: 8.4.31 react: 18.3.1 react-dom: 18.3.1(react@18.3.1) @@ -7864,7 +8156,7 @@ snapshots: '@next/swc-linux-x64-musl': 15.1.2 '@next/swc-win32-arm64-msvc': 15.1.2 '@next/swc-win32-x64-msvc': 15.1.2 - '@playwright/test': 1.49.1 + '@playwright/test': 1.50.0 sharp: 0.33.5 transitivePeerDependencies: - '@babel/core' @@ -7921,7 +8213,7 @@ snapshots: dependencies: mimic-function: 5.0.1 - oniguruma-to-es@0.10.0: + oniguruma-to-es@2.3.0: dependencies: emoji-regex-xs: 1.0.0 regex: 5.1.1 @@ -7933,11 +8225,11 @@ snapshots: dependencies: camelcase: 6.3.0 commander: 11.1.0 - fs-extra: 11.2.0 + fs-extra: 11.3.0 handlebars: 4.7.8 json-schema-ref-parser: 9.0.9 - openapi-typescript-fetch@2.0.0: {} + openapi-typescript-fetch@2.1.0: {} os-tmpdir@1.0.2: {} @@ -7988,7 +8280,7 @@ snapshots: dependencies: '@babel/code-frame': 7.26.2 index-to-position: 0.1.2 - type-fest: 4.31.0 + type-fest: 4.33.0 parse5-htmlparser2-tree-adapter@6.0.1: dependencies: @@ -8044,22 +8336,22 @@ snapshots: pirates@4.0.6: {} - playwright-core@1.49.1: {} + playwright-core@1.50.0: {} - playwright@1.49.1: + playwright@1.50.0: dependencies: - playwright-core: 1.49.1 + playwright-core: 1.50.0 optionalDependencies: fsevents: 2.3.2 pluralize@8.0.0: {} - postcss-load-config@6.0.1(jiti@2.4.2)(postcss@8.4.49)(yaml@2.5.1): + postcss-load-config@6.0.1(jiti@2.4.2)(postcss@8.5.1)(yaml@2.5.1): dependencies: lilconfig: 3.1.3 optionalDependencies: jiti: 2.4.2 - postcss: 8.4.49 + postcss: 8.5.1 yaml: 2.5.1 postcss@8.4.31: @@ -8068,7 +8360,7 @@ snapshots: picocolors: 1.1.1 source-map-js: 1.2.1 - postcss@8.4.49: + postcss@8.5.1: dependencies: nanoid: 3.3.8 picocolors: 1.1.1 @@ -8105,7 +8397,7 @@ snapshots: dependencies: side-channel: 1.1.0 - qs@6.13.1: + qs@6.14.0: dependencies: side-channel: 1.1.0 @@ -8132,7 +8424,7 @@ snapshots: react-error-boundary@4.1.2(react@18.3.1): dependencies: - '@babel/runtime': 7.26.0 + '@babel/runtime': 7.26.7 react: 18.3.1 react-is@17.0.2: {} @@ -8167,7 +8459,7 @@ snapshots: dependencies: picomatch: 2.3.1 - readdirp@4.0.2: {} + readdirp@4.1.1: {} redent@4.0.0: dependencies: @@ -8239,6 +8531,31 @@ snapshots: '@rollup/rollup-win32-x64-msvc': 4.29.1 fsevents: 2.3.3 + rollup@4.32.0: + dependencies: + '@types/estree': 1.0.6 + optionalDependencies: + '@rollup/rollup-android-arm-eabi': 4.32.0 + '@rollup/rollup-android-arm64': 4.32.0 + '@rollup/rollup-darwin-arm64': 4.32.0 + '@rollup/rollup-darwin-x64': 4.32.0 + '@rollup/rollup-freebsd-arm64': 4.32.0 + '@rollup/rollup-freebsd-x64': 4.32.0 + '@rollup/rollup-linux-arm-gnueabihf': 4.32.0 + '@rollup/rollup-linux-arm-musleabihf': 4.32.0 + '@rollup/rollup-linux-arm64-gnu': 4.32.0 + '@rollup/rollup-linux-arm64-musl': 4.32.0 + '@rollup/rollup-linux-loongarch64-gnu': 4.32.0 + '@rollup/rollup-linux-powerpc64le-gnu': 4.32.0 + '@rollup/rollup-linux-riscv64-gnu': 4.32.0 + '@rollup/rollup-linux-s390x-gnu': 4.32.0 + '@rollup/rollup-linux-x64-gnu': 4.32.0 + '@rollup/rollup-linux-x64-musl': 4.32.0 + '@rollup/rollup-win32-arm64-msvc': 4.32.0 + '@rollup/rollup-win32-ia32-msvc': 4.32.0 + '@rollup/rollup-win32-x64-msvc': 4.32.0 + fsevents: 2.3.3 + run-parallel@1.2.0: dependencies: queue-microtask: 1.2.3 @@ -8337,14 +8654,25 @@ snapshots: shebang-regex@3.0.0: {} - shiki@1.26.1: + shiki@1.29.1: dependencies: - '@shikijs/core': 1.26.1 - '@shikijs/engine-javascript': 1.26.1 - '@shikijs/engine-oniguruma': 1.26.1 - '@shikijs/langs': 1.26.1 - '@shikijs/themes': 1.26.1 - '@shikijs/types': 1.26.1 + '@shikijs/core': 1.29.1 + '@shikijs/engine-javascript': 1.29.1 + '@shikijs/engine-oniguruma': 1.29.1 + '@shikijs/langs': 1.29.1 + '@shikijs/themes': 1.29.1 + '@shikijs/types': 1.29.1 + '@shikijs/vscode-textmate': 10.0.1 + '@types/hast': 3.0.4 + + shiki@2.1.0: + dependencies: + '@shikijs/core': 2.1.0 + '@shikijs/engine-javascript': 2.1.0 + '@shikijs/engine-oniguruma': 2.1.0 + '@shikijs/langs': 2.1.0 + '@shikijs/themes': 2.1.0 + '@shikijs/types': 2.1.0 '@shikijs/vscode-textmate': 10.0.1 '@types/hast': 3.0.4 @@ -8539,7 +8867,7 @@ snapshots: formidable: 3.5.2 methods: 1.1.2 mime: 2.6.0 - qs: 6.13.1 + qs: 6.14.0 transitivePeerDependencies: - supports-color @@ -8558,15 +8886,15 @@ snapshots: has-flag: 4.0.0 supports-color: 7.2.0 - svelte-check@3.8.6(@babel/core@7.26.0)(postcss@8.4.49)(svelte@5.16.1): + svelte-check@3.8.6(@babel/core@7.26.7)(postcss@8.5.1)(svelte@5.19.3): dependencies: '@jridgewell/trace-mapping': 0.3.25 chokidar: 3.6.0 picocolors: 1.1.1 sade: 1.8.1 - svelte: 5.16.1 - svelte-preprocess: 5.1.4(@babel/core@7.26.0)(postcss@8.4.49)(svelte@5.16.1)(typescript@5.7.2) - typescript: 5.7.2 + svelte: 5.19.3 + svelte-preprocess: 5.1.4(@babel/core@7.26.7)(postcss@8.5.1)(svelte@5.19.3)(typescript@5.7.3) + typescript: 5.7.3 transitivePeerDependencies: - '@babel/core' - coffeescript @@ -8578,20 +8906,20 @@ snapshots: - stylus - sugarss - svelte-preprocess@5.1.4(@babel/core@7.26.0)(postcss@8.4.49)(svelte@5.16.1)(typescript@5.7.2): + svelte-preprocess@5.1.4(@babel/core@7.26.7)(postcss@8.5.1)(svelte@5.19.3)(typescript@5.7.3): dependencies: '@types/pug': 2.0.10 detect-indent: 6.1.0 magic-string: 0.30.17 sorcery: 0.11.1 strip-indent: 3.0.0 - svelte: 5.16.1 + svelte: 5.19.3 optionalDependencies: - '@babel/core': 7.26.0 - postcss: 8.4.49 - typescript: 5.7.2 + '@babel/core': 7.26.7 + postcss: 8.5.1 + typescript: 5.7.3 - svelte@5.16.1: + svelte@5.19.3: dependencies: '@ampproject/remapping': 2.3.0 '@jridgewell/sourcemap-codec': 1.5.0 @@ -8601,8 +8929,8 @@ snapshots: aria-query: 5.3.2 axobject-query: 4.1.0 clsx: 2.1.1 - esm-env: 1.2.1 - esrap: 1.3.2 + esm-env: 1.2.2 + esrap: 1.4.3 is-reference: 3.0.3 locate-character: 3.0.0 magic-string: 0.30.17 @@ -8635,18 +8963,13 @@ snapshots: dependencies: any-promise: 1.3.0 - tiny-glob@0.2.9: - dependencies: - globalyzer: 0.1.0 - globrex: 0.1.2 - tinybench@2.9.0: {} tinyexec@0.3.2: {} tinyglobby@0.2.10: dependencies: - fdir: 6.4.2(picomatch@4.0.2) + fdir: 6.4.3(picomatch@4.0.2) picomatch: 4.0.2 tinypool@1.0.2: {} @@ -8697,7 +9020,7 @@ snapshots: tslib@2.8.1: {} - tsup@8.3.5(@swc/core@1.10.4(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.4.49)(typescript@5.7.2)(yaml@2.5.1): + tsup@8.3.5(@swc/core@1.10.4(@swc/helpers@0.5.15))(jiti@2.4.2)(postcss@8.5.1)(typescript@5.7.2)(yaml@2.5.1): dependencies: bundle-require: 5.1.0(esbuild@0.24.2) cac: 6.7.14 @@ -8707,7 +9030,7 @@ snapshots: esbuild: 0.24.2 joycon: 3.1.1 picocolors: 1.1.1 - postcss-load-config: 6.0.1(jiti@2.4.2)(postcss@8.4.49)(yaml@2.5.1) + postcss-load-config: 6.0.1(jiti@2.4.2)(postcss@8.5.1)(yaml@2.5.1) resolve-from: 5.0.0 rollup: 4.29.1 source-map: 0.8.0-beta.0 @@ -8717,7 +9040,7 @@ snapshots: tree-kill: 1.2.2 optionalDependencies: '@swc/core': 1.10.4(@swc/helpers@0.5.15) - postcss: 8.4.49 + postcss: 8.5.1 typescript: 5.7.2 transitivePeerDependencies: - jiti @@ -8725,49 +9048,49 @@ snapshots: - tsx - yaml - turbo-darwin-64@2.3.3: + turbo-darwin-64@2.3.4: optional: true - turbo-darwin-arm64@2.3.3: + turbo-darwin-arm64@2.3.4: optional: true - turbo-linux-64@2.3.3: + turbo-linux-64@2.3.4: optional: true - turbo-linux-arm64@2.3.3: + turbo-linux-arm64@2.3.4: optional: true - turbo-windows-64@2.3.3: + turbo-windows-64@2.3.4: optional: true - turbo-windows-arm64@2.3.3: + turbo-windows-arm64@2.3.4: optional: true - turbo@2.3.3: + turbo@2.3.4: optionalDependencies: - turbo-darwin-64: 2.3.3 - turbo-darwin-arm64: 2.3.3 - turbo-linux-64: 2.3.3 - turbo-linux-arm64: 2.3.3 - turbo-windows-64: 2.3.3 - turbo-windows-arm64: 2.3.3 + turbo-darwin-64: 2.3.4 + turbo-darwin-arm64: 2.3.4 + turbo-linux-64: 2.3.4 + turbo-linux-arm64: 2.3.4 + turbo-windows-64: 2.3.4 + turbo-windows-arm64: 2.3.4 twoslash-protocol@0.2.12: {} - twoslash-vue@0.2.12(typescript@5.7.2): + twoslash-vue@0.2.12(typescript@5.7.3): dependencies: - '@vue/language-core': 2.1.10(typescript@5.7.2) - twoslash: 0.2.12(typescript@5.7.2) + '@vue/language-core': 2.1.10(typescript@5.7.3) + twoslash: 0.2.12(typescript@5.7.3) twoslash-protocol: 0.2.12 - typescript: 5.7.2 + typescript: 5.7.3 transitivePeerDependencies: - supports-color - twoslash@0.2.12(typescript@5.7.2): + twoslash@0.2.12(typescript@5.7.3): dependencies: - '@typescript/vfs': 1.6.0(typescript@5.7.2) + '@typescript/vfs': 1.6.0(typescript@5.7.3) twoslash-protocol: 0.2.12 - typescript: 5.7.2 + typescript: 5.7.3 transitivePeerDependencies: - supports-color @@ -8777,6 +9100,8 @@ snapshots: type-fest@4.31.0: {} + type-fest@4.33.0: {} + type-is@1.6.18: dependencies: media-typer: 0.3.0 @@ -8786,6 +9111,8 @@ snapshots: typescript@5.7.2: {} + typescript@5.7.3: {} + uglify-js@3.19.3: optional: true @@ -8826,9 +9153,9 @@ snapshots: unpipe@1.0.0: {} - unplugin-swc@1.5.1(@swc/core@1.10.4(@swc/helpers@0.5.15))(rollup@4.29.1): + unplugin-swc@1.5.1(@swc/core@1.10.4(@swc/helpers@0.5.15))(rollup@4.32.0): dependencies: - '@rollup/pluginutils': 5.1.4(rollup@4.29.1) + '@rollup/pluginutils': 5.1.4(rollup@4.32.0) '@swc/core': 1.10.4(@swc/helpers@0.5.15) load-tsconfig: 0.2.5 unplugin: 1.16.0 @@ -8840,9 +9167,9 @@ snapshots: acorn: 8.14.0 webpack-virtual-modules: 0.6.2 - update-browserslist-db@1.1.1(browserslist@4.24.3): + update-browserslist-db@1.1.2(browserslist@4.24.4): dependencies: - browserslist: 4.24.3 + browserslist: 4.24.4 escalade: 3.2.0 picocolors: 1.1.1 @@ -8878,13 +9205,49 @@ snapshots: '@types/unist': 3.0.3 vfile-message: 4.0.2 - vite-node@2.1.8(@types/node@22.10.5)(supports-color@9.4.0): + vite-node@2.1.8(@types/node@22.10.10): + dependencies: + cac: 6.7.14 + debug: 4.4.0(supports-color@9.4.0) + es-module-lexer: 1.6.0 + pathe: 1.1.2 + vite: 5.4.14(@types/node@22.10.10) + transitivePeerDependencies: + - '@types/node' + - less + - lightningcss + - sass + - sass-embedded + - stylus + - sugarss + - supports-color + - terser + + vite-node@2.1.8(@types/node@22.10.10)(supports-color@9.4.0): + dependencies: + cac: 6.7.14 + debug: 4.4.0(supports-color@9.4.0) + es-module-lexer: 1.6.0 + pathe: 1.1.2 + vite: 5.4.14(@types/node@22.10.10) + transitivePeerDependencies: + - '@types/node' + - less + - lightningcss + - sass + - sass-embedded + - stylus + - sugarss + - supports-color + - terser + + vite-node@2.1.8(@types/node@22.10.5): dependencies: cac: 6.7.14 debug: 4.4.0(supports-color@9.4.0) es-module-lexer: 1.6.0 pathe: 1.1.2 - vite: 5.4.11(@types/node@22.10.5) + vite: 5.4.14(@types/node@22.10.5) transitivePeerDependencies: - '@types/node' - less @@ -8896,57 +9259,65 @@ snapshots: - supports-color - terser - vite@5.4.11(@types/node@22.10.5): + vite@5.4.14(@types/node@22.10.10): dependencies: esbuild: 0.21.5 - postcss: 8.4.49 - rollup: 4.29.1 + postcss: 8.5.1 + rollup: 4.32.0 + optionalDependencies: + '@types/node': 22.10.10 + fsevents: 2.3.3 + + vite@5.4.14(@types/node@22.10.5): + dependencies: + esbuild: 0.21.5 + postcss: 8.5.1 + rollup: 4.32.0 optionalDependencies: '@types/node': 22.10.5 fsevents: 2.3.3 - vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1): + vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1): dependencies: esbuild: 0.24.2 - postcss: 8.4.49 - rollup: 4.29.1 + postcss: 8.5.1 + rollup: 4.32.0 optionalDependencies: - '@types/node': 22.10.5 + '@types/node': 22.10.10 fsevents: 2.3.3 jiti: 2.4.2 yaml: 2.5.1 - vitefu@1.0.5(vite@6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1)): + vitefu@1.0.5(vite@6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1)): optionalDependencies: - vite: 6.0.7(@types/node@22.10.5)(jiti@2.4.2)(yaml@2.5.1) + vite: 6.0.11(@types/node@22.10.10)(jiti@2.4.2)(yaml@2.5.1) - vitepress@1.5.0(@algolia/client-search@5.18.0)(@types/node@22.10.5)(@types/react@18.3.18)(axios@1.7.9)(change-case@5.4.4)(postcss@8.4.49)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)(typescript@5.7.2): + vitepress@1.6.3(@algolia/client-search@5.20.0)(@types/node@22.10.10)(@types/react@18.3.18)(axios@1.7.9)(change-case@5.4.4)(postcss@8.5.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)(typescript@5.7.3): dependencies: '@docsearch/css': 3.8.2 - '@docsearch/js': 3.8.2(@algolia/client-search@5.18.0)(@types/react@18.3.18)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0) - '@iconify-json/simple-icons': 1.2.18 - '@shikijs/core': 1.26.1 - '@shikijs/transformers': 1.26.1 - '@shikijs/types': 1.26.1 + '@docsearch/js': 3.8.2(@algolia/client-search@5.20.0)(@types/react@18.3.18)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0) + '@iconify-json/simple-icons': 1.2.21 + '@shikijs/core': 2.1.0 + '@shikijs/transformers': 2.1.0 + '@shikijs/types': 2.1.0 '@types/markdown-it': 14.1.2 - '@vitejs/plugin-vue': 5.2.1(vite@5.4.11(@types/node@22.10.5))(vue@3.5.13(typescript@5.7.2)) - '@vue/devtools-api': 7.6.8 + '@vitejs/plugin-vue': 5.2.1(vite@5.4.14(@types/node@22.10.10))(vue@3.5.13(typescript@5.7.3)) + '@vue/devtools-api': 7.7.1 '@vue/shared': 3.5.13 - '@vueuse/core': 11.3.0(vue@3.5.13(typescript@5.7.2)) - '@vueuse/integrations': 11.3.0(axios@1.7.9)(change-case@5.4.4)(focus-trap@7.6.2)(vue@3.5.13(typescript@5.7.2)) - focus-trap: 7.6.2 + '@vueuse/core': 12.5.0(typescript@5.7.3) + '@vueuse/integrations': 12.5.0(axios@1.7.9)(change-case@5.4.4)(focus-trap@7.6.4)(typescript@5.7.3) + focus-trap: 7.6.4 mark.js: 8.11.1 minisearch: 7.1.1 - shiki: 1.26.1 - vite: 5.4.11(@types/node@22.10.5) - vue: 3.5.13(typescript@5.7.2) + shiki: 2.1.0 + vite: 5.4.14(@types/node@22.10.10) + vue: 3.5.13(typescript@5.7.3) optionalDependencies: - postcss: 8.4.49 + postcss: 8.5.1 transitivePeerDependencies: - '@algolia/client-search' - '@types/node' - '@types/react' - - '@vue/composition-api' - async-validator - axios - change-case @@ -8970,10 +9341,46 @@ snapshots: - typescript - universal-cookie + vitest@2.1.8(@types/node@22.10.10)(jsdom@20.0.3)(msw@2.7.0(@types/node@22.10.10)(typescript@5.7.3)): + dependencies: + '@vitest/expect': 2.1.8 + '@vitest/mocker': 2.1.8(msw@2.7.0(@types/node@22.10.10)(typescript@5.7.3))(vite@5.4.14(@types/node@22.10.10)) + '@vitest/pretty-format': 2.1.8 + '@vitest/runner': 2.1.8 + '@vitest/snapshot': 2.1.8 + '@vitest/spy': 2.1.8 + '@vitest/utils': 2.1.8 + chai: 5.1.2 + debug: 4.4.0(supports-color@9.4.0) + expect-type: 1.1.0 + magic-string: 0.30.17 + pathe: 1.1.2 + std-env: 3.8.0 + tinybench: 2.9.0 + tinyexec: 0.3.2 + tinypool: 1.0.2 + tinyrainbow: 1.2.0 + vite: 5.4.14(@types/node@22.10.10) + vite-node: 2.1.8(@types/node@22.10.10) + why-is-node-running: 2.3.0 + optionalDependencies: + '@types/node': 22.10.10 + jsdom: 20.0.3 + transitivePeerDependencies: + - less + - lightningcss + - msw + - sass + - sass-embedded + - stylus + - sugarss + - supports-color + - terser + vitest@2.1.8(@types/node@22.10.5)(jsdom@20.0.3)(msw@2.7.0(@types/node@22.10.5)(typescript@5.7.2)): dependencies: '@vitest/expect': 2.1.8 - '@vitest/mocker': 2.1.8(msw@2.7.0(@types/node@22.10.5)(typescript@5.7.2))(vite@5.4.11(@types/node@22.10.5)) + '@vitest/mocker': 2.1.8(msw@2.7.0(@types/node@22.10.5)(typescript@5.7.2))(vite@5.4.14(@types/node@22.10.10)) '@vitest/pretty-format': 2.1.8 '@vitest/runner': 2.1.8 '@vitest/snapshot': 2.1.8 @@ -8989,8 +9396,8 @@ snapshots: tinyexec: 0.3.2 tinypool: 1.0.2 tinyrainbow: 1.2.0 - vite: 5.4.11(@types/node@22.10.5) - vite-node: 2.1.8(@types/node@22.10.5)(supports-color@9.4.0) + vite: 5.4.14(@types/node@22.10.5) + vite-node: 2.1.8(@types/node@22.10.5) why-is-node-running: 2.3.0 optionalDependencies: '@types/node': 22.10.5 @@ -9008,29 +9415,25 @@ snapshots: vscode-uri@3.0.8: {} - vue-demi@0.14.10(vue@3.5.13(typescript@5.7.2)): - dependencies: - vue: 3.5.13(typescript@5.7.2) - - vue-resize@2.0.0-alpha.1(vue@3.5.13(typescript@5.7.2)): + vue-resize@2.0.0-alpha.1(vue@3.5.13(typescript@5.7.3)): dependencies: - vue: 3.5.13(typescript@5.7.2) + vue: 3.5.13(typescript@5.7.3) - vue-tsc@2.2.0(typescript@5.7.2): + vue-tsc@2.2.0(typescript@5.7.3): dependencies: '@volar/typescript': 2.4.11 - '@vue/language-core': 2.2.0(typescript@5.7.2) - typescript: 5.7.2 + '@vue/language-core': 2.2.0(typescript@5.7.3) + typescript: 5.7.3 - vue@3.5.13(typescript@5.7.2): + vue@3.5.13(typescript@5.7.3): dependencies: '@vue/compiler-dom': 3.5.13 '@vue/compiler-sfc': 3.5.13 '@vue/runtime-dom': 3.5.13 - '@vue/server-renderer': 3.5.13(vue@3.5.13(typescript@5.7.2)) + '@vue/server-renderer': 3.5.13(vue@3.5.13(typescript@5.7.3)) '@vue/shared': 3.5.13 optionalDependencies: - typescript: 5.7.2 + typescript: 5.7.3 w3c-xmlserializer@4.0.0: dependencies: